est.gui package¶

Subpackages¶

est.gui.XasObjectViewer module¶

Tools to visualize spectra

class est.gui.XasObjectViewer.MapViewer(parent=None, keys=None)¶

Bases: PyQt5.QtWidgets.QWidget

Widget to display different map of the spectra

clear()¶

getActiveKey()¶

getPlot()¶

setPerspectiveVisible(b)¶: hide the dimension selection

setXasObject(xas_obj)¶

sigFrameChanged¶: Signal emitter when the frame number has changed.

class est.gui.XasObjectViewer.SpectrumViewer(parent=None)¶

Bases: PyQt5.QtWidgets.QMainWindow

addCurveOperation(callbacks)¶

register an curve to display from Xasobject keys, and a legend

Parameters: callbacks – callback to call when displaying a specific curve
Type: Union[list,tuple,function]

clear()¶

clearCurveOperations()¶: Remove all defined curve operation

getCurrentSpectrum()¶: Return the spectrum currently selected

setXasObject(xas_obj)¶

setYAxisLogarithmic(val)¶

sigSpectrumChanged¶: Signal emitted when the spectrum change

class est.gui.XasObjectViewer.ViewType(value)¶

Bases: silx.utils.enum.Enum

An enumeration.

map = (0,)¶

spectrum = (1,)¶

class est.gui.XasObjectViewer.XasObjectViewer(parent=None, mapKeys=None, spectrumPlots=None)¶

Bases: PyQt5.QtWidgets.QMainWindow

Viewer dedicated to view a XAS object

Parameters

parent (QObject) – Qt parent
mapKeys (list) – list of str keys to propose for the map display
spectrumsPlots (list) – list of keys if several spectrum plot should be proposed.

getViewType()¶

setXASObj(xas_obj)¶

viewTypeChanged¶: emitted when the view type change

est.gui.icons module¶

Set of icons for buttons.

Use getQIcon() to create Qt QIcon from the name identifying an icon.

class est.gui.icons.AbstractAnimatedIcon(parent=None)¶

Bases: silx.gui.qt._qt.QObject

Store an animated icon.

It provides an event containing the new icon everytime it is updated.

currentIcon()¶

Returns the icon of the current frame.

Return type: qt.QIcon

hasRegistredObjects()¶

Returns true if any object is registred.

Return type: bool

iconChanged¶: Signal sent with a QIcon everytime the animation changed.

isRegistered(obj)¶

Returns true if the object is registred in the AnimatedIcon.

Parameters: obj (object) – An object
Return type: bool

register(obj)¶

Register an object to the AnimatedIcon. If no object are registred, the animation is paused. Object are stored in a weaked list.

Parameters: obj (object) – An object

unregister(obj)¶

Remove the object from the registration. If no object are registred the animation is paused.

Parameters: obj (object) – A registered object

class est.gui.icons.AnimatedIcon(**kwargs)¶

Bases: est.gui.icons.MovieAnimatedIcon

Store a looping QMovie to provide icons for each frames. Provides an event with the new icon everytime the movie frame is updated.

It may not be available anymore for the silx release 0.6.

Deprecated since version 0.5: Use MovieAnimatedIcon instead.

class est.gui.icons.MovieAnimatedIcon(filename, parent=None)¶

Bases: est.gui.icons.AbstractAnimatedIcon

Store a looping QMovie to provide icons for each frames. Provides an event with the new icon everytime the movie frame is updated.

class est.gui.icons.MultiImageAnimatedIcon(filename, parent=None)¶

Bases: est.gui.icons.AbstractAnimatedIcon

Store a looping QMovie to provide icons for each frames. Provides an event with the new icon everytime the movie frame is updated.

est.gui.icons.cleanIconCache()¶: Clean up the icon cache

est.gui.icons.getAnimatedIcon(name)¶

Create an AbstractAnimatedIcon from a resource name.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Try to load a mng or a gif file, then try to load a multi-image animated icon.

In Qt5 mng or gif are not used, because the transparency is not very well managed.

Parameters: name (str) – Name of the icon, in one of the defined icons in this module.
Returns: Corresponding AbstractAnimatedIcon
Raises: ValueError when name is not known

est.gui.icons.getIconCache()¶

Get access to all cached icons

Return type: dict

est.gui.icons.getQFile(name)¶

Create a QFile from an icon name. Filename is found according to supported Qt formats.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Parameters: name (str) – Name of the icon, in one of the defined icons in this module.
Returns: Corresponding QFile
Return type: qt.QFile
Raises: ValueError when name is not known

est.gui.icons.getQIcon(name)¶

Create a QIcon from its name.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Parameters: name (str) – Name of the icon, in one of the defined icons in this module.
Returns: Corresponding QIcon
Raises: ValueError when name is not known

est.gui.icons.getQPixmap(name)¶

Create a QPixmap from its name.

The resource name can be prefixed by the name of a resource directory. For example “silx:foo.png” identify the resource “foo.png” from the resource directory “silx”.

If no prefix are specified, the file with be returned from the silx resource directory with a specific path “gui/icons”.

See also silx.resources.register_resource_directory().

Parameters: name (str) – Name of the icon, in one of the defined icons in this module.
Returns: Corresponding QPixmap
Raises: ValueError when name is not known

est.gui.icons.getWaitIcon()¶

Returns a cached version of the waiting AbstractAnimatedIcon.

Return type: AbstractAnimatedIcon

est.gui.qtapplicationmanager module¶

This module is used to manage the rsync between files for transfert.

est.gui.roiselector module¶

Tools to visualize spectra

class est.gui.roiselector.ROISelector(parent=None)¶

Bases: PyQt5.QtWidgets.QWidget

Used to defined a roi on a spectra map

getROI()¶

getXasObject()¶

setROI(origin, size)¶

setXasObject(xas_obj)¶

updateAddedRegionOfInterest(roi)¶: Called for each added region of interest: set the name

class est.gui.roiselector.ROISelectorDialog(parent=None)¶

Bases: PyQt5.QtWidgets.QDialog

Dialog embedding the SoiSelector

est.gui.xas_object_definition module¶

class est.gui.xas_object_definition.XASObjectDialog(parent=None)¶

Bases: PyQt5.QtWidgets.QWidget

Interface used to select inputs for defining a XASObject

buildXASObject()¶

editingFinished¶

getAdvanceHdf5Information()¶

class est.gui.xas_object_definition.XASObjectWindow(parent)¶

Bases: PyQt5.QtWidgets.QMainWindow

buildXASObject()¶

getAdvanceHdf5Information()¶

getConfigurationUrl()¶

getMainWindow()¶

loadXasObject()¶: Load XasObject from information contained in the GUI and update plot

setAbsColName(name)¶

setConfigurationUrl(url)¶

setCsvFile(file_path)¶

setCurrentType(input_type)¶

setDatFile(file_path)¶

setDimensions(dims)¶

setEnergyColName(name)¶

setEnergyUnit(unit)¶

setEnergyUrl(url)¶

setMonitorColName(name)¶

setScanTitle(name)¶

setSpectraUrl(url)¶

setXmuFile(file_path)¶

est.gui package¶

Subpackages¶

est.gui.XasObjectViewer module¶

est.gui.icons module¶

est.gui.qtapplicationmanager module¶

est.gui.roiselector module¶

est.gui.xas_object_definition module¶

Module contents¶

Table of Contents

Previous topic

Next topic

This Page