Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package params

    This project is intended to hold reusable models and params used throughout the csw source code.

    Params

    This project is intended to hold reusable models and params used throughout the csw source code.

    This also provides out of the box support to cater to the diverse communication requirements. Consumer of this library will be able to create Commands, Events, States to store ParameterSets.

    Imp Packages

    Commands and Events

    This packages contains classes, traits and models used to create *commands* and *events*. These are all based on type-safe keys and items (a set of values with optional units). Each key has a specific type and the key's values must be of that type.

    Two types of csw.params.commands.Command are supported:

    Following are the concrete commands supported by csw:

    Two types of csw.params.events.Event are supported:

    core

    This package supports serialization and deserialization of commands, events and state variables in JSON format csw.params.core.formats.JsonSupport.

    Scala and Java APIs

    All the param and event classes are immutable. The set methods return a new instance of the object with a new item added and the get methods return an Option, in case the Key is not found. There are also value methods that return a value directly, throwing an exception if the key or value is not found.

    Key Types

    A set of standard key types and matching items are defined. Each key accepts one or more values of the given type.

    Following csw.params.core.generics.KeyType are supported by csw:

    +--------------+-------------------------+---------------------------+
|  Primitive   |      Scala KeyType      |       Java KeyType        |
+--------------+-------------------------+---------------------------+
| Boolean      | KeyType.BooleanKey      | JKeyType.BooleanKey      |
| Character    | KeyType.CharKey         | JKeyType.JCharKey        |
| Byte         | KeyType.ByteKey         | JKeyType.ByteKey         |
| Short        | KeyType.ShortKey        | JKeyType.ShortKey        |
| Long         | KeyType.LongKey         | JKeyType.LongKey         |
| Int          | KeyType.IntKey          | JKeyType.IntKey          |
| Float        | KeyType.FloatKey        | JKeyType.FloatKey        |
| Double       | KeyType.DoubleKey       | JKeyType.DoubleKey       |
| String       | KeyType.StringKey       | JKeyType.StringKey       |
| UtcTime      | KeyType.UTCTimeKey      | JKeyType.UTCTimeKey      |
| TaiTime      | KeyType.TAITimeKey      | JKeyType.TAITimeKey      |
| ----------   | ----------              | ----------               |
| ByteArray    | KeyType.ByteArrayKey    | JKeyType.ByteArrayKey    |
| ShortArray   | KeyType.ShortArrayKey   | JKeyType.ShortArrayKey   |
| LongArray    | KeyType.LongArrayKey    | JKeyType.LongArrayKey    |
| IntArray     | KeyType.IntArrayKey     | JKeyType.IntArrayKey     |
| FloatArray   | KeyType.FloatArrayKey   | JKeyType.FloatArrayKey   |
| DoubleArray  | KeyType.DoubleArrayKey  | JKeyType.DoubleArrayKey  |
| ----------   | ----------              | ----------               |
| ByteMatrix   | KeyType.ByteMatrixKey   | JKeyType.ByteMatrixKey   |
| ShortMatrix  | KeyType.ShortMatrixKey  | JKeyType.ShortMatrixKey  |
| LongMatrix   | KeyType.LongMatrixKey   | JKeyType.LongMatrixKey   |
| IntMatrix    | KeyType.IntMatrixKey    | JKeyType.IntMatrixKey    |
| FloatMatrix  | KeyType.FloatMatrixKey  | JKeyType.FloatMatrixKey  |
| DoubleMatrix | KeyType.DoubleMatrixKey | JKeyType.DoubleMatrixKey |
| ----------   | ----------              | ----------               |
| Choice       | KeyType.ChoiceKey       | JKeyType.ChoiceKey       |
+--------------+-------------------------+---------------------------+

    Detailed information about creating Keys and Parameters can be found here: https://tmtsoftware.github.io/csw/services/messages/keys-parameters.html

    Detailed information about creating commands can be found here: https://tmtsoftware.github.io/csw/services/messages/commands.html

    Detailed information about creating events can be found here: https://tmtsoftware.github.io/csw/services/messages/events.html

    Definition Classes
    csw
  • package events
    Definition Classes
    params
  • CoordinateSystem
  • DMSObserveEvent
  • Event
  • EventKey
  • EventName
  • IRDetectorEvent
  • ObserveEvent
  • ObserveEventKeys
  • ObserveEventNames
  • OperationalState
  • OpticalDetectorEvent
  • ParamFactories
  • SequencerObserveEvent
  • SystemEvent
  • WFSDetectorEvent
o

csw.params.events

OpticalDetectorEvent

object OpticalDetectorEvent extends DetectorEvent

The optical science detector system Observe Events

Linear Supertypes
DetectorEvent, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpticalDetectorEvent
  2. DetectorEvent
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def dataWriteEnd(sourcePrefix: Prefix, 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.

    sourcePrefix

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

    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.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  7. def dataWriteStart(sourcePrefix: Prefix, 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.

    sourcePrefix

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

    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.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def exposureAborted(sourcePrefix: Prefix, exposureId: ExposureId): ObserveEvent

    This event indicates that a request was made to abort the exposure and it has completed.

    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

    sourcePrefix

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

    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.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  11. def exposureData(sourcePrefix: Prefix, exposureId: ExposureId, coaddsInExposure: Int, coaddsDone: Int, exposureTime: Long, remainingExposureTime: Long): ObserveEvent

    This event contains faster changing data about the internals of the current exposure.

    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.

    sourcePrefix

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

    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.

    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

    csw.params.events.ObserveEvent]

  12. def exposureEnd(sourcePrefix: Prefix, exposureId: ExposureId): ObserveEvent

    This event indicates the end of data acquisition that results in a file produced 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.

    sourcePrefix

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

    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.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  13. def exposureStart(sourcePrefix: Prefix, exposureId: ExposureId): ObserveEvent

    This event indicates the start of data acquisition that results in a file produced 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.

    sourcePrefix

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

    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.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  14. def exposureState(sourcePrefix: Prefix, exposureId: ExposureId, exposureInProgress: Boolean, abortInProgress: Boolean, isAborted: Boolean, errorMessage: String, operationalState: OperationalState): ObserveEvent

    A state variable to indicate the current state of the detector system.

    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.

    sourcePrefix

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

    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)

    abortInProgress

    java.lang.Boolean indicates that an abort has been requested and is underway.

    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

    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

    operationalState

    csw.params.events.OperationalState indicating if the detector system is available and operational.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. def observeEnd(sourcePrefix: Prefix): 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.

    sourcePrefix

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

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  22. def observeEnd(sourcePrefix: Prefix, obsId: ObsId): 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.

    sourcePrefix

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

    obsId

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

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  23. def observeStart(sourcePrefix: Prefix): 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.

    sourcePrefix

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

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  24. def observeStart(sourcePrefix: Prefix, obsId: ObsId): 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.

    sourcePrefix

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

    obsId

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

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  25. def prepareStart(sourcePrefix: Prefix, exposureId: ExposureId): ObserveEvent
  26. def readoutEnd(sourcePrefix: Prefix, 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.

    sourcePrefix

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

    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.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  27. def readoutFailed(sourcePrefix: Prefix, exposureId: ExposureId): 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.

    sourcePrefix

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

    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.

    returns

    csw.params.events.ObserveEvent

    Definition Classes
    DetectorEvent
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from DetectorEvent

Inherited from AnyRef

Inherited from Any

Ungrouped