MTAOS¶

Note

This page is generated by the following python script generate_cet.py.

Commands¶

issueWavefrontCorrection¶

Description: Issue the wavefront correction to subsystems based on the most recently measured wavefront error.

EFDB_Topic:	MTAOS_command_issueWavefrontCorrection

value¶

IDL_Type:	boolean
Units:	unitless

Description: This value is ignored.

processCalibrationProducts¶

Description: Process new calibration products.

EFDB_Topic:	MTAOS_command_processCalibrationProducts

directoryPath¶

IDL_Type:	string
Units:	unitless

Description: Absolute directory path to calibration products.

processCmosWavefrontError¶

Description: Process the wavefront data collection by CMOS camera.

EFDB_Topic:	MTAOS_command_processCmosWavefrontError

intraImgPath¶

IDL_Type:	string
Units:	unitless

Description: Absolute path to intra-focal wavefront image FITS file.

extraImgPath¶

IDL_Type:	string
Units:	unitless

Description: Absolute path to extra-focal wavefront image FITS file.

sglBrightStarPixelX¶

IDL_Type:	double
Units:	unitless
Count:	10

Description: Single bright star pixel x position. Put -99999 for the empty star.

sglBrightStarPixelY¶

IDL_Type:	double
Units:	unitless
Count:	10

Description: Single bright star pixel y position. Put -99999 for the empty star.

filter¶

IDL_Type:	int
Units:	unitless

Description: Active filter type. Use 1-6 for u, g, r, i, z, and y. Use 7 for reference.

cameraRotation¶

IDL_Type:	double
Units:	degree

Description: Camera rotation angle.

userGain¶

IDL_Type:	double
Units:	unitless

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

processIntraExtraWavefrontError¶

Description: Process the wavefront data collection by camera piston.

EFDB_Topic:	MTAOS_command_processIntraExtraWavefrontError

intraVisit¶

IDL_Type:	int
Units:	unitless

Description: Intra-focal image visit number.

extraVisit¶

IDL_Type:	int
Units:	unitless

Description: Extra-focal image visit number.

intraDirectoryPath¶

IDL_Type:	string
Units:	unitless

Description: Absolute directory path to intra-focal wavefront data collection.

extraDirectoryPath¶

IDL_Type:	string
Units:	unitless

Description: Absolute directory path to extra-focal wavefront data collection.

fieldRA¶

IDL_Type:	double
Units:	degree

Description: Right ascension of telescope boresight.

fieldDEC¶

IDL_Type:	double
Units:	degree

Description: Declination of telescope boresight.

filter¶

IDL_Type:	int
Units:	unitless

Description: Active filter type. Use 1-6 for u, g, r, i, z, and y. Use 7 for reference.

cameraRotation¶

IDL_Type:	double
Units:	degree

Description: Camera rotation angle.

userGain¶

IDL_Type:	double
Units:	unitless

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

processShWavefrontError¶

Description: Process the wavefront error by Shack-Hartmann wavefront sensor.

EFDB_Topic:	MTAOS_command_processShWavefrontError

annularZernikePoly¶

IDL_Type:	double
Units:	micron
Count:	19

Description: z4-z22 terms of annular Zernike polynomials.

cameraRotation¶

IDL_Type:	double
Units:	degree

Description: Camera rotation angle.

userGain¶

IDL_Type:	double
Units:	unitless

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

processWavefrontError¶

Description: Process the wavefront data collection at corner splitted sensors.

EFDB_Topic:	MTAOS_command_processWavefrontError

visit¶

IDL_Type:	int
Units:	unitless

Description: Image visit number.

directoryPath¶

IDL_Type:	string
Units:	unitless

Description: Absolute directory path to wavefront data collection.

fieldRA¶

IDL_Type:	double
Units:	degree

Description: Right ascension of telescope boresight.

fieldDEC¶

IDL_Type:	double
Units:	degree

Description: Declination of telescope boresight.

filter¶

IDL_Type:	int
Units:	unitless

Description: Active filter type. Use 1-6 for u, g, r, i, z, and y. Use 7 for reference.

cameraRotation¶

IDL_Type:	double
Units:	degree

Description: Camera rotation angle.

userGain¶

IDL_Type:	double
Units:	unitless

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

resetWavefrontCorrection¶

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_resetWavefrontCorrection

value¶

IDL_Type:	boolean
Units:	unitless

Description: This value is ignored.

abort¶

EFDB_Topic:	SALGeneric_command_abort

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

disable¶

Description: Transition from state Enabled to Disabled.

EFDB_Topic:	SALGeneric_command_disable

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

enable¶

Description: Transition from state Disabled to Enabled.

EFDB_Topic:	SALGeneric_command_enable

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

enterControl¶

Description: Transition from state Offline to Standby. Only “externally commandable” CSCs support this command; other CSCs start in Standby state and quit when they go to Offline.

EFDB_Topic:	SALGeneric_command_enterControl

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

exitControl¶

Description: Transition from state Standby to Offline. For CSCs that are not “externally commandable” this makes the CSC quit.

EFDB_Topic:	SALGeneric_command_exitControl

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

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

value¶

IDL_Type:	boolean
Units:	unitless

Description: Not used

start¶

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

EFDB_Topic:	SALGeneric_command_start

settingsToApply¶

IDL_Type:	string
IDL_Size:	256
Units:	unitless

Description: Name of the selected settings set

Enumerations¶

SummaryState:	DisabledState EnabledState FaultState OfflineState StandbyState
WEPWarning:	NoWarning InvalidSensorId InvalidAnnularZernikePoly
OFCWarning:	NoWarning NoEnoughAnnularZernikePoly

Events¶

cameraHexapodCorrection¶

Description: Correction to the camera hexapod.

EFDB_Topic:	MTAOS_logevent_cameraHexapodCorrection

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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.

m1m3Correction¶

Description: Correction to M1M3.

EFDB_Topic:	MTAOS_logevent_m1m3Correction

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

zForces¶

IDL_Type:	float
Units:	newton
Count:	156

Description: Actuator force in z direction.

m2Correction¶

Description: Correction to M2.

EFDB_Topic:	MTAOS_logevent_m2Correction

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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.

ofcWarning¶

Description: Warning of optical feedback control.

EFDB_Topic:	MTAOS_logevent_ofcWarning

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

warning¶

IDL_Type:	int
Units:	unitless

Description: Specific warning type.

rejectedCameraHexapodCorrection¶

Description: Rejected correction to the camera hexapod.

EFDB_Topic:	MTAOS_logevent_rejectedCameraHexapodCorrection

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

sensorId¶

IDL_Type:	short
Units:	unitless

Description: Wavefront sensor ID.

annularZernikePoly¶

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

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

sensorId¶

IDL_Type:	short
Units:	unitless

Description: Wavefront sensor ID.

annularZernikePoly¶

IDL_Type:	double
Units:	micron
Count:	19

Description: z4-z22 terms of annular Zernike polynomials.

wepWarning¶

Description: Warning of wavefront estimation pipeline.

EFDB_Topic:	MTAOS_logevent_wepWarning

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

warning¶

IDL_Type:	int
Units:	unitless

Description: Specific warning type.

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

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¶

EFDB_Topic:	SALGeneric_logevent_heartbeat

heartbeat¶

IDL_Type:	boolean
Units:	unitless

Description: Beats the drum.

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

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.

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:	16
Units:	unitless

Description: This is the current version of SAL generation

xmlVersion¶

IDL_Type:	string
IDL_Size:	16
Units:	unitless

Description: This is the current version of CSC XML

openSpliceVersion¶

IDL_Type:	string
IDL_Size:	16
Units:	unitless

Description: This is the current version of OpenSplice

cscVersion¶

IDL_Type:	string
IDL_Size:	16
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

summaryState¶

Description: Current summary state of the CSC

EFDB_Topic:	SALGeneric_logevent_summaryState

summaryState¶

IDL_Type:	long
Units:	unitless

Description: High level state machine state identifier

Telemetry¶

ofcDuration¶

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

EFDB_Topic:	MTAOS_ofcDuration

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

calcTime¶

IDL_Type:	double
Units:	second

Description: Average of calculation time.

wepDuration¶

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

EFDB_Topic:	MTAOS_wepDuration

timestamp¶

IDL_Type:	double
Units:	second

Description: Time at which an event is recorded.

calcTime¶

IDL_Type:	double
Units:	second

Description: Average of calculation time.

Navigation

MTAOS¶

Commands¶

issueWavefrontCorrection¶

value¶

processCalibrationProducts¶

directoryPath¶

processCmosWavefrontError¶

intraImgPath¶

extraImgPath¶

sglBrightStarPixelX¶

sglBrightStarPixelY¶

filter¶

cameraRotation¶

userGain¶

processIntraExtraWavefrontError¶

intraVisit¶

extraVisit¶

intraDirectoryPath¶

extraDirectoryPath¶

fieldRA¶

fieldDEC¶

filter¶

cameraRotation¶

userGain¶

processShWavefrontError¶

annularZernikePoly¶

cameraRotation¶

userGain¶

processWavefrontError¶

visit¶

directoryPath¶

fieldRA¶

fieldDEC¶

filter¶

cameraRotation¶

userGain¶

resetWavefrontCorrection¶

value¶

abort¶

value¶

disable¶

value¶

enable¶

value¶

enterControl¶

value¶

exitControl¶

value¶

setAuthList¶

authorizedUsers¶

nonAuthorizedCSCs¶

setLogLevel¶

level¶

setValue¶

parametersAndValues¶

standby¶

value¶

start¶

settingsToApply¶

Enumerations¶

Events¶

cameraHexapodCorrection¶

timestamp¶

x¶

y¶

z¶

u¶

v¶

w¶

degreeOfFreedom¶

timestamp¶

aggregatedDoF¶

visitDoF¶

m1m3Correction¶

timestamp¶

zForces¶

m2Correction¶

timestamp¶

zForces¶