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_ms": 60000,
      "target_ref": "target-12345",
      "dish_allocation_ref": "dish-allocation-74519",
      "scan_type_ref": "calibration_B",
      "csp_configuration_ref": "csp-configuration-12345",
      "pointing_correction": "MAINTAIN"
    },
    {
      "scan_duration_ms": 60000,
      "target_ref": "target-67890",
      "dish_allocation_ref": "dish-allocation-74519",
      "scan_type_ref": "science_A",
      "scan_definition_id": "science scan",
      "csp_configuration_ref": "csp-configuration-12345",
      "pointing_correction": "UPDATE"
    }
  ],

A JSON code example for SKA LOW is shown below.

  "scan_definitions": [
    {
      "scan_definition_id": "scan 1",
      "target_ref": "target-12345",
      "mccs_allocation_ref": "mccs-allocation-74519",
      "csp_configuration_ref": "csp-configuration-12345",
      "scan_duration_ms": 64000,
      "scan_intent": "Science",
      "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_ms: timedelta, target_ref: str | None = None, mccs_allocation_ref: str | None = None, dish_allocation_ref: str | None = None, scan_type_ref: str | None = None, csp_configuration_ref: str | None = None, scan_intent: 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_ms – scan duration

Target_ref:

ID of target to observe

Mccs_allocation_ref:

ID of MCCS Config

Target_beam_configuration_refs:

SKA LOW sub-array beam configurations to apply during this scan.

Dish_allocation_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.