ska_oso_pdm.sb_definition.scan_definition
The ska_oso_pdm.sb_definition.scan_definition module models SB entities concerned with the selection of which element configurations should take effect for the duration of a scan. The contents of the module are presented in the diagram below.
Class diagram for the scan_definition module
An example serialisation of this model to JSON for SKA MID is shown below.
"scan_definitions": [
{
"scan_definition_id": "calibrator scan",
"scan_duration": 60000,
"target_ref": "Polaris Australis",
"dish_configuration_ref": "dish config 123",
"scan_type_ref": "calibration_B",
"csp_configuration_ref": "csp config 123",
"pointing_correction": "MAINTAIN"
},
{
"scan_duration": 60000,
"target_ref": "M83",
"dish_configuration_ref": "dish config 123",
"scan_type_ref": "science_A",
"scan_definition_id": "science scan",
"csp_configuration_ref": "csp config 123",
"pointing_correction": "UPDATE"
}
],
A JSON code example for SKA LOW is shown below.
"scan_definitions": [
{
"scan_definition_id": "sbi-mvp01-20220328-00001",
"scan_duration": 64000,
"target_beam_configuration_refs": [
"target #1 with beam A config 1"
],
"target_ref": "target #1",
"pointing_correction": "MAINTAIN"
},
{
"scan_definition_id": "sbi-mvp01-20220328-00002",
"scan_duration": 64000,
"target_beam_configuration_refs": [
"target #2 with beam A config 1"
],
"target_ref": "target #2",
"pointing_correction": "MAINTAIN"
}
],
The ska_oso_pdm.sb_definition.scan_definition module defines simple Python representation of a single observation scan
- class ScanDefinition(*, scan_definition_id: str | None = None, scan_duration: timedelta, target_ref: str | None = None, target_beam_configuration_refs: List[str] = None, dish_configuration_ref: str | None = None, scan_type_ref: str | None = None, csp_configuration_ref: str | None = None, pointing_correction: PointingCorrection = PointingCorrection.MAINTAIN)[source]
ScanDefinition represents the instrument configuration for a single scan.
- Parameters:
scan_definition_id – the unique ID for this scan definition
scan_duration – scan duration
- Target_ref:
ID of target to observe
- Target_beam_configuration_refs:
SKA LOW sub-array beam configurations to apply during this scan.
- Dish_configuration_ref:
SKA MID dish configuration ID during this scan.
- Scan_type_ref:
SKA MID scan type ID
- Csp_configuration_ref:
SKA MID Central Signal Processor ID
- Pointing_correction:
operation to apply to the pointing correction model.