# coding: utf-8 # /*########################################################################## # # Copyright (c) 2016-2019 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 is a convenient package to use from Python or IPython interpreter. It loads the main features of silx and provides high-level functions. >>> from silx import sx When used in an interpreter is sets-up Qt and loads some silx widgets. In a `jupyter `_ / `IPython `_ notebook, to set-up Qt and loads silx widgets, you must then call: >>> sx.enable_gui() When used in `IPython `_, it also runs ``%pylab``, thus importing `numpy `_ and `matplotlib `_. """ __authors__ = ["T. Vincent"] __license__ = "MIT" __date__ = "16/01/2017" import logging as _logging import sys as _sys import os as _os _logger = _logging.getLogger(__name__) # Init logging when used from the console if hasattr(_sys, 'ps1'): _logging.basicConfig() # Probe DISPLAY available on linux _NO_DISPLAY = _sys.platform.startswith('linux') and not _os.environ.get('DISPLAY') # Probe ipython try: from IPython import get_ipython as _get_ipython except (NameError, ImportError): _get_ipython = None # Probe ipython/jupyter notebook if _get_ipython is not None and _get_ipython() is not None: # Notebook detection probably fragile _IS_NOTEBOOK = ('parent_appname' in _get_ipython().config['IPKernelApp'] or hasattr(_get_ipython(), 'kernel')) else: _IS_NOTEBOOK = False # Placeholder for QApplication _qapp = None def enable_gui(): """Populate silx.sx module with silx.gui features and initialise Qt""" if _NO_DISPLAY: # Missing DISPLAY under linux _logger.warning( 'Not loading silx.gui features: No DISPLAY available') return global qt, _qapp if _IS_NOTEBOOK: _get_ipython().enable_pylab(gui='qt', import_all=False) from silx.gui import qt # Create QApplication and keep reference only if needed if not qt.QApplication.instance(): _qapp = qt.QApplication([]) if hasattr(_sys, 'ps1'): # If from console, change windows icon # Change windows default icon from silx.gui import icons app = qt.QApplication.instance() app.setWindowIcon(icons.getQIcon('silx')) global ImageView, PlotWidget, PlotWindow, Plot1D global Plot2D, StackView, ScatterView, TickMode from silx.gui.plot import (ImageView, PlotWidget, PlotWindow, Plot1D, Plot2D, StackView, ScatterView, TickMode) # noqa global plot, imshow, scatter, ginput from ._plot import plot, imshow, scatter, ginput # noqa try: import OpenGL except ImportError: _logger.warning( 'Not loading silx.gui.plot3d features: PyOpenGL is not installed') else: global contour3d, points3d from ._plot3d import contour3d, points3d # noqa # Load Qt and widgets only if running from console and display available if _IS_NOTEBOOK: _logger.warning( 'Not loading silx.gui features: Running from the notebook') else: enable_gui() # %pylab if _get_ipython is not None and _get_ipython() is not None: if not _NO_DISPLAY: # Not loading pylab without display from IPython.core.pylabtools import import_pylab as _import_pylab _import_pylab(_get_ipython().user_ns, import_all=False) # Clean-up del _os # Load some silx stuff in namespace from silx import version # noqa from silx.io import open # noqa from silx.io import * # noqa from silx.math import Histogramnd, HistogramndLut # noqa from silx.math.fit import leastsq # noqa