Package csw.params.events

Class IRDetectorEvent

java.lang.Object
csw.params.events.IRDetectorEvent
public class IRDetectorEvent extends Object
The Observe Events for IR science detector systems.

  • Constructor Details

    • IRDetectorEvent

      public IRDetectorEvent()

  • Method Details

    • exposureData

      public static ObserveEvent exposureData(Prefix sourcePrefix, ExposureId exposureId, int readsInRamp, int readsComplete, int rampsInExposure, int rampsComplete, long exposureTime, long remainingExposureTime)
      This event contains faster changing data about the internals of the current exposure. This data is useful for user interfaces and Sequencers. This event should be published at 1 Hz during an ongoing exposure. This event does not have much information compared to the IR use case and is primarily for tracking the remaining current exposure time in user interfaces or sequencers.
      Parameters:
      sourcePrefix - Prefix the prefix identifier of the source which is generating this event.
      exposureId - ExposureId is an identifier in ESW/DMS for a single exposure. The ExposureId follows the structure: 2020A-001-123-WFOS-IMG1-SCI0-0001 with an included ObsId or when no ObsId is present, in the standalone format: 20200706-190204-WFOS-IMG1-SCI0-0001 with a UTC time when the ExposureId is created.
      readsInRamp - The integer total number of reads in the ramp. Value should be constant during an exposure. (Note: for multi-array detectors, it is assumed that all arrays work with the same configuration).
      readsComplete - Integer number of current completed read from 1 to readsInRamp. Should be reset to 0 at the start of every ramp
      rampsInExposure - The integer total number of ramps in the current exposure. Value should be constant during an exposure.
      rampsComplete - Integer number of completed ramp from 1 to rampsInExposure. Should be reset to 0 at the start of every exposure.
      exposureTime - Length in milliseconds of the current exposure
      remainingExposureTime - Number of milliseconds remaining in current exposure • Should count down in seconds – no faster than 1 Hz
      Returns:
      ObserveEvent

    • observeStart

      public static ObserveEvent observeStart(Prefix sourcePrefix, ObsId obsId)

    • observeStart

      public static ObserveEvent observeStart(Prefix sourcePrefix)

    • observeEnd

      public static ObserveEvent observeEnd(Prefix sourcePrefix, ObsId obsId)

    • observeEnd

      public static ObserveEvent observeEnd(Prefix sourcePrefix)

    • exposureStart

      public static ObserveEvent exposureStart(Prefix sourcePrefix, ExposureId exposureId)

    • exposureEnd

      public static ObserveEvent exposureEnd(Prefix sourcePrefix, ExposureId exposureId)

    • readoutEnd

      public static ObserveEvent readoutEnd(Prefix sourcePrefix, ExposureId exposureId)

    • readoutFailed

      public static ObserveEvent readoutFailed(Prefix sourcePrefix, ExposureId exposureId)

    • dataWriteStart

      public static ObserveEvent dataWriteStart(Prefix sourcePrefix, ExposureId exposureId, String filename)

    • dataWriteEnd

      public static ObserveEvent dataWriteEnd(Prefix sourcePrefix, ExposureId exposureId, String filename)

    • exposureAborted

      public static ObserveEvent exposureAborted(Prefix sourcePrefix, ExposureId exposureId)

    • exposureState

      public static ObserveEvent exposureState(Prefix sourcePrefix, ExposureId exposureId, boolean exposureInProgress, boolean abortInProgress, boolean isAborted, String errorMessage, OperationalState operationalState)

    • create

      public static ObserveEvent create(Prefix sourcePrefix, ExposureId exposureId, EventName eventName)

    • create

      public static ObserveEvent create(Prefix sourcePrefix, ExposureId exposureId, EventName eventName, String filename)