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.

  "dish_allocations": {
    "dish_allocation_id": "dish-allocation-74519",
    "dish_ids": [
      "SKA001",
      "SKA036",
      "SKA063",
      "SKA100"
    ],
    "scan_sequence": [
      {
        "scan_definition_id": "scan-definition-56020",
        "scan_duration_ms": 60000,
        "target_ref": "target-12345",
        "csp_configuration_ref": "csp-configuration-12345",
        "pointing_correction": "MAINTAIN",
        "scan_duration": {
          "value": 60.0,
          "unit": "s"

A JSON code example for SKA LOW is shown below.

  "mccs_allocation": {
    "mccs_allocation_id": "mccs-allocation-74519",
    "selected_subarray_definition": "AA0.5",
    "subarray_beams": [
      {
        "subarray_beam_id": 1,
        "apertures": [
          {
            "station_id": 345,
            "substation_id": 1,
            "weighting_key": "uniform"
          },
          {
            "station_id": 350,
            "substation_id": 1,
            "weighting_key": "uniform"
          },
          {
            "station_id": 352,
            "substation_id": 1,
            "weighting_key": "uniform"
          },
          {
            "station_id": 431,
            "substation_id": 1,
            "weighting_key": "uniform"
          }
        ],
        "scan_sequence": [
          {
            "scan_definition_id": "scan-definition-12218",
            "scan_duration_ms": 60000,
            "target_ref": "target-12345",
            "csp_configuration_ref": "csp-configuration-12345",
            "pointing_correction": "MAINTAIN",
            "scan_duration": {
              "value": 60.0,
              "unit": "s"
            }
          }
        ]
      }
    ]
  },
  "csp_configurations": [
    {
      "config_id": "csp-configuration-12345",
      "name": "csp config 1",
      "lowcbf": {
        "do_pst": false,
        "correlation_spws": [
          {
            "spw_id": 1,
            "logical_fsp_ids": [
              0,
              1
            ],
            "zoom_factor": 0,
            "centre_frequency": 199.609375e6,
            "number_of_channels": 96,
            "integration_time_ms": 849
          }
        ]
      }
    }
  ],

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, target_ref: str | None = None, mccs_allocation_ref: str | None = None, dish_allocation_ref: str | None = None, csp_configuration_ref: str | None = None, scan_intent: str | None = None, pointing_correction: ~ska_oso_pdm.sb_definition.scan_definition.PointingCorrection = PointingCorrection.MAINTAIN, scan_duration_ms: ~datetime.timedelta | None = None, scan_duration: ~astropy.units.quantity.Quantity | None = <Quantity 0. s>)

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

• scan_duration – 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.