Skip to main content
Ctrl+K
silx 2.1.0 documentation - Home
2.1.0
  • User Guide
  • Applications
  • Tutorials & Sample Code
  • API Reference
  • Release Notes
  • GitHub
  • PyPI
  • User Guide
  • Applications
  • Tutorials & Sample Code
  • API Reference
  • Release Notes
  • GitHub
  • PyPI

Section Navigation

  • silx.gui: Graphical user interface
    • console: IPython console widgets
    • data: Widgets for data visualization
      • ArrayTableWidget: Browsing Numpy arrays
      • DataViewerFrame: Widget to display any kind of data
      • DataViewer: Widget to display any kind of data
      • NumpyAxesSelector:Widget to select a view from a numpy array
      • TextFormatter: Common text formatter
    • fit: Fit widgets
      • FitWidget
      • BackgroundWidget
    • dialog: Dialog widgets
      • ImageFileDialog
      • DataFileDialog
      • AbstractDataFileDialog
      • GroupDialog
      • DatasetDialog
      • ColormapDialog
    • hdf5: HDF5 widgets
      • Getting started with HDF5 widgets
        • hdf5widget.py
      • Hdf5TreeView class
      • Hdf5TreeModel class
      • Hdf5ContextMenuEvent class
      • H5Node class
      • Hdf5HeaderView class
      • NexusSortFilterProxyModel class
    • icons: Set of icons
    • colors: Colors and colormap
    • plot: 1D and 2D Plot widgets
      • Getting started with plot widgets
      • PlotWidget: Base class for plotting widgets
        • Plot signal
      • PlotWindow: Plot widget with toolbar
      • ComplexImageView: Plot a 2D array of complex
      • ImageView: Plot an image with side histograms
      • StackView: Plot a stack of images
      • ScatterView: Plot 2D scatter data
      • CompareImages: Plot 2 images to compare them
      • items: Plot primitives
      • actions: Actions for PlotWidget
        • silx.gui.plot.actions.control
        • silx.gui.plot.actions.medfilt
        • silx.gui.plot.actions.fit
        • silx.gui.plot.actions.histogram
        • silx.gui.plot.actions.io
      • PlotToolButtons: QToolButtons for plot widgets
      • tools: Tool widgets for PlotWidget
        • profile: Profile tool for PlotWidget
      • Profile: Toolbars with profile tools
      • CurvesROIWidget: ROI from curves
      • PrintPreviewToolButton: Print preview buttons
      • StatsWidget: Display a set of statictics for plot items
      • ROIStatsWidget: Display a set of statistics for couples (plot items, roi)
      • stats: Stats for PlotWidget
        • silx.gui.plot.stats.stats
        • silx.gui.plot.stats.statshandler
      • axis: utilities for plots
      • Package structure
    • plot3d: 3D Visualisation widgets
      • Plot3DWidget: OpenGL scene widget
      • Plot3DWindow: OpenGL scene and toolbar
      • SceneWidget: 3D data viewer widget
        • items: SceneWidget items
      • SceneWindow: 3D data viewer window
      • ScalarFieldView: 3D volume scalar data viewer
      • SFViewParamTree: ScalarFieldView parameters widget
      • tools
      • actions
      • Package structure
        • scene
        • utils
        • _glutils
    • qt: Qt bindings
    • utils: Qt helpers
    • widgets: Simple widgets
      • FlowLayout
      • FrameBrowser
      • PeriodicTable: Atomic elements widgets
      • PrintPreview: Print preview dialog
      • RangeSlider: Slider to define an interval
      • TableWidget: Table widget
      • ThreadPoolPushButton: Button to execute a threaded task
      • WaitingPushButton: Button with waiting status
    • Widgets gallery
  • silx.io: Input-output
    • commonh5: Helpers for writing h5py-like API
    • configdict: Configuration files I/O
    • convert: HDF5 conversion
    • dictdump: Dumping and loading dictionaries
    • nxdata: NXdata parsing and validation
    • octaveh5: Octave HDF5 compatibility
    • specfile: Reading SpecFile
    • specfilewrapper: Reading SpecFile (old API)
    • spech5: h5py-like API to SpecFile
    • fioh5: h5py-like API to FIO file
    • url: Utils for data locators
    • utils: I/O utilities
    • h5py_utils: HDF5 I/O utilities
  • silx.image:
    • bilinear: Bilinear interpolator
    • medianfilter: Median filter
    • marchingsquares: Marching squares
    • shapes: 2D shapes drawing
    • sift: 2D image alignment
    • projection: projection algorithm
    • backprojection: backprojection algorithm
    • reconstruction: reconstruction algorithm
  • silx.math:
    • fit: Fitting tools
      • leastsq: Levenberg Marquardt with constraints
      • Peak search function
      • Fit functions
      • Smoothing and background filters
      • fitmanager: Fit functions manager
      • fittheory: Fit theory definition
      • fittheories: Fit theories for fitmanager
      • bgtheories: Background theories for fitmanager
    • histogram: Multidimensional histograms
    • medianfilter: Median filter
    • combo: Statistics combo functions
    • colormap: Apply colormap to array
  • silx.opencl: OpenCL-based features
    • sift: SIFT image alignment
      • plan: SIFT Plan
      • match: SIFT Plan for keypoints matching
      • alignment: SIFT Plan for linear alignment
    • backprojection: (Filtered) Back-Projection
    • sinofilter: Sinogram filtering.
    • processing: Processing
    • convolution: Convolution
    • statistics: Statistics
    • medianfilter: OpenCL median filter
    • byte_offset: Byte Offset compression/decompression
  • silx.resources: Project resources access
  • silx.sx: Using silx from Python Interpreter
  • silx.utils:
    • array_like
    • deprecation
    • testutils
    • weakref
    • weakref
  • silx.test:
  • API Reference
  • silx.gui: Graphical user interface
  • Widgets gallery

Widgets gallery#

silx.gui.console Widgets#

Widget

Description

../../_images/IPythonWidget.png

IPythonWidget is an interactive console widget running a :class`QtInProcessKernelManager`. This allows to push variables to the interactive console, and interact with your application (e.g. adding curves to a plot)

../../_images/IPythonDockWidget.png

IPythonDockWidget is an IPythonWidget embedded in a QDockWidget.

silx.gui.data Widgets#

Widget

Description

../../_images/ArrayTableWidget.png

ArrayTableWidget is a table widget with browsers designed to display the content of multi-dimensional data arrays.

../../_images/DataViewer.png

DataViewer is a widget designed to display data using the most adapted view.

../../_images/DataViewerFrame.png

DataViewerFrame is a DataViewer with a view selector that lets you view the data using any compatible view.

../../_images/NumpyAxesSelector.png

NumpyAxesSelector is a widget designed to select a subarray in a n-dimensional array, by fixing the index on some of the dimensions.

silx.gui.dialog Widgets#

Widget

Description

../../_images/datafiledialog.png

DataFileDialog is a dialog that allows users to select any datasets or groups from any HDF5-like file. It features a file browser that can also browse the content of HDF5 file as if they were directories.

../../_images/imagefiledialog_h5.png

ImageFileDialog is a dialog that allows users to select an image from any HDF5-like file.

../../_images/groupdialog.png

GroupDialog is a dialog that allows users to select a group from one or several specified HDF5-like files.

silx.gui.fit Widgets#

Widget

Description

../../_images/FitWidget.png

FitWidget is a widget designed to configure and run a fitting process, with constraints on parameters.

../../_images/BackgroundDialog.png

BackgroundWidget.BackgroundDialog is a widget designed to adjust the parameters and preview the results of a snip or strip background filter.

silx.gui.hdf5 Widgets#

Widget

Description

../../_images/Hdf5TreeView.png

Hdf5TreeView is a tree view desiged to browse an HDF5 file structure.

silx.gui.plot Widgets#

Plotting widgets:

Widget

Description

../../_images/PlotWidget.png

PlotWidget is the base Qt widget providing a plot area. Other plot widgets are based on this one and provides the same API.

../../_images/PlotWindow.png

PlotWindow adds a toolbar to PlotWidget. The content of this toolbar can be configured from the PlotWindow constructor or by hiding its content afterward.

../../_images/Plot1D.png

Plot1D is a PlotWindow configured with tools useful for curves.

../../_images/Plot2D.png

Plot2D is a PlotWindow configured with tools useful for images.

../../_images/ImageView.png

ImageView adds side histograms to a Plot2D widget.

../../_images/StackView.png

StackView is a widget designed to display an image from a stack of images in a PlotWindow widget, with a frame browser to navigate in the stack. The profile tool can do a 2D profile on the stack of images.

../../_images/ComplexImageView.png

ComplexImageView is a widget dedicated to visualize a single 2D dataset of complex data. It allows to switch between viewing amplitude, phase, real, imaginary, colored phase with amplitude or log10(amplitude) as brightness.

../../_images/ScatterView.png

ScatterView is a widget dedicated to visualize a scatter plot.

../../_images/CompareImages.png

CompareImages is a widget dedicated to compare 2 images.

Additional widgets:

Widget

Description

../../_images/PositionInfo.png

PlotTools.PositionInfo is a widget displaying mouse position and information of a PlotWidget associated to the mouse position.

../../_images/LimitsToolBar.png

PlotTools.LimitsToolBar is a QToolBar displaying and controlling the limits of a PlotWidget.

../../_images/logColorbar.png

ColorBar.ColorBarWidget display colormap gradient and can be linked with a plot to display the colormap

../../_images/statsWidget.png

statsWidget.StatsWidget display statistics on plot’s items (curve, images…)

silx.gui.plot3d Widgets#

Widget

Description

../../_images/SceneWindow.png

SceneWindow is a QMainWindow embedding a 3D data visualization SceneWidget and associated toolbars. It can display 2D images, 2D scatter data, 3D scatter data and 3D volumes with different visualizations. See plot3dSceneWindow.py in silx.gui.plot3d sample code.

../../_images/SceneWidget.png

SceneWidget is a Plot3DWidget providing a 3D scene for visualizing different kind of data. It can display 2D images, 2D scatter data, 3D scatter data and 3D volumes with different visualizations. See plot3dSceneWindow.py in silx.gui.plot3d sample code.

../../_images/ScalarFieldView.png

ScalarFieldView is a Plot3DWindow dedicated to display 3D scalar field. It can display iso-surfaces and an interactive cutting plane.

../../_images/Plot3DWindow.png

Plot3DWindow is a QMainWindow with a Plot3DWidget as central widget and toolbars.

../../_images/Plot3DWidget.png

Plot3DWidget is the base Qt widget providing an OpenGL 3D scene. Other widgets are using this widget as the OpenGL scene canvas.

../../_images/SFViewParamTree.png

SFViewParamTree is a QTreeView widget that can be attached to a ScalarFieldView. It displays current parameters of the ScalarFieldView and allows to modify it. See silx.gui.plot3d sample code.

Additional widgets:

Widget

Description

../../_images/PositionInfoWidget.png

PositionInfoWidget displays the position and value of selected data point in a SceneWidget.

../../_images/GroupPropertiesWidget.png

GroupPropertiesWidget allows to reset properties of all items in a group in a SceneWidget.

silx.gui.widgets Widgets#

Widget

Description

../../_images/FrameBrowser.png

FrameBrowser.FrameBrowser is a browser widget designed to browse through a sequence of integers (e.g. the indices of an array)

../../_images/HorizontalSliderWithBrowser.png

FrameBrowser.HorizontalSliderWithBrowser is a FrameBrowser with an additional slider.

../../_images/RangeSlider.png

RangeSlider is a slider with 2 thumbs dedicated to the interactive selection of an interval.

../../_images/PeriodicCombo.png

PeriodicTable.PeriodicCombo is a QComboBox widget designed to select a single atomic element.

../../_images/PeriodicList.png

PeriodicTable.PeriodicList is a QTreeWidget designed to select one or more atomic elements.

../../_images/PeriodicTable.png

PeriodicTable.PeriodicTable is a periodic table widget designed to select one or more atomic elements.

../../_images/TableWidget.png

TableWidget.TableWidget and TableWidget.TableView inherit respectively QTableWidget and QTableView, and add a context menu with cut/copy/paste actions.

../../_images/WaitingPushButton.png

WaitingPushButton is a QPushButton that can be graphically disabled, for example to wait for a callback function to finish computing.

../../_images/ThreadPoolPushButton.png

ThreadPoolPushButton is a WaitingPushButton that executes a callback in a thread.

previous

WaitingPushButton: Button with waiting status

next

silx.io: Input-output

On this page
  • silx.gui.console Widgets
  • silx.gui.data Widgets
  • silx.gui.dialog Widgets
  • silx.gui.fit Widgets
  • silx.gui.hdf5 Widgets
  • silx.gui.plot Widgets
  • silx.gui.plot3d Widgets
  • silx.gui.widgets Widgets
Show Source

© Copyright 2015-2023, Data analysis unit, European Synchrotron Radiation Facility, Grenoble.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.2.