Package gda.px.detector

Interface Detector

All Superinterfaces:
Configurable, Device, Findable, gda.observable.IObservable, Stoppable
All Known Subinterfaces:
IAreaDetectorPilatus, IPilatusDetector, OdinEigerDetector
All Known Implementing Classes:
AreaDetectorPilatusBase, DetectorBase, DetectorProxy, DummyAreaDetectorPilatus, DummyDetector, DummyOdinEigerDetectorImpl, EpicsAreaDetectorPilatus, EpicsOdinEigerDetectorImpl, OdinEigerDetectorImpl
public interface Detector extends Device, Stoppable
Detector interface. All detectors must implement following functions. Detector observes lower level controller (eg. MardcController) and is observed by DetectorControlPanel.

  • Method Details

    • getId

      int getId()

    • abort

      void abort() throws DeviceException
      Aborts the current action by the detector. The detector should be left in a state such that data collection can continue without further resetting. This method should also work when the detector is idle.
      Throws:
      DeviceException

    • getDetectorStatus

      DetectorStatus getDetectorStatus() throws DeviceException
      Returns current status of detector
      Returns:
      DetectorStatus
      Throws:
      DeviceException

    • getImageMB

      double getImageMB() throws DeviceException
      Returns the size of images produced, in MB
      Returns:
      double
      Throws:
      DeviceException

    • getLastImageName

      String getLastImageName() throws DeviceException
      Returns the filename of the last image created.
      Returns:
      String
      Throws:
      DeviceException

    • getSizeX

      int getSizeX()
      Returns:
      horizontal size of image, in pixels

    • getSizeY

      int getSizeY()
      Returns:
      vertical size of image, in pixels

    • getMaxDimension

      double getMaxDimension() throws DeviceException
      Returns the largest dimension of the detector face in mm.
      Returns:
      double
      Throws:
      DeviceException

    • getSuffix

      String getSuffix() throws DeviceException
      Returns the suffix currently given to all images created
      Returns:
      String
      Throws:
      DeviceException

    • getTypeString

      String getTypeString()
      Returns the type of the detector
      Returns:
      String

    • initialiseDataSet

      void initialiseDataSet(DetectorCollectionParameters datasetParameters) throws DeviceException
      Informs the detector that a collection of images with incremental names will be created. This is not simply called setCurrentParameters to show that this method may often do more work than simply changing an instance field.
      Parameters:
      datasetParameters -
      Throws:
      DeviceException

    • start

      void start(String file, double omegaStart) throws DeviceException
      Start data collection
      Parameters:
      file - - the name of the file to create
      omegaStart - - the starting angle of data collection (to go into image header)
      Throws:
      DeviceException

    • waitForReady

      void waitForReady() throws DeviceException
      Returns when the detector has finished its currently operation. If its idle then returns immediately.
      Throws:
      DeviceException

    • getDimensionInMm

      DetectorDimension getDimensionInMm()

    • isBusy

      boolean isBusy() throws DeviceException
      Throws:
      DeviceException

    • enableRoiMode

      void enableRoiMode() throws DeviceException
      Throws:
      DeviceException

    • disableRoiMode

      void disableRoiMode() throws DeviceException
      Throws:
      DeviceException

    • isInRoiMode

      boolean isInRoiMode() throws DeviceException
      Throws:
      DeviceException

    • getFullSizeX

      int getFullSizeX()

    • getFullSizeY

      int getFullSizeY()

    • getFullDimensionInMm

      DetectorDimension getFullDimensionInMm()

    • getMaxFullDimension

      double getMaxFullDimension()

    • getAutoRunNumberUtils

      AutoRunNumberUtils getAutoRunNumberUtils() throws DeviceException
      Throws:
      DeviceException

    • getMinExposureTime

      double getMinExposureTime()

    • getMinStillExposureTime

      double getMinStillExposureTime()