Low TMC configure 5.1

Example JSON.

{
    "interface": "https://schema.skao.int/ska-low-tmc-configure/5.1",
    "transaction_id": "txn-....-00001",
    "mccs": {
        "subarray_beams": [{
            "subarray_beam_id": 1,
            "update_rate": 0.0,
            "logical_bands": [{
                "start_channel": 80,
                "number_of_channels": 16
            }, {
                "start_channel": 384,
                "number_of_channels": 16
            }],
            "apertures": [{
                "aperture_id": "AP001.01",
                "weighting_key_ref": "default",
                "calibration_id": "default"
            }, {
                "aperture_id": "AP001.02",
                "weighting_key_ref": "default",
                "calibration_id": "default"
            }, {
                "aperture_id": "AP002.01",
                "weighting_key_ref": "default",
                "calibration_id": "default"
            }, {
                "aperture_id": "AP002.02",
                "weighting_key_ref": "default",
                "calibration_id": "default"
            }, {
                "aperture_id": "AP003.01",
                "weighting_key_ref": "default",
                "calibration_id": "default"
            }],
            "field": {
                "target_name": "Polaris Australis",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 317.199,
                    "c2": -88.95636
                }
            }
        }]
    },
    "sdp": {
        "interface": "https://schema.skao.int/ska-sdp-configure/0.4",
        "scan_type": "target:a"
    },
    "csp": {
        "interface": "https://schema.skao.int/ska-low-csp-configure/5.0",
        "common": {
            "config_id": "sbi-mvp01-20200325-00001-science_A",
            "eb_id": "eb-test-20220916-00000"
        },
        "lowcbf": {
            "stations": {
                "stns": [
                    [1, 1],
                    [2, 1],
                    [3, 1],
                    [4, 1],
                    [5, 1],
                    [6, 1]
                ],
                "stn_beams": [{
                    "beam_id": 1,
                    "freq_ids": [400]
                }]
            },
            "vis": {
                "fsp": {
                    "firmware": "vis",
                    "fsp_ids": [1]
                },
                "stn_beams": [{
                    "stn_beam_id": 1,
                    "integration_ms": 849
                }]
            },
            "timing_beams": {
                "fsp": {
                    "firmware": "pst",
                    "fsp_ids": [2]
                },
                "beams": [{
                    "pst_beam_id": 1,
                    "field": {
                        "target_name": "PSR J0024-7204R",
                        "reference_frame": "icrs",
                        "attrs": {
                            "c1": 6.023625,
                            "c2": -72.08128333,
                            "pm_c1": 4.8,
                            "pm_c2": -3.3
                        }
                    },
                    "stn_beam_id": 1,
                    "stn_weights": [0.9, 1.0, 1.0, 1.0, 0.9, 1.0]
                }, {
                    "pst_beam_id": 2,
                    "field": {
                        "target_name": "PSR J0024-7204R",
                        "reference_frame": "icrs",
                        "attrs": {
                            "c1": 6.023625,
                            "c2": -72.08128333,
                            "pm_c1": 4.8,
                            "pm_c2": -3.3
                        }
                    },
                    "stn_beam_id": 2,
                    "stn_weights": [0.9, 1.0, 1.0, 1.0, 0.9, 1.0]
                }]
            }
        },
        "pst": {
            "beams": [{
                "beam_id": 1,
                "scan": {
                    "centre_frequency": 200000000.0,
                    "total_bandwidth": 1562500.0,
                    "pst_processing_mode": "VOLTAGE_RECORDER",
                    "observer_id": "jdoe",
                    "project_id": "project1",
                    "target": {
                        "target_name": "J1921+2153",
                        "reference_frame": "icrs",
                        "attrs": {
                            "c1": 6.023625,
                            "c2": -72.08128333,
                            "epoch": 2000.0
                        }
                    },
                    "receiver_id": "receiver3",
                    "max_scan_length": 20000.0,
                    "subint_duration": 30.0,
                    "receptors": ["receptor1", "receptor2"],
                    "receptor_weights": [0.4, 0.6],
                    "rfi_frequency_masks": []
                }
            }, {
                "beam_id": 2,
                "scan": {
                    "centre_frequency": 200000000.0,
                    "total_bandwidth": 1562500.0,
                    "pst_processing_mode": "VOLTAGE_RECORDER",
                    "observer_id": "jdoe",
                    "project_id": "project1",
                    "target": {
                        "target_name": "J1921+2153",
                        "reference_frame": "icrs",
                        "attrs": {
                            "c1": 6.023625,
                            "c2": -72.08128333,
                            "epoch": 2000.0
                        }
                    },
                    "receiver_id": "receiver3",
                    "max_scan_length": 20000.0,
                    "subint_duration": 30.0,
                    "receptors": ["receptor1", "receptor2"],
                    "receptor_weights": [0.4, 0.6],
                    "rfi_frequency_masks": []
                }
            }]
        }
    },
    "tmc": {
        "scan_duration": 10.0
    }
}

https://schema.skao.int/ska-low-tmc-configure/5.1

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • transaction_id

A transaction id specific to the command

type

string

  • mccs

MCCS configure 5.1

MCCS configuration specification.

type

object

properties

  • subarray_beams

MCCS sub-array beam configuration.

type

array

items

MCCS subarray beams 5.1

type

object

properties

  • subarray_beam_id

ID of MCCS sub-array beam to configure.

ID must be an integer between 1 and 48.

type

integer

  • update_rate

Update rate for pointing information.

Value must be 0.0 or greater.

TODO: clarify whether this is specified as a frequency or as a cadence, plus units.

type

number

  • logical_bands

MCCS logical bands configuration.

type

array

items

MCCS Logical Band 5.1

type

object

properties

  • start_channel

Channel block configurations.

Constraints are: 2 < start channel < 504

type

integer

  • number_of_channels

Channel block configurations.

Constraints are: 8 < number_of_channels < 384

type

integer

additionalProperties

True

  • apertures

MCCS apertures configuration.

type

array

items

MCCS Aperture ID 5.1

type

object

properties

  • aperture_id

Aperture ID configurations. Aperture ID, of the form APXXX.YY XXX=station YY=substation.

type

string

  • weighting_key_ref

Descriptive ID for the aperture weights in the aperture database.

type

string

  • calibration_id

Unique id for the calibration to use.

type

string

default

null

additionalProperties

True

  • sky_coordinates

MCCS SKY Co ordinates 5.1

Legacy sky_coordinates (deprecated in favour of ‘field’).

type

object

default

null

properties

  • reference_frame

Must be one of: [“topocentric”, “ICRS”, “Galactic”, “AltAz”, “special”]

type

string

  • target_name

Name of the target source.

Required when reference_frame is “special”, which indicates that target coordinates are to be determined at runtime via a KatPoint lookup. When reference_frame is “special”, the target_name must be a valid object in the KatPoint catalogue.

type

string

default

null

  • c1

c1 (number, optional): first coordinate, RA or azimuth, in degrees. Minimum: 0.0. Maximum: 360.0

type

number

default

null

  • c2

Second coordinate (dec or elevation) in degrees.

type

number

default

null

additionalProperties

True

  • field

MCCS field 5.1

ADR-63 compliant sky direction (field) configuration.

type

object

default

null

properties

  • target_name

Name of the tracking target. Required for all reference frames.

type

string

  • reference_frame

Coordinate reference frame (lowercase).

Allowed values: “icrs”, “altaz”, “galactic”, “tle”, “special”.

type

string

  • attrs

field attrs 5.1

Frame-dependent attributes (coordinates, rates, etc.).

type

object

default

null

properties

  • c1

First coordinate (RA/azimuth/longitude) in degrees.

type

number

default

null

  • c2

Second coordinate (dec/elevation/latitude) in degrees.

type

number

default

null

  • pm_c1

Proper motion in c1 direction (arcsec/year).

type

number

default

null

  • pm_c2

Proper motion in c2 direction (arcsec/year).

type

number

default

null

  • epoch

Epoch for proper motion (default 2000.0).

type

number

default

null

  • parallax

Parallax in arcseconds.

type

number

default

null

  • radial_velocity

Radial velocity along line of sight (km/s).

type

number

default

null

  • line1

Line one of TLE for orbiting body.

type

string

default

null

  • line2

Line two of TLE for orbiting body.

type

string

default

null

additionalProperties

True

additionalProperties

True

additionalProperties

True

additionalProperties

True

  • csp

LOWCSP configure 5.0

CSP configuration specification.

type

object

properties

  • interface

URI of JSON schema for this command’sJSON payload..

type

string

  • transaction_id

A transaction id specific to the command

type

string

  • common

Common section, containing the parameters and the sections belonging to all CSP subsystems. This section is forwarded to all sub-elements.

Common_configuration_schema_5.0

  • lowcbf

Correlator and Beamformer specific parameters. This section contains the parameters relevant only for CBF sub-system. This section is forwarded only to CBF subelement.

LOWCBF_subarray_configurescan_0.2

  • pss

PSS configuration schema 0.0

Section with parameters to configure the PSS sub-system

type

object

properties

  • dummy_param

type

string

additionalProperties

True

  • pst

Section with parameters to configure the PST sub-system.

PST_configure_3.0

additionalProperties

True

  • sdp

SDP configure 1.1

SDP configuration specification.

type

object

properties

  • interface

type

string

  • transaction_id

type

string

  • scan_type

type

string

  • new_scan_types

type

array

items

A scan configuration for SDP. Once AssignResources has been performed successfully, subsequent Configure commands can select from these scan types in order to coordinate SDP with other sub-systems participating in the observation - for instance to switch between targets, or perform special calibration scans.

Scan_type_1.1

additionalProperties

True

  • tmc

TMC configuration specification.

type

object

properties

  • scan_duration

Scan duration in seconds.

Value must be >= 0.0

allOf

type

number

additionalProperties

True

additionalProperties

True

Common_configuration_schema_5.0

Common section, containing the parameters and the sections belonging to all CSP subsystems. This section is forwarded to all sub-elements.

type

object

properties

  • config_id

type

string

  • eb_id

Execution block ID to associate scan configs to an observation.

This ID is used for associating generated data, especially data products, for a given observation. Multiple scans can be linked to one observation and this ID is used as metadata to associate the data products from all scans of the same observation.

This ID does not have to be unique for a scan configuration but should be unique for different observations.

For example, all the data and weights files will have an EB_ID header value populated with the value supplied in this field.

type

string

additionalProperties

True

LOWCBF_subarray_configurescan_0.2

Correlator and Beamformer specific parameters. This section contains the parameters relevant only for CBF sub-system. This section is forwarded only to CBF subelement.

type

object

properties

  • stations

Subarray Stations and station beam input descriptions

Subarray_stations_and_station_beams_0.2

  • timing_beams

PST beam outputs descriptions

outer_0.2

  • search_beams

PSS beam outputs descriptions

type

string

  • vis

Visibilities description 0.2

Visibility output descriptions

type

object

properties

  • fsp

FSP 0.2

FSPs used for correlation

type

object

properties

  • firmware

Firmware name

type

string

  • fsp_ids

List of IDs (integer)

type

array

items

type

integer

additionalProperties

True

  • stn_beams

SDP visibility destinations

type

array

items

Station_beams_to_correlate_0.2

additionalProperties

True

  • zooms

placeholder zoom visibility output descriptions

type

string

additionalProperties

True

Subarray_stations_and_station_beams_0.2

Station and station beams parameters

type

object

properties

  • stns

type

array

items

type

array

items

type

integer

  • stn_beams

type

array

items

Subarray station beams 0.2

type

object

properties

  • beam_id

station beam id

type

integer

  • freq_ids

list of station beam frequency ids

type

array

items

type

integer

additionalProperties

True

additionalProperties

True

outer_0.2

PST Outer

type

object

properties

  • beams

inner

type

array

items

PST_beams_description_0.2

  • fsp

FSP 0.2

FSPs used by PST

type

object

properties

  • firmware

Firmware name

type

string

  • fsp_ids

List of IDs (integer)

type

array

items

type

integer

additionalProperties

True

additionalProperties

True

PST_beams_description_0.2

type

object

properties

  • stn_beam_id

Station beam ID for pst beamforming

type

integer

  • pst_beam_id

PST beam ID

type

integer

  • field

Sky direction

field description

default

null

anyOf

ICRS sky direction 0.2

A sky direction defined in the ICRS reference frame.

type

object

properties

  • target_name

A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.

type

string

  • reference_frame

Must be “icrs” for a sky direction defined in the ICRS reference

frame.

Validation is case-insensitive.

type

string

  • attrs

  • 0.2*

Attributes for an ICRS sky direction

type

object

properties

  • c1

The longitude coordinate, specifying degrees right ascension in the ICRS reference frame.

Value must be in the range 0 <= c1 < 360.

type

number

  • c2

The latitude coordinate, specifying degrees declination in the ICRS reference frame.

Value must be in the range -90 <= c2 <= 90.

type

number

  • pm_c1

Longitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • pm_c2

Latitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • epoch

Epoch of proper motion, giving the date when the proper motion offset was zero.

type

number

default

2000.0

  • parallax

The parallax in seconds of arc.

type

number

default

0.0

  • radial_velocity

Radial velocity along the line of sight in m/s.

type

number

default

0.0

additionalProperties

True

additionalProperties

True

AltAz sky direction 0.2

A sky direction defined in the AltAz reference frame

type

object

properties

  • target_name

A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.

type

string

  • reference_frame

Fixed as “altaz” for a sky direction defined in the AltAz

reference frame.

Validation is case-insensitive.

type

string

  • attrs

  • 0.2*

Allowed attributes for an AltAz sky direction

type

object

properties

  • c1

The azimuth coordinate in degrees.

Value must be in the range 0 <= c1 < 360.

type

number

  • c2

The elevation coordinate in degrees.

Value must be in the range 0 <= c2 <= 90.

type

number

additionalProperties

True

additionalProperties

True

Galactic sky direction 0.2

A sky direction defined in the Galactic reference frame.

type

object

properties

  • target_name

A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.

type

string

  • reference_frame

Must be “galactic” for a sky direction defined in the Galactic

reference frame.

Validation is case-insensitive.

type

string

  • attrs

  • 0.2*

Attributes for a Galactic sky direction

type

object

properties

  • c1

The longitude coordinate, specifying degrees right ascension in the Galactic reference frame.

Value must be in the range 0 <= c1 < 360.

type

number

  • c2

The latitude coordinate, specifying degrees declination in the Galactic reference frame.

Value must be in the range -90 <= c2 <= 90.

type

number

  • pm_c1

Longitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • pm_c2

Latitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • epoch

Epoch of proper motion, giving the date when the proper motion offset was zero.

type

number

default

2000.0

  • parallax

The parallax in seconds of arc.

type

number

default

0.0

  • radial_velocity

Radial velocity along the line of sight in m/s.

type

number

default

0.0

additionalProperties

True

additionalProperties

True

Special sky direction 0.2

A sky direction whose coordinates are defined in Katpoint.

type

object

properties

  • target_name

A name for the target. This should be the name of a resolvable entity in Katpoint, for example, the name of a solar system body.

type

string

  • reference_frame

Must be “special” for a catalogue sky direction.

Validation is case-insensitive.

type

string

additionalProperties

True

Two-Line Element sky direction 0.2

A sky direction defined by a Two-Line Element (TLE) set.

type

object

properties

  • target_name

A name for the target. For a TLE sky direction, this could be the name of a satellite in orbit.

type

string

  • reference_frame

Must be “tle” for a sky direction defined in the TLE reference

frame.

Validation is case-insensitive.

type

string

  • attrs

  • 0.2*

Attributes for a TLE sky direction.

type

object

properties

  • line1

First line of a two-line element (TLE) sky direction.

type

string

  • line2

Second line of a two-line element (TLE) sky direction.

type

string

additionalProperties

True

additionalProperties

True

  • stn_weights

weights for each station

type

array

items

type

number

  • rfi_enable

Master enable for RFI flagging

type

array

default

null

items

type

boolean

  • rfi_static_chans

Freqency IDs to be always flagged

type

array

default

null

items

type

integer

  • rfi_dynamic_chans

Frequency IDs to be dynamically flagged

type

array

default

null

items

type

integer

  • rfi_weighted

Parameter for dynamic flagging

type

number

default

null

additionalProperties

True

Station_beams_to_correlate_0.2

type

object

properties

  • stn_beam_id

Station Beam ID

type

integer

  • integration_ms

milliseconds integration

type

integer

additionalProperties

True

PST_configure_3.0

Main configuration for the CSP Pulsar timing sub-system

type

object

properties

  • beams

List of PST Beams IDs to configure

type

array

items

CSP configurescan pst beams 3.0

Parameters to configure the PST sub-system

type

object

properties

  • beam_id

Configuration for a PST beam ID in low csp

type

integer

  • scan

PST specific scan configuration parameters.

default

null

PST_scan_configuration_3.0

additionalProperties

True

additionalProperties

True

PST_scan_configuration_3.0

PST specific scan configuration parameters.

type

object

properties

  • centre_frequency

Centre frequency of the total (critical) bandwidth spanned by the frequency channels.

Units: Hz Range: 50e6 to 12800e6 Keyword: OBSFREQ

type

number

  • total_bandwidth

Total (critical) bandwidth spanned by the channels of the observation.

Low: 0.00361 to 300 MHz

Mid: 0.053.76 to 2500 MHz

Units: Hz Range: 3610 to 2.5e9 Keyword: OBSBW

type

number

  • pst_processing_mode

The PST processing mode used for the scan.

The value VOLTAGE_RECORDER is added for AA0.5, while the other values will be needed in future array assemblies.

The value of DYNAMIC_SPECTRUM has been renamed in favour of the value DETECTED_FILTERBANK. This change was made before PST implemented DETECTED_FILTERBANK mode and no clients should have been using this.

Note: in previous versions of the schema this used to be called observation_mode but has been renamed to be clear that this is specific about how PST will process that data from the correlator beam former (CBF).

Note: The values come from the Python enum PstProcessingMode` as defined in the SKA Control Model project.

Keyword: OBSMODE

type

string

  • observer_id

The observer in charge of the observations.

Keyword: OBSERVER

type

string

  • project_id

The project that the observations are for.

Keyword: PROJID

type

string

  • target

A union of the various standard sky direction representations supported by SKA, as defined in ADR-63.

Sky direction

  • receiver_id

The receiver name or ID.

Keyword: FRONTEND

type

string

  • max_scan_length

The maximum length of the observation.

Units: seconds Range: 30 - 43200 Keyword: SCANLEN_MAX

type

number

  • subint_duration

The length of each output sub-integration, in seconds.

As of version 3.0 of the schema this field is now optional and will default to 10.0 seconds.

For VOLTAGE_RECORDER mode the sub-integration length is always 10 seconds but in other processing modes this value could be changed by the observer depending on their use case.

Units: seconds Range: 1 - 60 Keyword: OUTSUBINT

type

number

default

10.0

  • receptors

An array of receptor IDs for the receptors included in the sub-array.

Keyword: ANTENNA

type

array

items

type

string

  • receptor_weights

Weight for each receptor.

Range: 0 - 1.0 Keyword: ANT_WEIGHTS

type

array

items

type

number

  • rfi_frequency_masks

A two-dimensional array of length of num_frequency_mask of known RFI frequency ranges to excise from the data.

The array contains mask pairs of [f_min, f_max] pairs for known frequency ranges containing RFI not excised by the CBF.

The overall dimension of this array is num_frequency_mask x 2.

Units: Hz Keyword: FREQ_MASK

type

array

default

null

items

allOf

type

array

items

type

number

  • pt

PST specific parameters for the ‘PULSAR_TIMING’ mode configuration.

default

null

PST_PULSAR_TIMING_mode_configuration_3.0

  • df

PST specific parameters for the ‘DETECTED_FILTERBANK’ mode configuration.

default

null

PST_DETECTED_FILTERBANK_mode_configuration_3.0

  • ft

PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.

default

null

PST_FLOW_THROUGH_mode_configuration_3.0

  • delay_centre

The telescope delay centre in International Terrestrial Reference Frame (ITRF) coordinates.

Units: metres Keyword: DELAY_CENTRE

type

array

default

null

items

type

number

additionalProperties

True

Sky direction

A union of the various standard sky direction representations supported by SKA, as defined in ADR-63.

anyOf

A sky direction defined in the ICRS reference frame.

ICRS_sky_direction_3.0

A sky direction defined in the AltAz reference frame

AltAz_sky_direction_3.0

A sky direction defined in the Galactic reference frame.

Galactic_sky_direction_3.0

A sky direction whose coordinates are defined in Katpoint.

Special_sky_direction_3.0

A sky direction defined by a Two-Line Element (TLE) set.

Two_Line_Element_sky_direction_3.0

ICRS_sky_direction_3.0

A sky direction defined in the ICRS reference frame.

type

object

properties

  • target_name

A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.

type

string

  • reference_frame

Must be “icrs” for a sky direction defined in the ICRS reference

frame.

Validation is case-insensitive.

type

string

  • attrs

  • 3.0*

Attributes for an ICRS sky direction

type

object

properties

  • c1

The longitude coordinate, specifying degrees right ascension in the ICRS reference frame.

Value must be in the range 0 <= c1 < 360.

type

number

  • c2

The latitude coordinate, specifying degrees declination in the ICRS reference frame.

Value must be in the range -90 <= c2 <= 90.

type

number

  • pm_c1

Longitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • pm_c2

Latitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • epoch

Epoch of proper motion, giving the date when the proper motion offset was zero.

type

number

default

2000.0

  • parallax

The parallax in seconds of arc.

type

number

default

0.0

  • radial_velocity

Radial velocity along the line of sight in m/s.

type

number

default

0.0

additionalProperties

True

additionalProperties

True

AltAz_sky_direction_3.0

A sky direction defined in the AltAz reference frame

type

object

properties

  • target_name

A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.

type

string

  • reference_frame

Fixed as “altaz” for a sky direction defined in the AltAz

reference frame.

Validation is case-insensitive.

type

string

  • attrs

  • 3.0*

Allowed attributes for an AltAz sky direction

type

object

properties

  • c1

The azimuth coordinate in degrees.

Value must be in the range 0 <= c1 < 360.

type

number

  • c2

The elevation coordinate in degrees.

Value must be in the range 0 <= c2 <= 90.

type

number

additionalProperties

True

additionalProperties

True

Galactic_sky_direction_3.0

A sky direction defined in the Galactic reference frame.

type

object

properties

  • target_name

A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.

type

string

  • reference_frame

Must be “galactic” for a sky direction defined in the Galactic

reference frame.

Validation is case-insensitive.

type

string

  • attrs

  • 3.0*

Attributes for a Galactic sky direction

type

object

properties

  • c1

The longitude coordinate, specifying degrees right ascension in the Galactic reference frame.

Value must be in the range 0 <= c1 < 360.

type

number

  • c2

The latitude coordinate, specifying degrees declination in the Galactic reference frame.

Value must be in the range -90 <= c2 <= 90.

type

number

  • pm_c1

Longitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • pm_c2

Latitudinal proper motion of target, measured in arcseconds per year.

type

number

default

0.0

  • epoch

Epoch of proper motion, giving the date when the proper motion offset was zero.

type

number

default

2000.0

  • parallax

The parallax in seconds of arc.

type

number

default

0.0

  • radial_velocity

Radial velocity along the line of sight in m/s.

type

number

default

0.0

additionalProperties

True

additionalProperties

True

Special_sky_direction_3.0

A sky direction whose coordinates are defined in Katpoint.

type

object

properties

  • target_name

A name for the target. This should be the name of a resolvable entity in Katpoint, for example, the name of a solar system body.

type

string

  • reference_frame

Must be “special” for a catalogue sky direction.

Validation is case-insensitive.

type

string

additionalProperties

True

Two_Line_Element_sky_direction_3.0

A sky direction defined by a Two-Line Element (TLE) set.

type

object

properties

  • target_name

A name for the target. For a TLE sky direction, this could be the name of a satellite in orbit.

type

string

  • reference_frame

Must be “tle” for a sky direction defined in the TLE reference

frame.

Validation is case-insensitive.

type

string

  • attrs

  • 3.0*

Attributes for a TLE sky direction.

type

object

properties

  • line1

First line of a two-line element (TLE) sky direction.

type

string

  • line2

Second line of a two-line element (TLE) sky direction.

type

string

additionalProperties

True

additionalProperties

True

PST_PULSAR_TIMING_mode_configuration_3.0

PST specific parameters for the ‘PULSAR_TIMING’ mode configuration.

type

object

properties

  • dispersion_measure

The dispersion measure for coherent/incoherent de-dispersion.

Units: pccm^-3 Range: 0 - 100000 Keyword: DM

type

number

  • rotation_measure

The rotation measure for phase-coherent Faraday rotation correction.

Units: radians per metre squared Keyword: RM

type

number

default

null

  • ephemeris

The ephemeris of the pulsar being observed.

Units: PSRCAT compatible ASCII string Keyword: EPHEMERIS

type

string

  • pulsar_phase_predictor

Pulsar phase predictor generated from ephemeris.

Units: TEMPO2 compatible ASCII string Keyword: PREDICTOR

type

string

  • output_frequency_channels

The number of output frequency channels. This must be between 1 and the number of observation channels.

Keyword: OUTNCHAN

type

integer

  • output_phase_bins

The number of output phase bins.

Range: 64 - 2048 Keyword: OUTNBIN

type

integer

  • num_sk_config

The number of spectral kurtosis (SK) configurations to apply.

Keyword: N_SK

type

integer

  • sk_config

List of spectral kurtosis configurations.

type

array

items

PST specific parameters for the spectral kurtosis (SK) for the ‘PULSAR_TIMING’ mode.

PST_spectral_kurtosis_configuration_3.0

  • target_snr

The signal-to-noise ratio (SNR) of the on-pulse flux for the scan. May be used to prematurely end a scan when the integrated SNR reaches the target. A value of 0 indicates there is no limit.

Keyword: TARGET_SNR

type

number

additionalProperties

True

PST_spectral_kurtosis_configuration_3.0

PST specific parameters for the spectral kurtosis (SK) for the ‘PULSAR_TIMING’ mode.

type

object

properties

  • sk_range

Frequency ranges for each spectral kurtosis (SK) configuration.

Units: Hz Keyword: SK_RNG

type

array

items

type

number

  • sk_integration_limit

The number of input time samples integrated into each spectral kurtosis (SK) statistic.

Range: 64 - 1024 Keyword: SK_INTS

type

integer

  • sk_excision_limit

Spectral kurtosis excision limits (RFI threshold) in units of standard deviations.

Range: 1 - 100 Keyword: SK_EXIS

type

number

additionalProperties

True

PST_DETECTED_FILTERBANK_mode_configuration_3.0

PST specific parameters for the ‘DETECTED_FILTERBANK’ mode configuration.

type

object

properties

  • dispersion_measure

The dispersion measure for coherent/incoherent de-dispersion.

This is only required for pulsar timing and Detected Filterbank modes.

Range: [0, 100000] Keyword: DM

type

number

  • rotation_measure

The rotation measure for phase-coherent Faraday rotation correction.

Units: radians per metre squared Keyword: RM

type

number

default

null

  • output_frequency_channels

The number of output frequency channels. This must be between 1 and the number of observation channels.

Keyword: OUTNCHAN

type

integer

  • stokes_parameters

The Stokes parameters to output when in Detected Filterbank mode.

Range: string with a combination of I, Q, U, and V. Keyword: STOKES_FB

type

string

  • num_bits_out

The number of bits per output sample.

Range: 1, 2, 4, 8, 16 or 32 Keyword: NBIT_OUT

type

integer

  • time_decimation_factor

The number of input samples per output time sample when in Detected Filterbank mode.

Keyword: TDEC_FB

type

integer

  • frequency_decimation_factor

The number of input frequency channels incoherently added to each output frequency channel in Detected Filterbank.

This is required in addition to output_frequency_channels because some frequency channels may be merged coherently to increase temporal resolution.

Keyword: FDEC_FB

type

integer

  • num_sk_config

The number of spectral kurtosis (SK) configurations to apply.

Keyword: N_SK

type

integer

default

null

  • sk_config

List of spectral kurtosis configurations.

type

array

default

null

items

PST specific parameters for the spectral kurtosis (SK) for the ‘PULSAR_TIMING’ mode.

PST_spectral_kurtosis_configuration_3.0

  • requantisation_scale

Scale factor to govern the dynamic range for fixed precision output to be applied during re-quantisation.

Keyword: DIGITIZER_SCALE

type

number

  • requantisation_length

Length of data to be used when determining the scaling factors used for fixed precision output during re-quantisation.

Units: seconds Keyword: DIGITIZER_LENGTH

type

number

additionalProperties

True

PST_FLOW_THROUGH_mode_configuration_3.0

PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.

type

object

properties

  • channel_polarisation_selection

PST specific parameters used for performing channel and polarisation selection of input data. This is used within the FLOW_THROUGH processing mode.

PST_channel_and_polarisation_selection_configuration_3.0

  • rescale

PST specific parameters used for rescaling of data before requantisation. This is used within the FLOW_THROUGH processing mode.

PST_Rescale_configuration_3.0

  • requantisation

PST specific parameters used for requantisation/ digitisation of data after other steps within the processing pipeline have been performed.

The PST processing pipeline works on floating point numbers but the output data are digitised and this step can reduce the output data size by using small number of bits to represent the output value.

This is used within the FLOW_THROUGH processing mode.

PST_requantisation_configuration_3.0

additionalProperties

True

PST_channel_and_polarisation_selection_configuration_3.0

PST specific parameters used for performing channel and polarisation selection of input data. This is used within the FLOW_THROUGH processing mode.

type

object

properties

  • channels

The indices of the first and last (inclusive) frequency channels that define the single contiguous range of frequency channels to be recorded.

Keyword: CHAN_FT

allOf

type

array

items

type

integer

  • polarisations

The polarisations to be recorded.

Valid values: A, B, or Both Keyword: POLN_FT

type

string

additionalProperties

True

PST_Rescale_configuration_3.0

PST specific parameters used for rescaling of data before requantisation. This is used within the FLOW_THROUGH processing mode.

type

object

properties

  • algorithm

The algorithm used to determine the scales and offsets when rescaling complex voltage data in Flow Through mode.

The value MedianMAD is the default algorithm and PST will determine the scales and offsets based on the calculating the median and the median absolute deviation (MAD) as the proxies for the sample mean and standard deviation. These statistics are considered more robust against outliers and are less affected by radio frequency interference (RFI) when computing the values.

The value MeanStdDev will calculate the sample mean and standard deviation of the input data and use that to rescale the data. This algorithm is not robust against RFI which will reduce the dynamic range when performing requantisation of the data.

Default: MedianMAD

type

string

default

MedianMAD

  • periodic_update

An indicator for whether to recalculate the rescale statistics periodically.

The rescaling of data within the FLOW_THROUGH processing mode can either be calculated once and applied across all the data during the scan or can be calculated periodically. If this value is set to false then the former is performed while the latter is performed if the field is set to true.

Default: false

type

boolean

default

False

  • timescale

The timescale needed to calculate rescale stats, in seconds.

This value is how long in time to sample data before calculating the rescale statistics. If periodic_update is true, then this is also the period of how often the rescale stats are recalculated.

If this value is set to 0.0, then PST will use the smallest chunk of data available to it to perform the statistics calculation.

Default: 0.0

type

number

default

0.0

additionalProperties

True

PST_requantisation_configuration_3.0

PST specific parameters used for requantisation/ digitisation of data after other steps within the processing pipeline have been performed.

The PST processing pipeline works on floating point numbers but the output data are digitised and this step can reduce the output data size by using small number of bits to represent the output value.

This is used within the FLOW_THROUGH processing mode.

type

object

properties

  • num_bits_out

The number of bits per output sample.

Range: 1, 2, 4, 8, 16 or 32 Keyword: NBIT_OUT

type

integer

  • scale

Scale factor applied during re-quantisation that modifies the dynamic range of the fixed precision output.

By default, for 2, 4, and 8 bits per sample, data will be scaled to minimize scattered power by adopting the Optimum Input Threshold Spacing for a Uniform Digitizer defined in Table 3 of Jenet & Anderson (1998; PASP 110:1467).

For more than 8 bits per sample, the values from Table 3 of Jenet & Anderson (1998) are extrapolated to num_bits_out-2, such that 2 bits are retained as additional headroom for RFI.

For all num_bits_out, the standard deviation is that of either the real or imaginary part of each complex-valued sample.

The default scale factor is computed such that, after multiplication by this scale factor, the data would satisfy the conditions described above. This default scale factor is multiplied by scale. Therefore, a scale value greater than 1 increases the value of the floating point data before it is cast to a fixed precision value, thereby reducing the overhead available to represent RFI and increasing the probability of clipping.

Keyword: DIGITIZER_SCALE Default: 1.0

type

number

additionalProperties

True

Scan_type_1.1

A scan configuration for SDP. Once AssignResources has been performed successfully, subsequent Configure commands can select from these scan types in order to coordinate SDP with other sub-systems participating in the observation - for instance to switch between targets, or perform special calibration scans.

type

object

properties

  • scan_type_id

type

string

  • reference_frame

Specification of the reference frame or system for a set of pointing coordinates (see ADR-49)

type

string

default

null

  • ra

Right Ascension in degrees (see ADR-49)

type

string

default

null

  • dec

Declination in degrees (see ADR-49)

type

string

default

null

  • channels

type

array

default

null

items

Informs SDP ingest about the expected channel configuration, especially which frequencies are expected to be mapped to which channel ID. Note that channel IDs are not guaranteed to be continuous, so this might involve gaps and/or strides.

Scan_channels_1.1

additionalProperties

True

Scan_channels_1.1

Informs SDP ingest about the expected channel configuration, especially which frequencies are expected to be mapped to which channel ID. Note that channel IDs are not guaranteed to be continuous, so this might involve gaps and/or strides.

type

object

properties

  • count

Number of channels

type

integer

  • start

First channel ID

type

integer

  • stride

Distance between subsequent channel IDs

type

integer

default

null

  • freq_min

Lower bound of first channel

type

number

  • freq_max

Upper bound of last channel

type

number

  • link_map

Channel map that specifies which network link is going to get used to send channels to SDP. Intended to allow SDP to optimise network and receive node configuration.

type

array

default

null

items

additionalProperties

True