OpticalDetectorEvent
The optical science detector system Observe Events
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
OpticalDetectorEvent.type
Members list
Value members
Concrete methods
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.
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.
Value parameters
- coaddsDone
-
Integer number of completed coadds from 1 to coaddsInExposure. Should be reset to 0 at the start of every exposure.
- coaddsInExposure
-
The integer total number of coadds in the current exposure. Value should be constant during an exposure
- 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.
- 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
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
Inherited methods
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.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
A state variable to indicate the current state of the detector system. The Exposure State Event groups parameters that change relatively slowly, and this event should be published whenever any of its parameters changes.
A state variable to indicate the current state of the detector system. The Exposure State Event groups parameters that change relatively slowly, and this event should be published whenever any of its parameters changes.
Value parameters
- abortInProgress
-
java.lang.Boolean indicates that an abort has been requested and is underway.
- errorMessage
-
java.lang.String An parameter that can be included when the detector system is in the ERROR operationalState. This value should be cleared and removed from the state when the operationalState returns to READY
- 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.
- exposureInProgress
-
java.lang.Boolean indicating if detector system is acquiring an exposure. Delimited by exposureStart and exposureEnd. exposureInProgress should be false if abortInProgress is true (TBD)
- isAborted
-
java.lang.Boolean Indicates that an abort has occurred and is completed. abortInProgress should be false when isAborted is true. isAborted should be set to false with the next exposure
- operationalState
-
csw.params.events.OperationalState indicating if the detector system is available and operational.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)
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.
- sourcePrefix
-
csw.prefix.models.Prefix the prefix identifier of the source which is generating this event.
Attributes
- Returns
- Inherited from:
- DetectorEvent (hidden)