Package gda.device

Interface DetectorSnapper

All Known Implementing Classes:
AndorZylaDetector, Cam4Detector, IPPserver, MirrorCommissioningDetector, NXDetectorSnapper, NXDetectorSnappingDecorator
public interface DetectorSnapper
An interface to control detectors from outside a scan. The file template used to determine the path for detector files is determined by the implementation. AreaDetector's NDFilePlugin (http://cars.uchicago.edu/software/epics/NDPluginFile.html) will always apply arguments to the template in the order filepath, filename, filenumber. Here the filepath and filename are configurable, and the filenumber is determined by the implementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    acquire()
    Trigger an acquisition and block until complete.
    double
    getAcquirePeriod()
    Return the acquisition period resulting from the last configured collection time.
    double
    getAcquireTime()
    Return the acquisition time resulting from the last configured collection time.
    void
    prepareForAcquisition(double collectionTime)
    Sets the collection time for the next collection (implicitly a single image collection).

  • Method Details

    • prepareForAcquisition

      void prepareForAcquisition(double collectionTime) throws Exception
      Sets the collection time for the next collection (implicitly a single image collection).
      Parameters:
      collectionTime -
      Throws:
      Exception

    • getAcquireTime

      double getAcquireTime() throws Exception
      Return the acquisition time resulting from the last configured collection time. This will depend on the collection strategy.
      Returns:
      acquisition time in seconds
      Throws:
      Exception

    • getAcquirePeriod

      double getAcquirePeriod() throws Exception
      Return the acquisition period resulting from the last configured collection time. This will depend on the collection strategy.
      Returns:
      acquisition time in seconds
      Throws:
      Exception

    • acquire

      String[] acquire() throws InterruptedException, IllegalStateException, Exception
      Trigger an acquisition and block until complete.
      Returns:
      list of all resulting files.
      Throws:
      InterruptedException
      IllegalStateException - if the detector was already acquiring
      Exception