Package csw.params.events

Class OpticalDetectorEvent$

java.lang.Object

csw.params.events.DetectorEvent

csw.params.events.OpticalDetectorEvent$

public class OpticalDetectorEvent$
extends DetectorEvent

The optical science detector system Observe Events

Field Summary

Fields

Modifier and Type	Field	Description
static final OpticalDetectorEvent$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
OpticalDetectorEvent$()

Method Summary

Modifier and Type	Method	Description
ObserveEvent	exposureData(Prefix sourcePrefix, ExposureId exposureId, int coaddsInExposure, int coaddsDone, long exposureTime, long remainingExposureTime)	This event contains faster changing data about the internals of the current exposure.
ObserveEvent	prepareStart(Prefix sourcePrefix, ExposureId exposureId)

Methods inherited from class csw.params.events.DetectorEvent

create, create, dataWriteEnd, dataWriteStart, exposureAborted, exposureEnd, exposureStart, exposureState, observeEnd, observeEnd, observeStart, observeStart, readoutEnd, readoutFailed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE$

public static final OpticalDetectorEvent$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

OpticalDetectorEvent$

public OpticalDetectorEvent$()

Method Details

prepareStart

public ObserveEvent prepareStart(Prefix sourcePrefix,
 ExposureId exposureId)

exposureData

public ObserveEvent exposureData(Prefix sourcePrefix,
 ExposureId exposureId,
 int coaddsInExposure,
 int coaddsDone,
 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.

coaddsInExposure - The integer total number of coadds in the current exposure. Value should be constant during an exposure

coaddsDone - Integer number of completed coadds from 1 to coaddsInExposure. 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]