6 files changed, 494 insertions, 0 deletions
diff --git a/silx/gui/utils/__init__.py b/silx/gui/utils/__init__.py
new file mode 100644
index 0000000..51c4fac
--- /dev/null
+++ b/silx/gui/utils/__init__.py
@@ -0,0 +1,29 @@
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""Miscellaneous helpers for Qt"""
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "09/03/2018"
diff --git a/silx/gui/utils/_image.py b/silx/gui/utils/_image.py
new file mode 100644
index 0000000..260aac3
--- /dev/null
+++ b/silx/gui/utils/_image.py
@@ -0,0 +1,104 @@
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2017-2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""This module provides convenient functions to use with Qt objects.
+
+It provides:
+- conversion between numpy and QImage:
+  :func:`convertArrayToQImage`, :func:`convertQImageToArray`
+"""
+
+from __future__ import division
+
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "16/01/2017"
+
+
+import sys
+import numpy
+
+from .. import qt
+
+
+def convertArrayToQImage(image):
+    """Convert an array-like RGB888 image to a QImage.
+
+    The created QImage is using a copy of the array data.
+
+    Limitation: Only supports RGB888 format.
+
+    :param image: Array-like image data
+    :type image: numpy.ndarray of uint8 of dimension HxWx3
+    :return: Corresponding Qt image
+    :rtype: QImage
+    """
+    # Possible extension: add a format argument to support more formats
+
+    image = numpy.array(image, copy=False, order='C', dtype=numpy.uint8)
+
+    height, width, depth = image.shape
+    assert depth == 3
+
+    qimage = qt.QImage(
+        image.data,
+        width,
+        height,
+        image.strides[0],  # bytesPerLine
+        qt.QImage.Format_RGB888)
+
+    return qimage.copy()  # Making a copy of the image and its data
+
+
+def convertQImageToArray(image):
+    """Convert a RGB888 QImage to a numpy array.
+
+    Limitation: Only supports RGB888 format.
+    If QImage is not RGB888 it gets converted to this format.
+
+    :param QImage: The QImage to convert.
+    :return: The image array
+    :rtype: numpy.ndarray of uint8 of shape HxWx3
+    """
+    # Possible extension: avoid conversion to support more formats
+
+    if image.format() != qt.QImage.Format_RGB888:
+        # Convert to RGB888 if needed
+        image = image.convertToFormat(qt.QImage.Format_RGB888)
+
+    ptr = image.bits()
+    if qt.BINDING not in ('PySide', 'PySide2'):
+        ptr.setsize(image.byteCount())
+        if qt.BINDING == 'PyQt4' and sys.version_info[0] == 2:
+            ptr = ptr.asstring()
+    elif sys.version_info[0] == 3:  # PySide with Python3
+        ptr = ptr.tobytes()
+
+    array = numpy.fromstring(ptr, dtype=numpy.uint8)
+
+    # Lines are 32 bits aligned: remove padding bytes
+    array = array.reshape(image.height(), -1)[:, :image.width() * 3]
+    array.shape = image.height(), image.width(), 3
+    return array
diff --git a/silx/gui/utils/concurrent.py b/silx/gui/utils/concurrent.py
new file mode 100644
index 0000000..48fff91
--- /dev/null
+++ b/silx/gui/utils/concurrent.py
@@ -0,0 +1,103 @@
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""This module allows to run a function in Qt main thread from another thread
+"""
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "09/03/2018"
+
+
+from silx.third_party.concurrent_futures import Future
+
+from .. import qt
+
+
+class _QtExecutor(qt.QObject):
+    """Executor of tasks in Qt main thread"""
+
+    __sigSubmit = qt.Signal(Future, object, tuple, dict)
+    """Signal used to run tasks."""
+
+    def __init__(self):
+        super(_QtExecutor, self).__init__(parent=None)
+
+        # Makes sure the executor lives in the main thread
+        app = qt.QApplication.instance()
+        assert app is not None
+        mainThread = app.thread()
+        if self.thread() != mainThread:
+            self.moveToThread(mainThread)
+
+        self.__sigSubmit.connect(self.__run)
+
+    def submit(self, fn, *args, **kwargs):
+        """Submit fn(*args, **kwargs) to Qt main thread
+
+        :param callable fn: Function to call in main thread
+        :return: Future object to retrieve result
+        :rtype: concurrent.future.Future
+        """
+        future = Future()
+        self.__sigSubmit.emit(future, fn, args, kwargs)
+        return future
+
+    def __run(self, future, fn, args, kwargs):
+        """Run task in Qt main thread
+
+        :param concurrent.future.Future future:
+        :param callable fn: Function to run
+        :param tuple args: Arguments
+        :param dict kwargs: Keyword arguments
+        """
+        if not future.set_running_or_notify_cancel():
+            return
+
+        try:
+            result = fn(*args, **kwargs)
+        except BaseException as e:
+            future.set_exception(e)
+        else:
+            future.set_result(result)
+
+
+_executor = None
+"""QObject running the tasks in main thread"""
+
+
+def submitToQtMainThread(fn, *args, **kwargs):
+    """Run fn(args, kwargs) in Qt's main thread.
+
+    If not called from the main thread, this is run asynchronously.
+
+    :param callable fn: Function to call in main thread.
+    :return: A future object to retrieve the result
+    :rtype: concurrent.future.Future
+    """
+    global _executor
+    if _executor is None:  # Lazy-loading
+        _executor = _QtExecutor()
+
+    return _executor.submit(fn, *args, **kwargs)
diff --git a/silx/gui/utils/test/__init__.py b/silx/gui/utils/test/__init__.py
new file mode 100644
index 0000000..9e50170
--- /dev/null
+++ b/silx/gui/utils/test/__init__.py
@@ -0,0 +1,48 @@
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""silx.gui.utils tests"""
+
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "24/04/2018"
+
+
+import unittest
+
+from . import test_async
+from . import test_image
+
+
+def suite():
+    """Test suite for module silx.image.test"""
+    test_suite = unittest.TestSuite()
+    test_suite.addTest(test_async.suite())
+    test_suite.addTest(test_image.suite())
+    return test_suite
+
+
+if __name__ == '__main__':
+    unittest.main(defaultTest='suite')
diff --git a/silx/gui/utils/test/test_async.py b/silx/gui/utils/test/test_async.py
new file mode 100644
index 0000000..fd32a3f
--- /dev/null
+++ b/silx/gui/utils/test/test_async.py
@@ -0,0 +1,136 @@
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""Test of async module."""
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "09/03/2018"
+
+
+import threading
+import unittest
+
+
+from silx.third_party.concurrent_futures import wait
+from silx.gui import qt
+from silx.gui.test.utils import TestCaseQt
+
+from silx.gui.utils import concurrent
+
+
+class TestSubmitToQtThread(TestCaseQt):
+    """Test submission of tasks to Qt main thread"""
+
+    def setUp(self):
+        # Reset executor to test lazy-loading in different conditions
+        concurrent._executor = None
+        super(TestSubmitToQtThread, self).setUp()
+
+    def _task(self, value1, value2):
+        return value1, value2
+
+    def _taskWithException(self, *args, **kwargs):
+        raise RuntimeError('task exception')
+
+    def testFromMainThread(self):
+        """Call submitToQtMainThread from the main thread"""
+        value1, value2 = 0, 1
+        future = concurrent.submitToQtMainThread(self._task, value1, value2=value2)
+        self.assertTrue(future.done())
+        self.assertEqual(future.result(1), (value1, value2))
+        self.assertIsNone(future.exception(1))
+
+        future = concurrent.submitToQtMainThread(self._taskWithException)
+        self.assertTrue(future.done())
+        with self.assertRaises(RuntimeError):
+            future.result(1)
+        self.assertIsInstance(future.exception(1), RuntimeError)
+
+    def _threadedTest(self):
+        """Function run in a thread for the tests"""
+        value1, value2 = 0, 1
+        future = concurrent.submitToQtMainThread(self._task, value1, value2=value2)
+
+        wait([future], 3)
+
+        self.assertTrue(future.done())
+        self.assertEqual(future.result(1), (value1, value2))
+        self.assertIsNone(future.exception(1))
+
+        future = concurrent.submitToQtMainThread(self._taskWithException)
+
+        wait([future], 3)
+
+        self.assertTrue(future.done())
+        with self.assertRaises(RuntimeError):
+            future.result(1)
+        self.assertIsInstance(future.exception(1), RuntimeError)
+
+    def testFromPythonThread(self):
+        """Call submitToQtMainThread from a Python thread"""
+        thread = threading.Thread(target=self._threadedTest)
+        thread.start()
+        for i in range(100):  # Loop over for 10 seconds
+            self.qapp.processEvents()
+            thread.join(0.1)
+            if not thread.is_alive():
+                break
+        else:
+            self.fail(('Thread task still running'))
+
+    def testFromQtThread(self):
+        """Call submitToQtMainThread from a Qt thread pool"""
+        class Runner(qt.QRunnable):
+            def __init__(self, fn):
+                super(Runner, self).__init__()
+                self._fn = fn
+
+            def run(self):
+                self._fn()
+
+            def autoDelete(self):
+                return True
+
+        threadPool = qt.silxGlobalThreadPool()
+        runner = Runner(self._threadedTest)
+        threadPool.start(runner)
+        for i in range(100):  # Loop over for 10 seconds
+            self.qapp.processEvents()
+            done = threadPool.waitForDone(100)
+            if done:
+                break
+        else:
+            self.fail('Thread pool task still running')
+
+
+def suite():
+    test_suite = unittest.TestSuite()
+    test_suite.addTest(unittest.defaultTestLoader.loadTestsFromTestCase(
+        TestSubmitToQtThread))
+    return test_suite
+
+
+if __name__ == '__main__':
+    unittest.main(defaultTest='suite')
diff --git a/silx/gui/utils/test/test_image.py b/silx/gui/utils/test/test_image.py
new file mode 100644
index 0000000..7cba1b0
--- /dev/null
+++ b/silx/gui/utils/test/test_image.py
@@ -0,0 +1,74 @@
+# coding: utf-8
+# /*##########################################################################
+#
+# Copyright (c) 2017-2018 European Synchrotron Radiation Facility
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ###########################################################################*/
+"""Test of utils module."""
+
+__authors__ = ["T. Vincent"]
+__license__ = "MIT"
+__date__ = "16/01/2017"
+
+import numpy
+import unittest
+
+from silx.gui import qt
+from silx.gui.test.utils import TestCaseQt
+from silx.gui.utils import _image
+
+
+class TestQImageConversion(TestCaseQt):
+    """Tests conversion of QImage to/from numpy array."""
+
+    def testConvertArrayToQImage(self):
+        """Test conversion of numpy array to QImage"""
+        image = numpy.ones((3, 3, 3), dtype=numpy.uint8)
+        qimage = _image.convertArrayToQImage(image)
+
+        self.assertEqual(qimage.height(), image.shape[0])
+        self.assertEqual(qimage.width(), image.shape[1])
+        self.assertEqual(qimage.format(), qt.QImage.Format_RGB888)
+
+        color = qt.QColor(1, 1, 1).rgb()
+        self.assertEqual(qimage.pixel(1, 1), color)
+
+    def testConvertQImageToArray(self):
+        """Test conversion of QImage to numpy array"""
+        qimage = qt.QImage(3, 3, qt.QImage.Format_RGB888)
+        qimage.fill(0x010101)
+        image = _image.convertQImageToArray(qimage)
+
+        self.assertEqual(qimage.height(), image.shape[0])
+        self.assertEqual(qimage.width(), image.shape[1])
+        self.assertEqual(image.shape[2], 3)
+        self.assertTrue(numpy.all(numpy.equal(image, 1)))
+
+
+def suite():
+    test_suite = unittest.TestSuite()
+    test_suite.addTest(unittest.defaultTestLoader.loadTestsFromTestCase(
+        TestQImageConversion))
+    return test_suite
+
+
+if __name__ == '__main__':
+    unittest.main(defaultTest='suite')