SequencerObserveEvent

csw.params.events.SequencerObserveEvent
case class SequencerObserveEvent(prefix: Prefix)

The events that indicate activities for each observation and the acquisition process.

Value parameters

prefix

csw.prefix.models.Prefix the prefix identifier of the sequencer which is generating this event.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def dataWriteEnd(exposureId: ExposureId, filename: String): ObserveEvent

This event indicates that the instrument has finished writing the exposure data file or transfer of exposure data to DMS.

This event indicates that the instrument has finished writing the exposure data file or transfer of exposure data to DMS.

Value parameters

exposureId

csw.params.core.models.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

java.lang.String the path of the file.

Attributes

Returns

csw.params.events.ObserveEvent

def dataWriteStart(exposureId: ExposureId, filename: String): ObserveEvent

This event indicates that the instrument has started writing the exposure data file or transfer of exposure data to DMS.

This event indicates that the instrument has started writing the exposure data file or transfer of exposure data to DMS.

Value parameters

exposureId

csw.params.core.models.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

java.lang.String the path of the file.

Attributes

Returns

csw.params.events.ObserveEvent

def downtimeStart(obsId: ObsId, reasonForDowntime: String): ObserveEvent

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.

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.

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

reasonForDowntime

java.lang.String a hint that indicates the cause of the downtime for statistics.

Attributes

Returns

csw.params.events.ObserveEvent

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

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

Value parameters

exposureId

csw.params.core.models.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.

Attributes

Returns

csw.params.events.ObserveEvent

def exposureEnd(exposureId: ExposureId): ObserveEvent

This event indicates the end of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.

This event indicates the end of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.

Value parameters

exposureId

csw.params.core.models.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.

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the start of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.

This event indicates the start of data acquisition that results in a file produced for DMS. This is a potential metadata event for DMS.

Value parameters

exposureId

csw.params.core.models.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.

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the end of locking the telescope to the sky with guide and WFS targets

This event indicates the end of locking the telescope to the sky with guide and WFS targets

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the start of locking the telescope to the sky with guide and WFS targets

This event indicates the start of locking the telescope to the sky with guide and WFS targets

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the end of a request to the user for input

This event indicates the end of a request to the user for input

Value parameters

obsId

csw.params.core.models.ObsId Representing a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the start of a request to the user for input

This event indicates the start of a request to the user for input

Value parameters

obsId

csw.params.core.models.ObsId Representing a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the end of execution of actions related to an observation including acquisition and science data acquisition.

This event indicates the end of execution of actions related to an observation including acquisition and science data acquisition.

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the start of execution of actions related to an observation including acquisition and science data acquisition.

This event indicates the start of execution of actions related to an observation including acquisition and science data acquisition.

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the end of execution of actions related to an Observe command

This event indicates the end of execution of actions related to an Observe command

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates that a user has paused the current observation Sequence which will happen after the current step concludes

This event indicates that a user has paused the current observation Sequence which will happen after the current step concludes

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates that a user has resumed a paused observation Sequence.

This event indicates that a user has resumed a paused observation Sequence.

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the start of execution of actions related to an Observe command

This event indicates the start of execution of actions related to an Observe command

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the end of a telescope offset or dither

This event indicates the end of a telescope offset or dither

Value parameters

obsId

csw.params.core.models.ObsId representing a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

def offsetStart(obsId: ObsId, coordinateSystem: CoordinateSystem, p: Double, q: Double): ObserveEvent

This event indicates the start of a telescope offset or dither

This event indicates the start of a telescope offset or dither

Value parameters

coordinateSystem

CoordinateSystem Represents coordinate system

obsId

csw.params.core.models.ObsId representing a unique observation id

p

java.lang.Double Represents telescope's xCoordinate offset

q

java.lang.Double Represents telescope's yCoordinate offset

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates that the detector system is preparing to start an exposure.

This event indicates that the detector system is preparing to start an exposure.

Value parameters

exposureId

csw.params.core.models.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.

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the end of the preset phase of acquisition

This event indicates the end of the preset phase of acquisition

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the start of the preset phase of acquisition

This event indicates the start of the preset phase of acquisition

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

def readoutEnd(exposureId: ExposureId): ObserveEvent

This event indicates that a readout that is part of a ramp has completed.

This event indicates that a readout that is part of a ramp has completed.

Value parameters

exposureId

csw.params.core.models.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.

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates that a readout that is part of a ramp has failed indicating transfer failure or some other issue.

This event indicates that a readout that is part of a ramp has failed indicating transfer failure or some other issue.

Value parameters

exposureId

csw.params.core.models.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.

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the end of acquisition phase where science target is centered as needed after guidestar locking

This event indicates the end of acquisition phase where science target is centered as needed after guidestar locking

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

This event indicates the start of acquisition phase where science target is peaked up as needed after guidestar locking

This event indicates the start of acquisition phase where science target is peaked up as needed after guidestar locking

Value parameters

obsId

csw.params.core.models.ObsId Represents a unique observation id

Attributes

Returns

csw.params.events.ObserveEvent

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product