# pyFAI.gui.tasks package

## pyFAI.gui.tasks.AbstractCalibrationTask module

class `pyFAI.gui.tasks.AbstractCalibrationTask.``AbstractCalibrationTask`

  Bases: `PyQt5.QtWidgets.QWidget`

  `__init__`()

    Initialize self. See help(type(self)) for accurate signature.

  `aboutToClose`()
  `eventFilter`(self, QObject, QEvent) → bool
  `initNextStep`()
  `model`()

    Returns the calibration model

    Return type: | CalibrationModel

  `nextStepWarning`()
  `nextTask`()
  `nextTaskRequested`
  `setModel`(model)
  `setNextStepVisible`(isVisible)
  `updateNextStepStatus`()
  `warningUpdated`
  `widgetHide`
  `widgetShow`

## pyFAI.gui.tasks.ExperimentTask module

class `pyFAI.gui.tasks.ExperimentTask.``ExperimentTask`

  Bases: `pyFAI.gui.tasks.AbstractCalibrationTask.AbstractCalibrationTask`

  `createCalibrantDialog`(title)
  `createImageDialog`(title, forMask=False, previousFile=None)
  `loadCalibrant`()
  `nextStepWarning`()

## pyFAI.gui.tasks.GeometryTask module

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

  Bases: `PyQt5.QtCore.QObject`

  Store the state of a calibration

  `__init__`(parent)

    Initialize self. See help(type(self)) for accurate signature.

  `changed`
  `getBeamCenter`()
  `getGeometryRefinement`()
  `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: `pyFAI.gui.tasks.AbstractCalibrationTask.AbstractCalibrationTask`

  `addParameterToLayout`(layout, param)

## pyFAI.gui.tasks.IntegrationTask module

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

  Bases: `pyFAI.gui.model.DataModel.DataModel`

  `__init__`(parent, model)

    Initialize self. See help(type(self)) for accurate signature.

  `isEnabled`()
  `setEnabled`(isEnabled)
  `setValue`(value)

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

  Bases: `PyQt5.QtWidgets.QFrame`

  `__init__`(parent=None)

    Initialize self. See help(type(self)) for accurate signature.

  `aboutToClose`()
  `clear`()
  `dataToChiTth`(data)

    Returns chi and 2theta angles in radian from data coordinate

  `eventFilter`(self, QObject, QEvent) → bool
  `getDefaultColormap`()
  `hasData`()
  `resetZoom`()
  `setIntegrationProcess`(integrationProcess)
    :param `IntegrationProcess` integrationProcess:
      Result of the integration process
  `setProcessing`()
  `unsetProcessing`()

class `pyFAI.gui.tasks.IntegrationTask.``IntegrationProcess`(model)

  Bases: `object`

  `__init__`(model)

    Initialize self. See help(type(self)) for accurate signature.

  `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: `pyFAI.gui.tasks.AbstractCalibrationTask.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: `pyFAI.gui.tasks.AbstractCalibrationTask.AbstractCalibrationTask`

## pyFAI.gui.tasks.PeakPickingTask module

class `pyFAI.gui.tasks.PeakPickingTask.``PeakPickingTask`

  Bases: `pyFAI.gui.tasks.AbstractCalibrationTask.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)