ska_oso_pdm.entities.common.field_configuration¶

The field_configuration module models SB data model entities concerned with receptor pointing and mapping (source coordinates, survey fields, etc.). The contents of the module are presented in the diagram below.

../../../_images/field_configuration.png

Class diagram for the field_configuration module

An example serialisation of this model to JSON is shown below.

# JSON modelled specifically by field_configuration
...
"field_configurations": [
  {
    "field_id":"science fields",
      "targets": [
        {
          "target_id": "my first science target",
          "kind": "SiderealTarget",
          "target_name": "NGC6251",
          "reference_frame": "ICRS",
          "ra": "23:45:45.67",
          "dec": "-21:23:45.67"
        },
        {
          "target_id": "my second science target",
          "kind": "SiderealTarget",
          "target_name": "M51",
          "reference_frame": "ICRS",
          "ra": "23:45:45.93",
          "dec": "-21:23:44.92"
        }
      ]
    }
],
...

Another JSON example with DriftScan target is shown below.

...
"field_configurations": [
  {
    "field_id": "target field",
    "targets": [
      {
        "target_id": "target #1",
        "kind": "driftscan",
        "target_name": "Drift scan at 45 degs",
        "reference_frame": "HORIZON",
        "az": 180.0,
        "el": 45.0
      },
      {
        "target_id": "target #2",
        "kind": "driftscan",
        "target_name": "Drift scan at 85 degs",
        "reference_frame": "HORIZON",
        "az": 180.0,
        "el": 85.0
      }
    ]
  }
],
...

The entities.common.field_configuration module defines a Python representation of the target of the observation.

class FieldConfiguration(field_id: Optional[str] = None, targets: Optional[Sequence[ska_oso_pdm.entities.common.field_configuration.Target]] = None)[source]¶: FieldConfiguration represents the argument for SKA scheduling block.

FieldConfigurationID¶: alias of builtins.str

class SiderealTarget(ra: Union[float, str], dec: Union[float, str], target_name: Optional[str] = None, reference_frame: Optional[str] = 'icrs', target_id: Optional[str] = None, unit: Union[str, Tuple[str, str]] = ('hourangle', 'deg'))[source]¶

SiderealTarget represents the argument for SKA scheduling block.

coord¶: abstract method : Target encapsulates source coordinates and source metadata.

class DriftScanTarget(az: float, el: float, target_name: Optional[str] = None, target_id: Optional[str] = None, unit: str = 'deg')[source]¶

DriftScanTarget defines AltAz target for SKA scheduling block.

coord¶: abstract method : Target encapsulates source coordinates and source metadata.

class Planet(target_name: ska_oso_pdm.entities.common.field_configuration.PlanetName, target_id: Optional[str] = None)[source]¶

Planet represents the argument for SKA scheduling block.

coord¶: abstract method : Target encapsulates source coordinates and source metadata.

class PlanetName[source]¶: PlanetName represents name of the planet.

TargetID¶: alias of builtins.str