CSP configure 2.0

JSON schema and example for CSP Low configure

LOWCSP configure 2.0

Example JSON (LOW CSP Configuration for CBF 0.1)

{
    "interface": "https://schema.skao.int/ska-low-csp-configure/2.0",
    "subarray": {
        "subarray_name": "science period 23"
    },
    "common": {
        "config_id": "sbi-mvp01-20200325-00001-science_A",
        "subarray_id": 1,
        "eb_id": "eb-x449-20231105-34696"
    },
    "lowcbf": {
        "stations": {
            "stns": [
                [1, 0],
                [2, 0],
                [3, 0],
                [4, 0]
            ],
            "stn_beams": [{
                "beam_id": 1,
                "freq_ids": [64, 65, 66, 67, 68, 69, 70, 71],
                "boresight_dly_poly": "tango://delays.skao.int/low/stn-beam/1"
            }]
        },
        "zooms": "tbd"
    },
    "pss": {},
    "pst": {
        "beams": []
    }
}

Example JSON (CSP configuration for PST voltage recorder scan 2.4)

{
    "interface": "https://schema.skao.int/ska-low-csp-configure/2.0",
    "subarray": {
        "subarray_name": "science period 23"
    },
    "common": {
        "config_id": "sbi-mvp01-20200325-00001-science_A",
        "subarray_id": 1,
        "eb_id": "eb-x449-20231105-34696"
    },
    "lowcbf": {
        "stations": {
            "stns": [
                [1, 0],
                [2, 0],
                [3, 0],
                [4, 0]
            ],
            "stn_beams": [{
                "beam_id": 1,
                "freq_ids": [64, 65, 66, 67, 68, 69, 70, 71],
                "boresight_dly_poly": "tango://delays.skao.int/low/stn-beam/1"
            }]
        },
        "timing_beams": {
            "beams": [{
                "pst_beam_id": 13,
                "stn_beam_id": 1,
                "offset_dly_poly": "url",
                "stn_weights": [0.9, 1.0, 1.0, 0.9],
                "jones": "url",
                "rfi_enable": [true, true, true],
                "rfi_static_chans": [1, 206, 997],
                "rfi_dynamic_chans": [242, 1342],
                "rfi_weighted": 0.87
            }]
        },
        "zooms": "tbd"
    },
    "pss": {},
    "pst": {
        "beams": [{
            "beam_id": 13,
            "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,
                "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]
                }]
            }
        }]
    }
}

Low CSP specific parameters. This section contains the parameters relevant to configure the Low CSP sub-system.

https://schema.skao.int/ska-low-csp-configure/2.0

type

object

properties

  • interface

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

type

string

  • subarray

subarray 2.0

Subarray elements

type

object

properties

  • subarray_name

Name and scope of current subarray the sub-array.

type

string

additionalProperties

True

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

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

additionalProperties

True

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

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

additionalProperties

True

LOWCBF_subarray_configurescan_0.1

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

  • timing_beams

PST beam outputs descriptions

outer_0.1

  • search_beams

PSS beam outputs descriptions

type

string

  • visibilities

Visibilities description 0.1

Visibility output descriptions

type

object

properties

  • fsp

FSP 0.1

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

additionalProperties

True

  • zooms

placeholder zoom visibility output descriptions

type

string

additionalProperties

True

Subarray_stations_and_station_beams_0.1

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

type

object

properties

  • beam_id

station beam id

type

integer

  • freq_ids

list of station beam frequency ids

type

array

items

type

integer

  • boresight_dly_poly

URL

type

string

additionalProperties

True

additionalProperties

True

outer_0.1

PST Outer

type

object

properties

  • beams

inner

type

array

items

PST_beams_description_0.1

additionalProperties

True

PST_beams_description_0.1

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

anyOf

ICRS sky direction 0.1

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.1*

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 0.1

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.1*

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

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.1*

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 0.1

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

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.1*

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

  • jones

Jones matrix source URI

type

string

  • stn_weights

weights for each station

type

array

items

type

number

  • rfi_enable

Master enable for RFI flagging

type

array

items

type

boolean

  • rfi_static_chans

Freqency IDs to be always flagged

type

array

items

type

integer

  • rfi_dynamic_chans

Frequency IDs to be dynamically flagged

type

array

items

type

integer

  • rfi_weighted

Parameter for dynamic flagging

type

number

  • firmware

Firmware name

type

string

  • offset_dly_poly

Delay polynomial source URI

type

string

additionalProperties

True

Station_beams_to_correlate_0.1

type

object

properties

  • stn_beam_id

Station Beam ID

type

integer

  • integration_ms

milliseconds integration

type

integer

  • host

SDP channel & IP Address

type

array

items

type

array

items

anyOf

type

integer

type

string

  • port

SDP chan & UDP port, stride

type

array

items

type

array

items

type

integer

  • mac

SDP channel & server MAC

type

array

items

type

array

items

anyOf

type

integer

type

string

additionalProperties

True

PST_configure_2.4

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 2.4

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.

PST_scan_configuration_2.4

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

additionalProperties

True

additionalProperties

True

PST_scan_configuration_2.4

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.

This attribute is mandatory on only the CSP-PST interface.

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

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

  • ds

PST specific parameters for the ‘DETECTED_FILTERBANK’ mode configuration.

PST_DETECTED_FILTERBANK_mode_configuration_2.4

  • ft

PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.

PST_FLOW_THROUGH_mode_configuration_2.4

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

additionalProperties

True

PST_RA_Dec_coordinates_2.4

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

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

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

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

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

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

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

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

  • num_channels

The number of input channels to be recorded. This value must be less than or equal to the output_frequency_channels.

Keyword: NCHAN_FT

type

integer

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

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

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