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.
issueCorrection¶
Description: Issue the wavefront correction to subsystems based on the most recent OFC outputs.
- EFDB_Topic
MTAOS_command_issueCorrection
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
- 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
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
- 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
- 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
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.
abort¶
- EFDB_Topic
SALGeneric_command_abort
disable¶
Description: Transition from state Enabled to Disabled.
- EFDB_Topic
SALGeneric_command_disable
enable¶
Description: Transition from state Disabled to Enabled.
- EFDB_Topic
SALGeneric_command_enable
enterControl¶
Description: Transition from state Offline to Standby. Only that start in Offline state CSCs support this command; other CSCs start in Standby state and quit when they go to Offline.
- EFDB_Topic
SALGeneric_command_enterControl
exitControl¶
Description: Transition from state Standby to Offline. For CSCs that start in Standby state this makes the CSC quit. CSCs that start in Offline state, they remain active.
- EFDB_Topic
SALGeneric_command_exitControl
setAuthList¶
- EFDB_Topic
SALGeneric_command_setAuthList
authorizedUsers¶
- IDL_Type
string
- Units
unitless
- Description: Comma seperated list of authorized users currently allowed to command this CSC,
in the form user@host. If the first character is +/- then the specified users are added/removed. Duplicates are silently ignored. The CSC’s own user@host is silently ignored, because it is always authorized. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.
nonAuthorizedCSCs¶
- IDL_Type
string
- Units
unitless
- Description: Comma seperated list of CSC’s not currently allowed to command this CSC,
in the form name[:index]. An index of 0 is stripped (name:0 becomes name). If the first character is +/- then the specified CSCs are added/removed. Duplicates are silently ignored. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.
setLogLevel¶
Description: Set the logging level.
- EFDB_Topic
SALGeneric_command_setLogLevel
level¶
- IDL_Type
int
- Units
unitless
Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.
setValue¶
- EFDB_Topic
SALGeneric_command_setValue
parametersAndValues¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: List of parameters and their values as a Json string
standby¶
Description: Transition from state Offline, Disabled or Fault to Standby.
- EFDB_Topic
SALGeneric_command_standby
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
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.
m2HexapodCorrection¶
Description: Correction to the M2 hexapod.
- EFDB_Topic
MTAOS_logevent_m2HexapodCorrection
ofcDuration¶
Description: Duration of time to calculate the degree of freedom.
- EFDB_Topic
MTAOS_logevent_ofcDuration
rejectedCameraHexapodCorrection¶
Description: Rejected correction to the camera hexapod.
- EFDB_Topic
MTAOS_logevent_rejectedCameraHexapodCorrection
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
rejectedM2Correction¶
Description: Rejected correction to M2.
- EFDB_Topic
MTAOS_logevent_rejectedM2Correction
rejectedM2HexapodCorrection¶
Description: Rejected correction to the M2 hexapod.
- EFDB_Topic
MTAOS_logevent_rejectedM2HexapodCorrection
rejectedWavefrontError¶
Description: Rejected wavefront error.
- EFDB_Topic
MTAOS_logevent_rejectedWavefrontError
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
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
appliedSettingsMatchStart¶
- EFDB_Topic
SALGeneric_logevent_appliedSettingsMatchStart
appliedSettingsMatchStartIsTrue¶
- IDL_Type
boolean
- Units
unitless
Description: True when the configuration matches the start conditions
authList¶
- EFDB_Topic
SALGeneric_logevent_authList
authorizedUsers¶
- IDL_Type
string
- Units
unitless
Description: Comma seperated list of authorized users currently allowed to command this CSC.
nonAuthorizedCSCs¶
- IDL_Type
string
- Units
unitless
Description: Comma seperated list of CSC’s not currently allowed to command this CSC.
errorCode¶
Description: Output when a CSC goes into the Fault state as an explanation of the problem.
- EFDB_Topic
SALGeneric_logevent_errorCode
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¶
- EFDB_Topic
SALGeneric_logevent_heartbeat
logLevel¶
Description: Current logging level.
- EFDB_Topic
SALGeneric_logevent_logLevel
level¶
- IDL_Type
int
- Units
unitless
Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.
logMessage¶
Description: A log message.
- EFDB_Topic
SALGeneric_logevent_logMessage
level¶
- IDL_Type
int
- Units
unitless
Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.
lineNumber¶
- IDL_Type
long
- Units
unitless
Description: Line number in the file specified by filePath.
settingVersions¶
Description: Information about settings which can be specified in the start command.
- EFDB_Topic
SALGeneric_logevent_settingVersions
recommendedSettingsVersion¶
- IDL_Type
string
- Units
unitless
Description: List of comma seperated recomended versions of settings sets
recommendedSettingsLabels¶
- IDL_Type
string
- Units
unitless
Description: List of comma seperated names of settings sets
settingsUrl¶
- IDL_Type
string
- Units
unitless
Description: The URL where the settings sets definitions can be found
settingsApplied¶
Description: Base settings applied.
- EFDB_Topic
SALGeneric_logevent_settingsApplied
settingsVersion¶
- IDL_Type
string
- IDL_Size
256
- Units
unitless
Description: The SHA or name corresponding to the published configuration
otherSettingsEvents¶
- IDL_Type
string
- Units
unitless
Description: A comma delimited list of other specific CSC configuration events. This may be blank if no other CSC specific events are necessary
simulationMode¶
Description: Current simulation mode.
- EFDB_Topic
SALGeneric_logevent_simulationMode
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
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: This is the top-level version of the 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 a CSC