pyFAI.gui.tasks package

pyFAI.gui.tasks.AbstractCalibrationTask module

class pyFAI.gui.tasks.AbstractCalibrationTask.AbstractCalibrationTask

Bases: QWidget

__init__()

aboutToClose()

eventFilter(self, a0: QObject | None, a1: QEvent | None) → bool

initNextStep()

model()

Returns the calibration model

Return type:

CalibrationModel

nextStepWarning()

nextTask()

nextTaskRequested

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

setModel(model)

setNextStepVisible(isVisible)

setupSplitter()

updateNextStepStatus()

warningUpdated

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

widgetHide

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

widgetShow

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

pyFAI.gui.tasks.ExperimentTask module

class pyFAI.gui.tasks.ExperimentTask.ExperimentTask

Bases: AbstractCalibrationTask

aboutToClose()

createCalibrantDialog(title)

createImageDialog(title, forMask=False, previousFile=None)

loadCalibrant()

nextStepWarning()

pyFAI.gui.tasks.GeometryTask module

class pyFAI.gui.tasks.GeometryTask.CalibrationState(parent)

Bases: QObject

Store the state of a calibration

__init__(parent)

changed

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

getBeamCenter()

getGeometryRefinement()

getIndexedRings()

getPoni()

getPreviousRms()

getRingPolygons(ringId)

Returns the polygon of a ring.

This function compute the requested polygon ring, and cache it for the next use.

Return type:

List[numpy.ndarray]

getRings()

getRms()

getTwoThetaArray()

isEmpty()

popGeometryRefinement()

Invalidate the object and remove the ownershit of the geometry refinment

reset()

update(calibration)

Update the state from a current calibration process.

Parameters:

calibration (RingCalibration) – A calibration process

class pyFAI.gui.tasks.GeometryTask.GeometryTask

Bases: AbstractCalibrationTask

addParameterToLayout(layout, param)

pyFAI.gui.tasks.IntegrationTask module

class pyFAI.gui.tasks.IntegrationTask.EnablableDataModel(parent, model)

Bases: DataModel

__init__(parent, model)

isEnabled()

setEnabled(isEnabled)

setValue(value)

class pyFAI.gui.tasks.IntegrationTask.IntegrationPlot(parent=None)

Bases: QFrame

__init__(parent=None)

aboutToClose()

clear()

dataToChiTth(data)

Returns chi and 2theta angles in radian from data coordinate

eventFilter(self, a0: QObject | None, a1: QEvent | None) → bool

getDefaultColormap()

hasData()

resetZoom()

setIntegrationProcess(integrationProcess)

:param IntegrationProcess integrationProcess:

Result of the integration process

setProcessing()

unsetProcessing()

class pyFAI.gui.tasks.IntegrationTask.IntegrationProcess(model, altGeometry=None)

Bases: object

__init__(model, altGeometry=None)

directDist()

errorMessage()

geometry()

Return type:

pyFAI.geometry.Geometry

isValid()

method()

radialUnit()

resetZoomPolicy()

result1d()

result2d()

resultMask2d()

rings()

Returns the list of displayable rings as a list of tuple id (zero based), angle

Return type:

List

run()

setDisplayMask(displayed)

setMethod(method)

setResetZoomPolicy(policy)

wavelength()

class pyFAI.gui.tasks.IntegrationTask.IntegrationTask

Bases: AbstractCalibrationTask

aboutToClose()

pyFAI.gui.tasks.IntegrationTask.createSaveDialog(parent, title, poni=False, json=False, csv=False)

Util to create create a save dialog

pyFAI.gui.tasks.MaskTask module

class pyFAI.gui.tasks.MaskTask.MaskTask

Bases: AbstractCalibrationTask

pyFAI.gui.tasks.PeakPickingTask module

class pyFAI.gui.tasks.PeakPickingTask.PeakPickingTask

Bases: AbstractCalibrationTask

EXTRACT_ALL = 'extract-all'

EXTRACT_EXISTING = 'extract-existing'

EXTRACT_MORE = 'extract-more'

EXTRACT_SINGLE = 'extract-single'

autoExtractSingleRing(ring)

Module contents

Package containing tasks (decoupled views to the model)