JSON schema and example for Configure version 2.5

PST configuration schema 2.5

Example (LOW PST configuration for FLOW THROUGH scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-flow-through",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "num_of_polarizations": 2,
            "udp_nsamp": 32,
            "wt_nsamp": 32,
            "udp_nchan": 24,
            "num_frequency_channels": 432,
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "bits_per_sample": 32,
            "timing_beam_id": "1",
            "observation_mode": "FLOW_THROUGH",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [4, 3],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 1024,
                "oversampling_ratio": [32, 27]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 256,
                "oversampling_ratio": [4, 3]
            }],
            "ft": {
                "num_bits_out": 4,
                "channels": [0, 100],
                "requantisation_scale": 1.0,
                "polarizations": "Both",
                "requantisation_init_time": 1.0
            }
        }
    }
}

Example (LOW PST configuration for PULSAR TIMING scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-pulsar-timing",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "num_of_polarizations": 2,
            "udp_nsamp": 32,
            "wt_nsamp": 32,
            "udp_nchan": 24,
            "num_frequency_channels": 432,
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "bits_per_sample": 32,
            "timing_beam_id": "1",
            "observation_mode": "PULSAR_TIMING",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [4, 3],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 1024,
                "oversampling_ratio": [32, 27]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 256,
                "oversampling_ratio": [4, 3]
            }],
            "pt": {
                "dispersion_measure": 100.0,
                "rotation_measure": 0.0,
                "ephemeris": "",
                "pulsar_phase_predictor": "",
                "output_frequency_channels": 1,
                "output_phase_bins": 64,
                "num_sk_config": 1,
                "sk_config": [{
                    "sk_range": [0.8, 0.9],
                    "sk_integration_limit": 100,
                    "sk_excision_limit": 25.0
                }],
                "target_snr": 0.0
            }
        }
    }
}

Example (LOW PST configuration for DYNAMIC SPECTRUM scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-dynamic-spectrum",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "num_of_polarizations": 2,
            "udp_nsamp": 32,
            "wt_nsamp": 32,
            "udp_nchan": 24,
            "num_frequency_channels": 432,
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "bits_per_sample": 32,
            "timing_beam_id": "1",
            "observation_mode": "DYNAMIC_SPECTRUM",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [4, 3],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 1024,
                "oversampling_ratio": [32, 27]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 256,
                "oversampling_ratio": [4, 3]
            }],
            "ds": {
                "dispersion_measure": 100.0,
                "output_frequency_channels": 1,
                "stokes_parameters": "Q",
                "num_bits_out": 16,
                "time_decimation_factor": 10,
                "frequency_decimation_factor": 4,
                "requantisation_scale": 1.0,
                "requantisation_length": 1.0
            }
        }
    }
}

Example (LOW PST configuration for VOLTAGE RECORDER scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-voltage-recorder",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "num_of_polarizations": 2,
            "udp_nsamp": 32,
            "wt_nsamp": 32,
            "udp_nchan": 24,
            "num_frequency_channels": 432,
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "bits_per_sample": 32,
            "timing_beam_id": "1",
            "observation_mode": "VOLTAGE_RECORDER",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [4, 3],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 1024,
                "oversampling_ratio": [32, 27]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 256,
                "oversampling_ratio": [4, 3]
            }]
        }
    }
}

Example (MID PST configuration for FLOW THROUGH scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-flow-through",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "bits_per_sample": 16,
            "timing_beam_id": "1",
            "num_of_polarizations": 2,
            "udp_nsamp": 4,
            "wt_nsamp": 4,
            "udp_nchan": 185,
            "num_frequency_channels": 46435,
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observation_mode": "FLOW_THROUGH",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [8, 7],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 13,
                "oversampling_ratio": [10, 9]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 4096,
                "oversampling_ratio": [8, 7]
            }],
            "ft": {
                "num_bits_out": 4,
                "channels": [0, 100],
                "requantisation_scale": 1.0,
                "polarizations": "Both",
                "requantisation_init_time": 1.0
            }
        }
    }
}

Example (MID PST configuration for PULSAR TIMING scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-pulsar-timing",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "bits_per_sample": 16,
            "timing_beam_id": "1",
            "num_of_polarizations": 2,
            "udp_nsamp": 4,
            "wt_nsamp": 4,
            "udp_nchan": 185,
            "num_frequency_channels": 46435,
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observation_mode": "PULSAR_TIMING",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [8, 7],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 13,
                "oversampling_ratio": [10, 9]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 4096,
                "oversampling_ratio": [8, 7]
            }],
            "pt": {
                "dispersion_measure": 100.0,
                "rotation_measure": 0.0,
                "ephemeris": "",
                "pulsar_phase_predictor": "",
                "output_frequency_channels": 1,
                "output_phase_bins": 64,
                "num_sk_config": 1,
                "sk_config": [{
                    "sk_range": [0.8, 0.9],
                    "sk_integration_limit": 100,
                    "sk_excision_limit": 25.0
                }],
                "target_snr": 0.0
            }
        }
    }
}

Example (MID PST configuration for DYNAMIC SPECTRUM scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-dynamic-spectrum",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "bits_per_sample": 16,
            "timing_beam_id": "1",
            "num_of_polarizations": 2,
            "udp_nsamp": 4,
            "wt_nsamp": 4,
            "udp_nchan": 185,
            "num_frequency_channels": 46435,
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observation_mode": "DYNAMIC_SPECTRUM",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [8, 7],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 13,
                "oversampling_ratio": [10, 9]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 4096,
                "oversampling_ratio": [8, 7]
            }],
            "ds": {
                "dispersion_measure": 100.0,
                "output_frequency_channels": 1,
                "stokes_parameters": "Q",
                "num_bits_out": 16,
                "time_decimation_factor": 10,
                "frequency_decimation_factor": 4,
                "requantisation_scale": 1.0,
                "requantisation_length": 1.0
            }
        }
    }
}

Example (MID PST configuration for VOLTAGE RECORDER scan 2.5)

{
    "interface": "https://schema.skao.int/ska-pst-configure/2.5",
    "common": {
        "config_id": "sbi-mvp01-20240111-voltage-recorder",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "activation_time": "2024-01-11T23:11:17Z",
            "bits_per_sample": 16,
            "timing_beam_id": "1",
            "num_of_polarizations": 2,
            "udp_nsamp": 4,
            "wt_nsamp": 4,
            "udp_nchan": 185,
            "num_frequency_channels": 46435,
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observation_mode": "VOLTAGE_RECORDER",
            "observer_id": "jdoe",
            "project_id": "project1",
            "pointing_id": "pointing1",
            "source": "J1921+2153",
            "itrf": [5109360.133, 2006852.586, -3238948.127],
            "receiver_id": "receiver3",
            "feed_polarization": "LIN",
            "feed_handedness": 1,
            "feed_angle": 1.234,
            "feed_tracking_mode": "FA",
            "feed_position_angle": 10.0,
            "oversampling_ratio": [8, 7],
            "coordinates": {
                "equinox": 2000.0,
                "ra": "19:21:44.815",
                "dec": "21:53:02.400"
            },
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "num_channelization_stages": 2,
            "channelization_stages": [{
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 13,
                "oversampling_ratio": [10, 9]
            }, {
                "num_filter_taps": 1,
                "filter_coefficients": [1.0],
                "num_frequency_channels": 4096,
                "oversampling_ratio": [8, 7]
            }]
        }
    }
}

Schema to validate the Pulsar Timing configuration.

https://schema.skao.int/ska-pst-configure/2.5

type

object

properties

  • pst

PST configuration 2.5

PST specific parameters. To be borrowed from IICD

type

object

properties

  • scan

PST specific scan configuration parameters.

PST_scan_configuration_2.5

  • beam

PST specific beam configuration parameters.

Deprecated: As of version 2.3 this schema has no elements and is deprecated, and has been removed in version 3.0 of the schema.

PST_beam_configuration_2.5

additionalProperties

True

  • interface

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

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_2.5

additionalProperties

True

PST_scan_configuration_2.5

PST specific scan configuration parameters.

type

object

properties

  • activation_time

Date and time when to start the PST reconfiguration.

Deprecated: this field has been removed in version 3.0 of the PST schema. This field has never been used by PST and was always ignored.

Units: UTC timestamp Keyword: ACTIVATION_TIME

type

string

  • timing_beam_id

Identifier assigned by LMC/TMC used to identify the beam configuration.

PST selects which PST server to use for this scan and timing beam, and provides a mapping from the timing beam identifier by the TM to PST capability id.

Keyword: BEAM

type

string

  • bits_per_sample

The number of bits per complex-values time sample in the CBF output data.

Valid values are 16, 24, or 32.

Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band.

Keyword: NBIT

type

integer

  • num_of_polarizations

The number of polarizations in the CBF output data.

Valid values are 1 or 2.

Note: all SKA receivers produce two polarisation inputs, and the correlator produces products for both polarisations. The value of 1 was added to allow for future capability if the need arises.

Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band.

Keyword: NPOL

type

integer

  • udp_nsamp

The number of time samples for each single polarization and the a single frequency in each UDP packet sent by CBF.

Note: this must be an integer multiple of WT_NSAMP

Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band.

Range: 32 (Low), 4 (Mid) Keyword: UDP_NSAMP

type

integer

  • wt_nsamp

The number of time samples described by as single relative weight. There is a unique relative weight for each frequency channel, and each relative weight describes both polarizations.

Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band.

Range: 32 (Low), 4 (Mid) Keyword: WT_NSAMP

type

integer

  • udp_nchan

The number of contiguous frequency channels in each UDP packet sent by CBF.

Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band.

Range: 24 (Low), 185 (Mid) Keyword: UDP_NCHAN

type

integer

  • num_frequency_channels

The total number of frequency channels into which the total critical bandwidth has been divided.

This must be an integer multiple of udp_nchan

Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band. It is also required to be a multiple of the udp_chan which is also now deprecated for the same reason.

Range: 1 to 82944 Keyword: OBSNCHAN

type

integer

  • 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

  • observation_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 the future for data processing.

Deprecated: this field has been renamed to pst_processing_mode in version 3.0 of the PST schema.

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

  • pointing_id

The ID for the sub-array pointing.

Deprecated: this field has been removed in version 3.0 of the PST schema.

Keyword: PNT_ID

type

string

  • source

The name of the source.

Keyword: SRC_NAME

type

string

  • itrf

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

Deprecated: this field has been renamed to “delay_centre” in version 3.0 of the PST schema.

Units: metres Keyword: ITRF

type

array

items

type

number

  • receiver_id

The receiver name or ID.

Keyword: FRONTEND

type

string

  • feed_polarization

The native polarization of feed.

Deprecated: this field has been removed in version 3.0 of the PST schema.

Range: LIN or CIRC Keyword: FD_POLN

type

string

  • feed_handedness

Code for sense of feed.

For value of +1 for XYZ forming RH set with Z in the direction of propagation. Looking up into the feed of a prime-focus receiver or at the sky).

For FD_HAND = +1, the rotation from A (or X) to B (or Y) is counter clockwise or in the direction of increasing Feed Angle (FA) or Position Angle (PA).

For circular feeds, FD_HAND = +1 for IEEE LCP on the A (or X) probe.

Deprecated: this field has been removed in version 3.0 of the PST schema.

Range: -1 or +1 Keyword: FD_HAND

type

integer

  • feed_angle

Feed angle of the E-vector for an equal in-phase response from the A(X) and B(Y) probes, measured in the direction of increasing feed angle or position angle (clockwise when looking down on a prime focus receiver).

Deprecated: this field has been removed in version 3.0 of the PST schema.

Units: degrees Range: -180 to 180. Keyword: FD_SANG

type

number

  • feed_tracking_mode

The tracking mode for the feed:

  • FA - constant feed angle and that the feed stays fixed with respect to the telescope’s reference frame.

  • CPA - the feed rotates to maintain a constant phase angle (i.e. it tracks the variation of the parallactic angle.). When the coordinate mode is GALACTIC, PA is with respect to Galactic north and similarly for coordinate mode ECLIPTIC then PA is with respect to ecliptic north.

  • SPA - the feed angle is held fixed at an angle such that the requested PA is obtained at the mid-point of the observation.

  • TPA - is only relevant for scan observations - the feed is rotated to maintain a constant angle with respect to the scan direction.

Deprecated: this field has been removed in version 3.0 of the PST schema.

Range: FA, CPA, SPA, or TPA Keyword: FD_MODE

type

string

  • feed_position_angle

The requested angle of feed reference.

For feed_mode = ‘FA’ this is respect to the telescope’s reference frame (feed_angle = 0), and for feed_mode = ‘CPA’ this is with respect to the celestial north (parallactic angle = 0) or with respect to the Galactic north for coordinate_mode = ‘GALACTIC’.

Deprecated: this field has been removed in version 3.0 of the PST schema.

Range: -180 to +180.

Keyword: FA_REQ

type

number

  • oversampling_ratio

The oversampling ratio expressed as a fraction as an array of int, with the first value the numerator and the second is the denominator. (e.g. 8/7 is assigned as [8,7]).

Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band.

Range: 8/7 or 4/3 Keyword: OVERSAMP

type

array

items

type

integer

  • coordinates

The tied-array beam’s tracking co-ordinates.

As of version 2.2 of the schema this only handles equatorial tracking which means uses RA/Dec J2000.0 coords but PST may support different tracking modes and coordinates the future.

PST_RA_Dec_coordinates_2.5

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

Units: seconds Range: 1 - 60 Keyword: OUTSUBINT

type

number

  • 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

  • num_rfi_frequency_masks

The number of frequency ranges to be masked.

Deprecated: this field has been removed in version 3.0 of the PST schema. This is will be inferred by length of rfi_frequency_masks.

Range: 0 - 1024 Keyword: NMASK

type

integer

  • 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

items

allOf

type

array

items

type

number

  • destination_address

The destination address for the PST output data.

Includes IPv4 Address, port number.

Deprecated: this field has been removed in version 3.0 of the PST schema.

type

array

items

anyOf

type

string

type

integer

  • test_vector_id

Identifier for a test vector that will be present in the tied-array beam data stream beam CBF and PST.

Deprecated: This field has never been used and has been removed in version 3.0 of the PST schema.

Keyword: TEST_VECTOR

type

string

  • pt

PST specific parameters for the ‘PULSAR_TIMING’ mode configuration.

PST_PULSAR_TIMING_mode_configuration_2.5

  • ds

PST specific parameters for the ‘DYNAMIC_SPECTRUM’ mode configuration.

PST_DYNAMIC_SPECTRUM_mode_configuration_2.5

  • ft

PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.

PST_FLOW_THROUGH_mode_configuration_2.5

  • num_channelization_stages

The number of stages used to channelize the data: e.g. * for Low, there are 2 stages: 1 in LFAA and 1 in CBF * for Mid, there are 2 stages: 1 in FSP and 1 in PST BF.

Deprecated: This field has been removed in version 3.0 of the PST schema. The information for this field and channelization_stages can be inferred from the telescope and frequency band.

Keyword: NSTAGE

type

integer

  • channelization_stages

List of configuration for each channelization stage.

Deprecated: This field has been removed in version 3.0 of the PST schema. The information for this field and num_channelization_stages can be inferred from the telescope and frequency band.

type

array

items

PST specific parameters for channelization stage configuration.

Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema.

PST_channelization_stage_configuration_2.5

additionalProperties

True

PST_RA_Dec_coordinates_2.5

PST specific parameters for RA/Dec tracking coordinates.

type

object

properties

  • equinox

The coordinate epoch.

This can be in Julian date or Modified Julian Date.

Units: years Range: >= 2000 Keyword: EQUINOX

type

number

  • ra

The Right Accession (RA) of the coordinates used for tracking.

Valid formats is ‘hh:mm:ss.sss’ or ‘ddd.ddd’

Keyword: STT_CTD1

type

string

  • dec

The declination (Dec) of the coordinates used for tracking.

Valid formats is ‘hh:mm:ss.sss’ or ‘ddd.ddd’

Keyword: STT_CTD2

type

string

additionalProperties

True

PST_PULSAR_TIMING_mode_configuration_2.5

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

  • 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_2.5

  • 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_2.5

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_DYNAMIC_SPECTRUM_mode_configuration_2.5

PST specific parameters for the ‘DYNAMIC_SPECTRUM’ mode configuration.

type

object

properties

  • dispersion_measure

The dispersion measure for coherent/incoherent de-dispersion.

This is only required for pulsar timing and dynamic spectrum 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

  • 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 Dynamic spectrum 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 Dynamic Spectrum mode.

Keyword: TDEC_FB

type

integer

  • frequency_decimation_factor

The number of input frequency channels incoherently added to each output frequency channel in Dynamic Spectrum.

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

  • 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_2.5

  • 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_2.5

PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.

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

  • 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

  • requantisation_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 requantisation_scale. Therefore, a requantisation_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

type

number

  • polarizations

The polarizations to be recorded.

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

type

string

  • requantisation_init_time

Time interval spanned by data used at the start of a scan to determine the scale factors applied before re-quantisation.

Units: seconds Keyword: DIGITIZER_INIT_TIME

type

number

additionalProperties

True

PST_channelization_stage_configuration_2.5

PST specific parameters for channelization stage configuration.

Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema.

type

object

properties

  • num_filter_taps

Total number of taps in the prototype filter (i.e. over all arms) used in the stage.

Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema. This field can also be inferred from the length of the filter_coefficients field.

Keyword: NSTAP_k

type

integer

  • filter_coefficients

An array of filter coefficients that define the (time domain) response function of the prototype filter used in the stage.

Length of this is num_filter_taps.

Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema.

Keyword: COEFF_k

type

array

items

type

number

  • num_frequency_channels

The number of frequency channels output by each polyphase filter bank (PFB) for this stage.

Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema. This field can be determined by which telescope and frequency band.

Keyword: NCHAN_PFB_k

type

integer

  • oversampling_ratio

The oversampling ratio expressed as a fraction as an array of int, with the first value the numerator and the second is the denominator. (e.g. 8/7 is assigned as [8,7]).

Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema. This field can be determined by which telescope and frequency band.

Keyword: OVERSAMP_k

type

array

items

type

integer

additionalProperties

True

PST_beam_configuration_2.5

PST specific beam configuration parameters.

Deprecated: As of version 2.3 this schema has no elements and is deprecated, and has been removed in version 3.0 of the schema.

type

object

properties

additionalProperties

True

Common_configuration_schema_2.5

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

  • subarray_id

Subarray number

type

integer

  • 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

  • frequency_band

Frequency band applies for all the receptors (VCCs) that belong to the sub-array.

The value of ‘low’ is used to only within SKA Low. As this field is a mandatory field but bands 1, 2, 3, 4, 5a and 5b only make sense for SKA Mid.

type

string

additionalProperties

True