JSON schema and example for Configure version 3.0

PST configuration schema 3.0

Example (LOW PST configuration for FLOW THROUGH scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-flow-through",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "timing_beam_id": "1",
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "FLOW_THROUGH",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            },
            "ft": {
                "channel_polarisation_selection": {
                    "channels": [0, 100],
                    "polarisations": "Both"
                },
                "rescale": {
                    "algorithm": "MedianMAD",
                    "periodic_update": true,
                    "timescale": 1.0
                },
                "requantisation": {
                    "num_bits_out": 4,
                    "scale": 1.0
                }
            }
        }
    }
}

Example (LOW PST configuration for PULSAR TIMING scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-pulsar-timing",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "timing_beam_id": "1",
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "PULSAR_TIMING",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            },
            "pt": {
                "dispersion_measure": 100.0,
                "rotation_measure": 0.0,
                "ephemeris": "",
                "pulsar_phase_predictor": "",
                "output_frequency_channels": 1,
                "output_phase_bins": 64,
                "sk_config": [{
                    "sk_integration_limit": 100,
                    "sk_excision_limit": 6.0
                }],
                "target_snr": 0.0
            }
        }
    }
}

Example (LOW PST configuration for DETECTED FILTERBANK scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-detected-filterbank",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "timing_beam_id": "1",
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "DETECTED_FILTERBANK",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            },
            "df": {
                "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,
                "num_sk_config": 1,
                "sk_config": [{
                    "sk_range": [0.8, 0.9],
                    "sk_integration_limit": 100,
                    "sk_excision_limit": 25.0
                }]
            }
        }
    }
}

Example (LOW PST configuration for VOLTAGE RECORDER scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-voltage-recorder",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "low"
    },
    "pst": {
        "scan": {
            "centre_frequency": 100000000.0,
            "total_bandwidth": 1562500.0,
            "timing_beam_id": "1",
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "VOLTAGE_RECORDER",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            }
        }
    }
}

Example (MID PST configuration for FLOW THROUGH scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-flow-through",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "timing_beam_id": "1",
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "FLOW_THROUGH",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            },
            "ft": {
                "channel_polarisation_selection": {
                    "channels": [0, 100],
                    "polarisations": "Both"
                },
                "rescale": {
                    "algorithm": "MedianMAD",
                    "periodic_update": true,
                    "timescale": 1.0
                },
                "requantisation": {
                    "num_bits_out": 4,
                    "scale": 1.0
                }
            }
        }
    }
}

Example (MID PST configuration for PULSAR TIMING scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-pulsar-timing",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "timing_beam_id": "1",
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "PULSAR_TIMING",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            },
            "pt": {
                "dispersion_measure": 100.0,
                "rotation_measure": 0.0,
                "ephemeris": "",
                "pulsar_phase_predictor": "",
                "output_frequency_channels": 1,
                "output_phase_bins": 64,
                "sk_config": [{
                    "sk_integration_limit": 100,
                    "sk_excision_limit": 6.0
                }],
                "target_snr": 0.0
            }
        }
    }
}

Example (MID PST configuration for DETECTED FILTERBANK scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-detected-filterbank",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "timing_beam_id": "1",
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "DETECTED_FILTERBANK",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            },
            "df": {
                "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,
                "num_sk_config": 1,
                "sk_config": [{
                    "sk_range": [0.8, 0.9],
                    "sk_integration_limit": 100,
                    "sk_excision_limit": 25.0
                }]
            }
        }
    }
}

Example (MID PST configuration for VOLTAGE RECORDER scan 3.0)

{
    "interface": "https://schema.skao.int/ska-pst-configure/3.0",
    "common": {
        "config_id": "sbi-mvp01-20240111-voltage-recorder",
        "subarray_id": 1,
        "eb_id": "eb-x321-20240111-10012",
        "frequency_band": "5b"
    },
    "pst": {
        "scan": {
            "timing_beam_id": "1",
            "centre_frequency": 10550000000.0,
            "total_bandwidth": 2496345600.0,
            "observer_id": "jdoe",
            "project_id": "project1",
            "receiver_id": "receiver3",
            "max_scan_length": 20000.0,
            "subint_duration": 30.0,
            "receptors": ["SKA001", "SKA036"],
            "receptor_weights": [0.4, 0.6],
            "pst_processing_mode": "VOLTAGE_RECORDER",
            "delay_centre": [5109360.133, 2006852.586, -3238948.127],
            "target": {
                "target_name": "J1921+2153",
                "reference_frame": "icrs",
                "attrs": {
                    "c1": 290.43672917,
                    "c2": 21.884,
                    "epoch": 2000.0
                }
            }
        }
    }
}

Schema to validate the Pulsar Timing configuration.

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

type

object

properties

  • pst

PST configuration 3.0

PST specific parameters. To be borrowed from IICD

type

object

properties

  • scan

PST specific scan configuration parameters.

PST_scan_configuration_3.0

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_3.0

additionalProperties

True

PST_scan_configuration_3.0

PST specific scan configuration parameters.

type

object

properties

  • timing_beam_id

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

CSP LMC 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

  • 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

  • delay_centre

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

Units: metres Keyword: DELAY_CENTRE

type

array

items

type

number

  • 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

  • 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

items

allOf

type

array

items

type

number

  • pt

PST specific parameters for the ‘PULSAR_TIMING’ mode configuration.

PST_PULSAR_TIMING_mode_configuration_3.0

  • df

PST specific parameters for the ‘DETECTED_FILTERBANK’ mode configuration.

PST_DETECTED_FILTERBANK_mode_configuration_3.0

  • ft

PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.

PST_FLOW_THROUGH_mode_configuration_3.0

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

  • pm_c2

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

type

number

  • epoch

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

type

number

  • parallax

The parallax in seconds of arc.

type

number

  • radial_velocity

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

type

number

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

  • pm_c2

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

type

number

  • epoch

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

type

number

  • parallax

The parallax in seconds of arc.

type

number

  • radial_velocity

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

type

number

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

  • 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

Removed in version 4.0.

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. Use a pair of channel index values instead.

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

  • 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, or 16 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

  • 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

  • num_sk_config

Removed in version 4.0.

type

integer

  • requantisation_scale

Removed in version 4.0.

type

number

  • requantisation_length

Removed in version 4.0.

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. These are used in both FLOW_THROUGH and DETECTED_FILTERBANK processing modes.

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

Minimum and maximum (inclusive) index values of the contiguous frequency channel range that will be recorded. Channel index values uniquely identify fine frequency channels transmitted from the CBF tied-array beam former to the PST. In the case of Mid CBF, these must comply with ADR-99.

Keyword: CHAN_FT

type

array

items

type

integer

  • polarisations

The polarisations to be recorded.

Valid values: X, Y, or Both Keyword: POLN_FT

type

string

additionalProperties

True

PST_Rescale_configuration_3.0

PST specific parameters used for rescaling of data before requantisation. These are used in both FLOW_THROUGH and DETECTED_FILTERBANK processing modes.

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

  • 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

  • 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

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.

Cannot exceed the number of bits per sample from the tied-array beamformer, which is 16 bits on Low and Mid Bands 1, 2, and 3, and 8 bits on Mid Bands 4 and 5.

Range: 1, 2, 4, 8, or 16 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

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

  • subarray_id

The Subarray ID that the list of receptors will be assigned to.

For Mid, there are a maximum of 16 subarrays.

Range: Integer from 1-16 inclusive

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