Package csw.params.events

Class SequencerObserveEvent

java.lang.Object
csw.params.events.SequencerObserveEvent
All Implemented Interfaces:
Serializable, scala.Equals, scala.Product
public class SequencerObserveEvent extends Object implements scala.Product, Serializable
The events that indicate activities for each observation and the acquisition process. param: prefix Prefix the prefix identifier of the sequencer which is generating this event.
See Also:

  • Constructor Details

    • SequencerObserveEvent

      public SequencerObserveEvent(Prefix prefix)

  • Method Details

    • apply

      public abstract static R apply(T1 v1)

    • toString

      public static String toString()

    • prefix

      public Prefix prefix()

    • presetStart

      public ObserveEvent presetStart(ObsId obsId)
      This event indicates the start of the preset phase of acquisition
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • presetEnd

      public ObserveEvent presetEnd(ObsId obsId)
      This event indicates the end of the preset phase of acquisition
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • guidestarAcqStart

      public ObserveEvent guidestarAcqStart(ObsId obsId)
      This event indicates the start of locking the telescope to the sky with guide and WFS targets
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • guidestarAcqEnd

      public ObserveEvent guidestarAcqEnd(ObsId obsId)
      This event indicates the end of locking the telescope to the sky with guide and WFS targets
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • scitargetAcqStart

      public ObserveEvent scitargetAcqStart(ObsId obsId)
      This event indicates the start of acquisition phase where science target is peaked up as needed after guidestar locking
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • scitargetAcqEnd

      public ObserveEvent scitargetAcqEnd(ObsId obsId)
      This event indicates the end of acquisition phase where science target is centered as needed after guidestar locking
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • observationStart

      public ObserveEvent observationStart(ObsId obsId)
      This event indicates the start of execution of actions related to an observation including acquisition and science data acquisition.
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • observationEnd

      public ObserveEvent observationEnd(ObsId obsId)
      This event indicates the end of execution of actions related to an observation including acquisition and science data acquisition.
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • observeStart

      public ObserveEvent observeStart(ObsId obsId)
      This event indicates the start of execution of actions related to an Observe command
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • observeEnd

      public ObserveEvent observeEnd(ObsId obsId)
      This event indicates the end of execution of actions related to an Observe command
      Parameters:
      obsId - ObsId Represents a unique observation id
      Returns:
      ObserveEvent

    • exposureStart

      public ObserveEvent exposureStart(ExposureId exposureId)
      This event indicates the start of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.
      Parameters:
      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.
      Returns:
      ObserveEvent

    • exposureEnd

      public ObserveEvent exposureEnd(ExposureId exposureId)
      This event indicates the end of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.
      Parameters:
      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.
      Returns:
      ObserveEvent

    • readoutEnd

      public ObserveEvent readoutEnd(ExposureId exposureId)
      This event indicates that a readout that is part of a ramp has completed.
      Parameters:
      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.
      Returns:
      ObserveEvent

    • readoutFailed

      public ObserveEvent readoutFailed(ExposureId exposureId)
      This event indicates that a readout that is part of a ramp has failed indicating transfer failure or some other issue.
      Parameters:
      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.
      Returns:
      ObserveEvent

    • dataWriteStart

      public ObserveEvent dataWriteStart(ExposureId exposureId, String filename)
      This event indicates that the instrument has started writing the exposure data file or transfer of exposure data to DMS.
      Parameters:
      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.
      filename - String the path of the file.
      Returns:
      ObserveEvent

    • dataWriteEnd

      public ObserveEvent dataWriteEnd(ExposureId exposureId, String filename)
      This event indicates that the instrument has finished writing the exposure data file or transfer of exposure data to DMS.
      Parameters:
      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.
      filename - String the path of the file.
      Returns:
      ObserveEvent

    • prepareStart

      public ObserveEvent prepareStart(ExposureId exposureId)
      This event indicates that the detector system is preparing to start an exposure.
      Parameters:
      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.
      Returns:
      ObserveEvent

    • exposureAborted

      public ObserveEvent exposureAborted(ExposureId exposureId)
      This event indicates that a request was made to abort the exposure and it has completed. Normal data events should occur if data is recoverable. Abort should not fail
      Parameters:
      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.
      Returns:
      ObserveEvent

    • observePaused

      public ObserveEvent observePaused()
      This event indicates that a user has paused the current observation Sequence which will happen after the current step concludes
      Returns:
      ObserveEvent

    • observeResumed

      public ObserveEvent observeResumed()
      This event indicates that a user has resumed a paused observation Sequence.
      Returns:
      ObserveEvent

    • downtimeStart

      public ObserveEvent downtimeStart(ObsId obsId, String reasonForDowntime)
      This event indicates that something has occurred that interrupts the normal observing workflow and time accounting. This event will have a hint (TBD) that indicates the cause of the downtime for statistics. Examples are: weather, equipment or other technical failure, etc. Downtime is ended by the start of an observation or exposure.
      Parameters:
      obsId - ObsId Represents a unique observation id
      reasonForDowntime - String a hint that indicates the cause of the downtime for statistics.
      Returns:
      ObserveEvent

    • offsetStart

      public ObserveEvent offsetStart(ObsId obsId, CoordinateSystem coordinateSystem, double p, double q)
      This event indicates the start of a telescope offset or dither
      Parameters:
      obsId - ObsId representing a unique observation id
      coordinateSystem - CoordinateSystem Represents coordinate system
      p - Double Represents telescope's xCoordinate offset
      q - Double Represents telescope's yCoordinate offset
      Returns:
      ObserveEvent

    • offsetEnd

      public ObserveEvent offsetEnd(ObsId obsId)
      This event indicates the end of a telescope offset or dither
      Parameters:
      obsId - ObsId representing a unique observation id
      Returns:
      ObserveEvent

    • inputRequestStart

      public ObserveEvent inputRequestStart(ObsId obsId)
      This event indicates the start of a request to the user for input
      Parameters:
      obsId - ObsId Representing a unique observation id
      Returns:
      ObserveEvent

    • inputRequestEnd

      public ObserveEvent inputRequestEnd(ObsId obsId)
      This event indicates the end of a request to the user for input
      Parameters:
      obsId - ObsId Representing a unique observation id
      Returns:
      ObserveEvent