Guider

Note

This page is generated by python script generate_cet.py.

Back to table

Commands

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

GuiderStatus:

• Stamp

• Start

• Stop

• Pause

• Resume

Events

perGuiderResults

Description: Results of analysis on each guider

EFDB_Topic:

Guider_logevent_perGuiderResults

seqno

IDL_Type:

long

Units:

unitless

Description: DAQ provided sequence number

stamp

IDL_Type:

long

Units:

unitless

Description: DAQ provided stamp number

timestamp

IDL_Type:

double

Units:

second

Description: DAQ provided timestamp (TAI)

obsid

IDL_Type:

string

Units:

unitless

Description: OBSID corresponding to this stamp (derived from DAQ comment field)

sensor

IDL_Type:

string

Units:

unitless

Description: Sensor, e.g. R00_SG0 (: delimited list)

flux

IDL_Type:

double

Units:

electron

Count:

8

Description: Flux in each sensor

fluxErr

IDL_Type:

double

Units:

electron

Count:

8

Description: Error on flux in each sensor

centroidX

IDL_Type:

double

Units:

mm

Count:

8

Description: Centroid x position in each sensor (in Focal Plane DVCS coordinates)

centroidY

IDL_Type:

double

Units:

mm

Count:

8

Description: Centroid y position in each sensor (in Focal Plane DVCS coordinates)

centroidXErr

IDL_Type:

double

Units:

mm

Count:

8

Description: Error in Centroid x

centroidYErr

IDL_Type:

double

Units:

mm

Count:

8

Description: Error in Centroid x

centroidDx

IDL_Type:

double

Units:

mm

Count:

8

Description: x offset from first good stamp

centroidDy

IDL_Type:

double

Units:

mm

Count:

8

Description: y offset from first good stamp

momentXx

IDL_Type:

double

Units:

mm^2

Count:

8

Description: 2nd moment xx

momentYy

IDL_Type:

double

Units:

mm^2

Count:

8

Description: 2nd moment yy

momentXy

IDL_Type:

double

Units:

mm^2

Count:

8

Description: 2nd moment xy

centroidFitQuality

IDL_Type:

double

Units:

unitless

Count:

8

Description: Flag for good Centroid finding (details TBD)

seriesMetadata

Description: Published once on each start of the guider (corresponding to initGuiders command)

EFDB_Topic:

Guider_logevent_seriesMetadata

roiCommonNrows

IDL_Type:

long

Units:

pixel

Description: The number of rows

roiCommonNcols

IDL_Type:

long

Units:

pixel

Description: The number of columns

roiCommonIntegration

IDL_Type:

long

Units:

ms

Description: Integration time

sensor

IDL_Type:

string

Units:

unitless

Description: Sensor, e.g. R00_SG0 (: delimited list)

segment

IDL_Type:

long

Units:

unitless

Count:

8

Description: The segment number within the sensor

startrow

IDL_Type:

long

Units:

unitless

Count:

8

Description: ROI start row

startcol

IDL_Type:

long

Units:

unitless

Count:

8

Description: ROI start column

splitroi

IDL_Type:

boolean

Units:

unitless

Count:

8

Description: True if the ROI is split across segments

stateMetadata

Description: Published once on each guider start/stop/pause/resume/stamp

EFDB_Topic:

Guider_logevent_stateMetadata

status

IDL_Type:

long

Units:

unitless

Description: Enumeration with the current guiding status.

seqno

IDL_Type:

long

Units:

unitless

Description: DAQ provided sequence number

stamp

IDL_Type:

long

Units:

unitless

Description: DAQ provided stamp number

timestamp

IDL_Type:

double

Units:

second

Description: DAQ provided timestamp (TAI)

obsid

IDL_Type:

string

Units:

unitless

Description: OBSID corresponding to this stamp (derived from DAQ comment field)

sensors

IDL_Type:

string

Units:

unitless

Description: Sensors for which stamps were received (e.g. R00_SG1)

summaryResults

Description: Results of analysis on all guiders

EFDB_Topic:

Guider_logevent_summaryResults

seqno

IDL_Type:

long

Units:

unitless

Description: DAQ provided sequence number

stamp

IDL_Type:

long

Units:

unitless

Description: DAQ provided stamp number

timestamp

IDL_Type:

double

Units:

second

Description: DAQ provided timestamp (TAI)

obsid

IDL_Type:

string

Units:

unitless

Description: OBSID corresponding to this stamp (derived from DAQ comment field)

deltaX

IDL_Type:

double

Units:

mm

Description: Centroid Delta X relative to first good Stamp (also in DVCS coordinates)

deltaY

IDL_Type:

double

Units:

mm

Description: Centroid Delta Y relative to first good Stamp (also in DVCS coordinates)

deltaRotation

IDL_Type:

double

Units:

arcsec

Description: Delta rotation relative to first good Stamp

goodStamps

IDL_Type:

int

Units:

unitless

Description: number of good ROIs over the 8 CCDs

qualityFlag

IDL_Type:

double

Units:

unitless

Count:

8

Description: Quality Flag (overall quality of Centroid,Angle information) (details TBD)

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.

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

offsets

Description: Computed guider offsets. The values are computed in the instrument (camera) reference frame and need to be de-rotated accordingly by the pointing.

EFDB_Topic:

Guider_offsets

x

IDL_Type:

double

Units:

mm

Description: Guider offset in the (instrument) x-axis direction.

y

IDL_Type:

double

Units:

mm

Description: Guider offset in the (instrument) y-axis direction.

rotation

IDL_Type:

double

Units:

arcsec

Description: Guider rotation offset.