MTAOS¶

Note

This page is generated by python script generate_cet.py.

Commands¶

addAberration¶

Description: Utility command to add aberration to the system based on user provided wavefront errors. The command assume uniform aberration on all sensors.

EFDB_Topic:: MTAOS_command_addAberration

wf¶

IDL_Type:: double
Units:: micron
Count:: 19

Description: Array with z4-z22 terms of wavefront errors. Indexes are considered to be ANSI (https://en.wikipedia.org/wiki/Zernike_polynomials#OSA/ANSI_standard_indices).

config¶

IDL_Type:: string
Units:: unitless

Description: Yaml configuration string with additional parameters to be passed to OFC. If options are invalid command will be rejected. If not given, use the standard configuration.

interruptWEP¶

Description: If there is a wep process running (initiated by the runWEP command) interrupt it, if not return immediately.

EFDB_Topic:: MTAOS_command_interruptWEP

issueCorrection¶

Description: Issue the wavefront correction to subsystems based on the most recent OFC outputs.

EFDB_Topic:: MTAOS_command_issueCorrection

offsetDOF¶

Description: Utility command to apply offsets to the degrees of freedom (DOF). Units will match that of the policy file in ts_ofc (lsst-ts/ts_ofc).

EFDB_Topic:: MTAOS_command_offsetDOF

value¶

IDL_Type:: double
Units:: unitless
Count:: 50

Description: Array with the offsets to be applied to the DOF.

preProcess¶

Description: Pre-process image for WEP. The outputs of this command are donut images that are ready for curvature wavefront sensing.

EFDB_Topic:: MTAOS_command_preProcess

visitId¶

IDL_Type:: long long
Units:: unitless

Description: Image visit id number. This is a unique identifier for each image and consists of the date of the observation plus an integer iterator, e.g. 2020103000040 for the 40th image taken in October, 30, 2020.

useOCPS¶

IDL_Type:: boolean
Units:: unitless

Description: Use the OCS-Controlled Pipeline System (OCPS) to process data remotely?

config¶

IDL_Type:: string
Units:: unitless

Description: Yaml configuration string with additional parameters to be passed to ISR and other pre-process tasks. If options are invalid command will be rejected. If not given, use the standard configuration.

rejectCorrection¶

Description: Reject the most recent wavefront correction.

EFDB_Topic:: MTAOS_command_rejectCorrection

resetCorrection¶

Description: Reset the current wavefront error correction. The aggregated degree of freedom in optical feedback control will be reset to the initial state.

EFDB_Topic:: MTAOS_command_resetCorrection

resetOffsetDOF¶

Description: Reset user applied offsets to the degrees of freedom (DOF).

EFDB_Topic:: MTAOS_command_resetOffsetDOF

runOFC¶

Description: Run OFC on the latest wavefront errors data. Before running this command, you must have ran runWEP at least once. This command will run ofc to compute correction but won’t apply them. Use issueCorrection to apply the corrections. This allow users to evaluate whether the corrections are sensible before applying them.

EFDB_Topic:: MTAOS_command_runOFC

userGain¶

IDL_Type:: float
Units:: unitless

Description: Gain value between 0 and 1. Set to -1 to ignore user gain.

config¶

IDL_Type:: string
Units:: unitless

Description: Yaml configuration string with additional parameters to be passed to OFC. If options are invalid command will be rejected. If not given, use the standard configuration.

runWEP¶

Description: Process wavefront data, either full focal plane mode (Comcam and LSSTCam) or wavefront sensors. If only visitId is provided it assumes wavefront sensor mode. If visitId and extraId is provided it assumes full focal plane mode. MTAOS will determine if it is ComCam or LSSTCam based on the input images. If useOCPS=True, processing is done remotely using the OCPS CSC. For LSSTCam full array mode only OCPS processing is supported. Before running this command it is advisable to run selectSources and preProcess commands on the input image(s), otherwise MTAOS will have to run those processes before running wep.

EFDB_Topic:: MTAOS_command_runWEP

visitId¶

IDL_Type:: long long
Units:: unitless

Description: Image visit id number. This is a unique identifier for each image and consists of the date of the observation plus an integer iterator, e.g. 2020103000040 for the 40th image taken in October, 30, 2020.

extraId¶

IDL_Type:: long long
Units:: unitless

Description: Extra focal image visit id number (optional). Same as visitId, if different than zero, the command assumes this is an Intra/Focal sequence, otherwise it assumes Corner Wavefront Sensor.

useOCPS¶

IDL_Type:: boolean
Units:: unitless

Description: Use OCS-Controlled Pipeline System (OCPS) to process data remotely? Ideally this should match the value of a previous preProcess command. If runWEP and preProcess run with different useOCPS setups, runWEP will run normally but will take longer as it will have to repeat the steps of preProcess. A warning message will inform the users of these conditions.

config¶

IDL_Type:: string
Units:: unitless

Description: Yaml configuration string with additional parameters to be passed to WEP process. If options are invalid command will be rejected. If not given, use the standard configuration.

selectSources¶

Description: Run source selection algorithm for a specific field and visit configuration.

EFDB_Topic:: MTAOS_command_selectSources

ra¶

IDL_Type:: float
Units:: hourangle

Description: Right Ascension of the field in ICRS coordinates.

decl¶

IDL_Type:: float
Units:: degree

Description: Declination of the field in ICRS coordinates.

pa¶

IDL_Type:: float
Units:: degree

Description: Sky position angle of the observation. As defined by the IAU, this the angle measured relative to the north celestial pole (NCP), turning positive into the direction of the right ascension.

filter¶

IDL_Type:: long
Units:: unitless

Description: Enumeration with the filter used in the observation.

mode¶

IDL_Type:: long
Units:: unitless

Description: Enumeration specifying the wfs mode.

disable¶

Description: Transition from state Enabled to Disabled.

EFDB_Topic:: SALGeneric_command_disable
Category:: csc

enable¶

Description: Transition from state Disabled to Enabled.

EFDB_Topic:: SALGeneric_command_enable
Category:: csc

exitControl¶

Description: Transition from state Standby to Offline. Most CSCs will quit, but CSCs that support the enterControl command will keep running.

EFDB_Topic:: SALGeneric_command_exitControl
Category:: csc

setLogLevel¶

Description: Set the logging level.

EFDB_Topic:: SALGeneric_command_setLogLevel
Category:: csc

level¶

IDL_Type:: int
Units:: unitless

Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem¶

IDL_Type:: string
Units:: unitless

Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.

standby¶

Description: Transition from state Offline/Available, Disabled or Fault to Standby.

EFDB_Topic:: SALGeneric_command_standby
Category:: csc

start¶

Description: Transition from state Standby to Disable, in a specified configuration.

EFDB_Topic:: SALGeneric_command_start
Category:: csc

configurationOverride¶

IDL_Type:: string
Units:: unitless

Description:

Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:

“foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.
“:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.
“bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.

Enumerations¶

FilterType:

u
g
r
i
z
y
ref

Mode:

LsstCamFAM
LsstCamCWS
ComCam

Events¶

cameraHexapodCorrection¶

Description: Correction to the camera hexapod.

EFDB_Topic:: MTAOS_logevent_cameraHexapodCorrection

x¶

IDL_Type:: double
Units:: micron

Description: X position offset.

y¶

IDL_Type:: double
Units:: micron

Description: Y position offset.

z¶

IDL_Type:: double
Units:: micron

Description: Z position offset.

u¶

IDL_Type:: double
Units:: degree

Description: X rotation offset.

v¶

IDL_Type:: double
Units:: degree

Description: Y rotation offset.

w¶

IDL_Type:: double
Units:: degree

Description: Z rotation offset.

degreeOfFreedom¶

Description: Calculated degree of freedom.

EFDB_Topic:: MTAOS_logevent_degreeOfFreedom

aggregatedDoF¶

IDL_Type:: double
Units:: micron
Count:: 50

Description: Aggregated degree of freedom in the control algorithm. The unit of angle-related elements is arcsec instead of micron.

visitDoF¶

IDL_Type:: double
Units:: micron
Count:: 50

Description: Calculated degree of freedom in the last visit. The unit of angle-related elements is arcsec instead of micron.

userDoF¶

IDL_Type:: double
Units:: micron
Count:: 50

Description: User applied offsets.

m1m3Correction¶

Description: Correction to M1M3.

EFDB_Topic:: MTAOS_logevent_m1m3Correction

zForces¶

IDL_Type:: float
Units:: newton
Count:: 156

Description: Actuator force in z direction.

m2Correction¶

Description: Correction to M2.

EFDB_Topic:: MTAOS_logevent_m2Correction

zForces¶

IDL_Type:: float
Units:: newton
Count:: 72

Description: Actuator force in z direction.

m2HexapodCorrection¶

Description: Correction to the M2 hexapod.

EFDB_Topic:: MTAOS_logevent_m2HexapodCorrection

x¶

IDL_Type:: double
Units:: micron

Description: X position offset.

y¶

IDL_Type:: double
Units:: micron

Description: Y position offset.

z¶

IDL_Type:: double
Units:: micron

Description: Z position offset.

u¶

IDL_Type:: double
Units:: degree

Description: X rotation offset.

v¶

IDL_Type:: double
Units:: degree

Description: Y rotation offset.

w¶

IDL_Type:: double
Units:: degree

Description: Z rotation offset.

ofcDuration¶

Description: Duration of time to calculate the degree of freedom.

EFDB_Topic:: MTAOS_logevent_ofcDuration

calcTime¶

IDL_Type:: float
Units:: second

Description: Latest execution time.

rejectedCameraHexapodCorrection¶

Description: Rejected correction to the camera hexapod.

EFDB_Topic:: MTAOS_logevent_rejectedCameraHexapodCorrection

x¶

IDL_Type:: double
Units:: micron

Description: X position offset.

y¶

IDL_Type:: double
Units:: micron

Description: Y position offset.

z¶

IDL_Type:: double
Units:: micron

Description: Z position offset.

u¶

IDL_Type:: double
Units:: degree

Description: X rotation offset.

v¶

IDL_Type:: double
Units:: degree

Description: Y rotation offset.

w¶

IDL_Type:: double
Units:: degree

Description: Z rotation offset.

rejectedDegreeOfFreedom¶

Description: Rejected degree of freedom.

EFDB_Topic:: MTAOS_logevent_rejectedDegreeOfFreedom

aggregatedDoF¶

IDL_Type:: double
Units:: micron
Count:: 50

Description: Aggregated degree of freedom in the control algorithm. The unit of angle-related elements is arcsec instead of micron.

visitDoF¶

IDL_Type:: double
Units:: micron
Count:: 50

Description: Calculated degree of freedom in the last visit. The unit of angle-related elements is arcsec instead of micron.

rejectedM1M3Correction¶

Description: Rejected correction to M1M3.

EFDB_Topic:: MTAOS_logevent_rejectedM1M3Correction

zForces¶

IDL_Type:: float
Units:: newton
Count:: 156

Description: Actuator force in z direction.

rejectedM2Correction¶

Description: Rejected correction to M2.

EFDB_Topic:: MTAOS_logevent_rejectedM2Correction

zForces¶

IDL_Type:: float
Units:: newton
Count:: 72

Description: Actuator force in z direction.

rejectedM2HexapodCorrection¶

Description: Rejected correction to the M2 hexapod.

EFDB_Topic:: MTAOS_logevent_rejectedM2HexapodCorrection

x¶

IDL_Type:: double
Units:: micron

Description: X position offset.

y¶

IDL_Type:: double
Units:: micron

Description: Y position offset.

z¶

IDL_Type:: double
Units:: micron

Description: Z position offset.

u¶

IDL_Type:: double
Units:: degree

Description: X rotation offset.

v¶

IDL_Type:: double
Units:: degree

Description: Y rotation offset.

w¶

IDL_Type:: double
Units:: degree

Description: Z rotation offset.

rejectedWavefrontError¶

Description: Rejected wavefront error.

EFDB_Topic:: MTAOS_logevent_rejectedWavefrontError

sensorId¶

IDL_Type:: short
Units:: unitless

Description: Wavefront sensor ID.

annularZernikeCoeff¶

IDL_Type:: double
Units:: micron
Count:: 19

Description: z4-z22 terms of annular Zernike polynomials.

wavefrontError¶

Description: Calculated wavefront error.

EFDB_Topic:: MTAOS_logevent_wavefrontError

sensorId¶

IDL_Type:: short
Units:: unitless

Description: Wavefront sensor ID.

annularZernikeCoeff¶

IDL_Type:: double
Units:: micron
Count:: 19

Description: z4-z22 terms of annular Zernike polynomials.

wepDuration¶

Description: Duration of time to process the wavefront image data.

EFDB_Topic:: MTAOS_logevent_wepDuration

calcTime¶

IDL_Type:: float
Units:: second

Description: Latest execution time.

configurationApplied¶

Description: Information about this CSC’s current configuration overrides.

EFDB_Topic:: SALGeneric_logevent_configurationApplied
Category:: configurable

configurations¶

IDL_Type:: string
Units:: unitless

Description: A comma-separated list of configurations applied. If configuration comes from a clone of a git repo, or similar directory, then it will be a list of file names, without the file extension. Ignore whitespace after commas.

version¶

IDL_Type:: string
Units:: unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url¶

IDL_Type:: string
Units:: unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL. This should always match the same-named field in configurationsAvailable.

schemaVersion¶

IDL_Type:: string
Units:: unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”. This should always match the same-named field in configurationsAvailable.

otherInfo¶

IDL_Type:: string
Units:: unitless

Description: A comma-separated list of event topics (without the logevent prefix) used to publish the entire set of configuration parameters loaded by this CSC, and any other pertinent information. Ignore whitespace after commas.

configurationsAvailable¶

Description: Available configuration overrides for this CSC.

EFDB_Topic:: SALGeneric_logevent_configurationsAvailable
Category:: configurable

overrides¶

IDL_Type:: string
Units:: unitless

Description: Available overrides as a comma-separated list. Each entry is a possible value of the configurationOverride field of the start command. Ignore whitespace after commas.

version¶

IDL_Type:: string
Units:: unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url¶

IDL_Type:: string
Units:: unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL.

schemaVersion¶

IDL_Type:: string
Units:: unitless

Description: Version of config schema used by this CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”.

errorCode¶

Description: Output when this CSC goes into the Fault state as an explanation of the problem.

EFDB_Topic:: SALGeneric_logevent_errorCode
Category:: csc

errorCode¶

IDL_Type:: long
Units:: unitless

Description: A numeric error code.

errorReport¶

IDL_Type:: string
Units:: unitless

Description: An string providing detailed information about the error.

traceback¶

IDL_Type:: string
Units:: unitless

Description: An optional stack trace of the error condition.

heartbeat¶

Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.

EFDB_Topic:: SALGeneric_logevent_heartbeat
Category:: mandatory

heartbeat¶

IDL_Type:: boolean
Units:: unitless

Description: Deprecated field that you should ignore.

logLevel¶

Description: Current logging level.

EFDB_Topic:: SALGeneric_logevent_logLevel
Category:: mandatory

level¶

IDL_Type:: int
Units:: unitless

Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem¶

IDL_Type:: string
Units:: unitless

Description: If this CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to this CSC itself.

logMessage¶

Description: A log message.

EFDB_Topic:: SALGeneric_logevent_logMessage
Category:: mandatory

name¶

IDL_Type:: string
Units:: unitless

Description: Log name.

level¶

IDL_Type:: int
Units:: unitless

Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.

message¶

IDL_Type:: string
Units:: unitless

Description: Log message.

traceback¶

IDL_Type:: string
Units:: unitless

Description: Exception traceback; “” if not an exception.

filePath¶

IDL_Type:: string
Units:: unitless

Description: Path to source file.

functionName¶

IDL_Type:: string
Units:: unitless

Description: Function or method name.

lineNumber¶

IDL_Type:: long
Units:: unitless

Description: Line number in the file specified by filePath.

process¶

IDL_Type:: long
Units:: unitless

Description: Process ID.

timestamp¶

IDL_Type:: double
Units:: second

Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.

simulationMode¶

Description: Current simulation mode.

EFDB_Topic:: SALGeneric_logevent_simulationMode
Category:: csc

mode¶

IDL_Type:: int
Units:: unitless

Description: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC.

softwareVersions¶

Description: Current versions of software in use by CSC.

EFDB_Topic:: SALGeneric_logevent_softwareVersions
Category:: mandatory

salVersion¶

IDL_Type:: string
IDL_Size:: 256
Units:: unitless

Description: This is the current version of SAL generation.

xmlVersion¶

IDL_Type:: string
IDL_Size:: 256
Units:: unitless

Description: This is the current version of CSC XML.

openSpliceVersion¶

IDL_Type:: string
IDL_Size:: 256
Units:: unitless

Description: This is the current version of OpenSplice.

cscVersion¶

IDL_Type:: string
IDL_Size:: 256
Units:: unitless

Description: The software version of this CSC.

subsystemVersions¶

IDL_Type:: string
Units:: unitless

Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within this CSC.

summaryState¶

Description: Current summary state of this CSC.

EFDB_Topic:: SALGeneric_logevent_summaryState
Category:: csc

summaryState¶

IDL_Type:: long
Units:: unitless

Description: High level state machine state identifier.

Telemetry¶

m1m3BendingModes¶

Description: Measured M1M3 bending modes values.

EFDB_Topic:: MTAOS_m1m3BendingModes

value¶

IDL_Type:: double
Units:: micron
Count:: 20

Description: Amplitude of the measured bending mode.

m2BendingModes¶

Description: Measured M2 bending modes values.

EFDB_Topic:: MTAOS_m2BendingModes

value¶

IDL_Type:: double
Units:: micron
Count:: 20

Description: Amplitude of the measured bending mode.