pyFAI.gui.dialog package#

pyFAI.gui.dialog.Detector3dDialog module#

class pyFAI.gui.dialog.Detector3dDialog.CreateSceneThread(parent=None)#

Bases: QThread

__init__(parent=None)#

emitProgressValue(value, force=False)#

errorString()#

getBeamItem()#

getDetectorItem()#

getSampleItem()#

hasGeometry()#

isAborted()#: Returns whether the thread has been aborted.

Note

Aborted threads are not finished threads.

progressValue#

run()#

runProcess()#

setColormap(colormap)#

setDetector(detector)#

setGeometry(geometry)#

setImage(image)#

setMask(mask)#

staticMetaObject = PySide6.QtCore.QMetaObject("CreateSceneThread" inherits "QThread": Methods: #12 type=Signal, signature=progressValue(int), parameters=int )#

class pyFAI.gui.dialog.Detector3dDialog.Detector3dDialog(parent=None)#

Bases: QDialog

Dialog to display a selected geometry

__init__(parent=None)#

setData(detector=None, image=None, mask=None, colormap=None, geometry=None)#

staticMetaObject = PySide6.QtCore.QMetaObject("Detector3dDialog" inherits "QDialog": )#

pyFAI.gui.dialog.DetectorSelectorDialog module#

class pyFAI.gui.dialog.DetectorSelectorDialog.DetectorSelectorDialog(parent=None)#

Bases: QDialog

__init__(parent=None)#

selectDetector(detector)#

Select a detector.

Parameters:: detector (pyFAI.detectors.Detector) – Detector to select in this dialog

selectedDetector()#

Returns the selected detector.

Return type:: pyFAI.detectors.Detector

staticMetaObject = PySide6.QtCore.QMetaObject("DetectorSelectorDialog" inherits "QDialog": )#

class pyFAI.gui.dialog.DetectorSelectorDialog.DetectorSelectorDrop(parent=None)#

Bases: QWidget

__init__(parent=None)#

createFileDialog(title, h5file=True, splineFile=True, previousFile=None)#

createSplineDialog(title, previousFile)#

currentCustomField()#

currentDetectorClass()#

currentManufacturer()#

detector()#

getOrientation(idx=None)#

getSensorConfig() → SensorConfig | None#

loadSplineFile()#

setDetector(detector)#

setSensorConfig(sensor: SensorConfig | None = None)#

staticMetaObject = PySide6.QtCore.QMetaObject("DetectorSelectorDrop" inherits "QWidget": )#

pyFAI.gui.dialog.GeometryDialog module#

class pyFAI.gui.dialog.GeometryDialog.GeometryDialog(parent=None)#

Bases: QDialog

Dialog to display a selected geometry

__init__(parent=None)#

accept()#

geometryModel()#

Returns the geometry model

Return type:: GeometryModel

isReadOnly()#

Returns True if the dialog is in read only.

In read-only mode, the geometry is displayed, but the user can’t edited it.

By default, this returns false.

Return type:: bool

reject()#

setDetector(detector)#

Set the used detector.

This information is needed to display the Fit2D geometry.

setGeometryModel(geometryModel)#

Set the geometry to display.

Parameters:: geometryModel (GeometryModel) – A geometry.

setReadOnly(readOnly)#

Enable or disable the read-only mode.

Parameters:: readOnly (bool) – True to enable the read-only mode.

staticMetaObject = PySide6.QtCore.QMetaObject("GeometryDialog" inherits "QDialog": )#

pyFAI.gui.dialog.IntegrationMethodDialog module#

class pyFAI.gui.dialog.IntegrationMethodDialog.IntegrationMethodDialog(parent=None)#

Bases: QDialog

__init__(parent=None)#

selectMethod(method)#

Select a detector.

Parameters:: detector (pyFAI.detectors.Detector) – Detector to select in this dialog

selectedMethod()#

Returns the selected detector.

Return type:: tuple

staticMetaObject = PySide6.QtCore.QMetaObject("IntegrationMethodDialog" inherits "QDialog": )#

class pyFAI.gui.dialog.IntegrationMethodDialog.IntegrationMethodWidget(parent=None)#

Bases: QWidget

Label displaying a specific OpenCL device.

CodeRole = 257#

__init__(parent=None)#

method()#

Returns method as tuple of split, algo and impl

Return type:: Tuple[str,str,str]

setMethod(method)#

setStringMethod(method)#

setTupleMethod(method)#

sigMethodChanged#

staticMetaObject = PySide6.QtCore.QMetaObject("IntegrationMethodWidget" inherits "QWidget": Methods: #33 type=Signal, signature=sigMethodChanged() )#

pyFAI.gui.dialog.MessageBox module#

pyFAI.gui.dialog.MessageBox.exception(parent, title, exc_info, logger=None)#

Display an exception as a MessageBox

Parameters:

parent (qt.QWidget) – The parent widget
title (str) – A context message (displayed a s a title)
exc_info (Union[tuple,Exception]) – An exception or the output of exc_info.
logger (object) – Logger to record the error inside. If None a default logger is provided.

pyFAI.gui.dialog.MessageBox.message_box(parent, title: str = '', text: str = '', detailed: str = '')#

Display a MessageBox (for the exception)

Parameters:

parent (qt.QWidget) – The parent widget
title (str) – A context message (displayed a s a title)
text (str) – the text for the message

:param str detailed

pyFAI.gui.dialog.OpenClDeviceDialog module#

class pyFAI.gui.dialog.OpenClDeviceDialog.OpenClDeviceDialog(parent=None)#

Bases: QDialog

Dialog to select an OpenCl device. It could be both select an available device on this machine or a custom one using indexes, or some types of requested devices.

This dialog do not expect PyOpenCL to installed.

__init__(parent=None)#

device()#

Returns the selected OpenCL device.

A device can be identified as a string like ‘any’, ‘cpu’ or ‘gpu’ or a tuple containing the platform index and the device index.

Return type:: Union[str,Tuple[int,int]]
Raises:: ValueError – If no devices are selected

selectDevice(device)#

Select an OpenCL device displayed on this dialog.

A device can be identified as a string like ‘any’, ‘cpu’ or ‘gpu’ or a tuple containing the platform index and the device index.

If this device is available on this platform is is selected in the list. Else it is selected as a custom indexes.

Parameters:: device (Union[str,Tuple[int,int]]) – A device.

showEvent(event)#

staticMetaObject = PySide6.QtCore.QMetaObject("OpenClDeviceDialog" inherits "QDialog": )#

Module contents#

Module containing generic Qt dialog