Mid TMC configure 4.0

Example JSON.

{
    "interface": "https://schema.skao.int/ska-tmc-configure/4.0",
    "transaction_id": "",
    "pointing": {
        "target": {
            "reference_frame": "ICRS",
            "target_name": "Polaris Australis",
            "ra": "21:08:47.92",
            "dec": "-88:57:22.9",
            "ca_offset_arcsec": 0.0,
            "ie_offset_arcsec": 0.0
        },
        "correction": "UPDATE"
    },
    "dish": {
        "receiver_band": "1"
    },
    "csp": {
        "interface": "https://schema.skao.int/ska-csp-configurescan/4.0",
        "common": {
            "config_id": "sbi-mvp01-20200325-00001-science_A",
            "frequency_band": "1"
        },
        "midcbf": {
            "frequency_band_offset_stream1": 80,
            "correlation": {
                "processing_regions": [{
                    "fsp_ids": [1, 2, 3, 4],
                    "receptors": ["SKA063", "SKA001", "SKA100"],
                    "start_freq": 350000000,
                    "channel_width": 13440,
                    "channel_count": 52080,
                    "sdp_start_channel_id": 0,
                    "integration_factor": 1
                }, {
                    "fsp_ids": [1],
                    "start_freq": 548437600,
                    "channel_width": 13440,
                    "channel_count": 14880,
                    "sdp_start_channel_id": 1,
                    "integration_factor": 10
                }]
            },
            "vlbi": {}
        }
    },
    "sdp": {
        "interface": "https://schema.skao.int/ska-sdp-configure/0.4",
        "scan_type": "target:a"
    },
    "tmc": {
        "scan_duration": 10.0,
        "partial_configuration": false
    }
}

https://schema.skao.int/ska-tmc-configure/4.0

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • transaction_id

A transaction id specific to the command

type

string

default

null

  • pointing

Pointing configuration specification.

type

object

default

null

properties

  • target

Target configuration coordinates

type

object

default

null

properties

  • reference_frame

Target coordinates reference frame.

Validation of reference_frame is case sensitive. Allowed values are:

  • ICRS: target coordinates are specified using the International Celestial Reference System (ICRS).

  • special: target coordinates are to be determined at runtime via a KatPoint lookup. Setting reference_frame=’special’ requires that the target name be a valid object in the KatPoint catalogue. Any target RA and dec provided will be ignored when reference_frame=’special’.

type

string

  • target_name

celestial source

type

string

default

null

  • ra

Pointing Right Ascension coordinates.

type

string

default

null

  • dec

Pointing Declination coordinates.

type

string

default

null

  • ca_offset_arcsec

Cross-elevation offset in arcseconds from the central pointing pointing defined by target’s ra+dec.

This is an optional field; if omitted, an offset of 0 arcseconds can be assumed.

type

number

default

null

  • ie_offset_arcsec

Elevation offset in arcseconds from the central pointing position defined by the ra+dec pair.

This is an optional field; if omitted, an offset of 0 arcseconds can be assumed.

type

number

default

null

additionalProperties

False

  • correction

Optional operation to apply to the pointing correction model. Allowed values are MAINTAIN, UPDATE, and RESET, which have the following meaning:

  • MAINTAIN: continue applying the current pointing correction model

  • UPDATE: wait for (if necessary) and apply new pointing calibration solution

  • RESET: reset the applied pointing correction to the pointing model defaults

Validation of correction values is case sensitive.

If pointing.correction is not specified, the default operation is to make no change to the pointing correction model, equivalent to setting correction=MAINTAIN.

type

string

default

null

additionalProperties

False

  • dish

Dish band configuration

type

object

default

null

properties

  • receiver_band

Dish Receiver band configuration

type

string

additionalProperties

False

  • csp

CSP configuration specification.

type

object

default

null

properties

  • interface

type

string

  • transaction_id

A transaction id specific to the command

type

string

default

null

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

  • midcbf

Correlator and Beamformer specific parameters. This section contains the parameters relevant only for CBF sub-element. This section is forwarded only to CBF subelement. Most of it to be borrowed from IICD

Mid CBF config 4.0

  • pss

default

null

PSS configuration 4.0

  • pst

Pulsar Timing specific parameters. To be borrowed from IICD

type

object

default

null

properties

  • scan

Pulsar Timing specific scan configuration parameters.

default

null

PST scan configuration 4.0

  • beam

Pulsar Timing specific beam configuration parameters.

As of version 2.3 this schema has no elements and is deprecated

default

null

PST beam configuration 4.0

additionalProperties

False

additionalProperties

False

  • sdp

SDP configuration specification.

type

object

default

null

properties

  • interface

type

string

default

null

  • transaction_id

type

string

pattern

^txn\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

default

null

  • scan_type

type

string

  • new_scan_types

type

array

default

null

items

type

object

properties

  • scan_type_id

const

(any scan type)

  • derive_from

type

string

  • beams

type

object

additionalProperties

False

additionalProperties

False

  • tmc

TMC Mid TMC configuration specification.

type

object

default

null

properties

  • scan_duration

Scan duration in seconds.

Value must be >= 0.0

type

number

default

null

  • partial_configuration

Partial Configuration Flag.

Partial configurations assume that previously set state is maintained, and undergo less strict JSON validation.

type

boolean

default

null

additionalProperties

False

additionalProperties

False

Common configuration schema 4.0

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

type

object

properties

  • config_id

type

string

  • eb_id

Execution block ID to associate scan configs to an observation.

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

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

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

type

string

pattern

^eb\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

default

null

  • band_5_tuning

Center frequency for the Band-of-Interest. Required if Band is 5a or 5b; not specified for other Bands (not configurable for Band 1 and 2).

Input for Band 5a and 5b consists of two 2.5 GHz streams; the center frequency can be independently tuned for each stream.

The following nomenclature is used to refer to Band 5a and 5b streams: 5a1, 5a2, 5b1, 5b2.

type

array

default

null

items

type

number

  • frequency_band

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

Valid bands include: 1, 2, 5a, 5b. Bands 3 and 4 are not included in the current implementation but could be supported in the future.

type

string

pattern

^(1|2|5(a|b))$

additionalProperties

False

Mid CBF config 4.0

Correlator and Beamformer specific parameters. This section contains the parameters relevant only for CBF sub-element. This section is forwarded only to CBF subelement. Most of it to be borrowed from IICD

type

object

properties

  • frequency_band_offset_stream1

Optionally, an offset can be specified so that the entire observed band is shifted in Hz (to accommodate a Zoom Window that crosses a ‘natural’ Frequency Slice boundary). If specified, applies for all the receptors in the sub-array.

Bands 1 and 2: input from the receptor consists of a single data stream; the Frequency Band Offset (FBO) should be specified for Stream 1 only.

Bands 5a and 5b: input from the receptor consists of two data streams; the FBO can be specified for each stream independently. Note: For Band 5a and 5b the frequency shift is performed by the receptor (DISH).

Range: Integer from -100000000 to 100000000 inclusive (+/- 0.5 * Frequency Slice BW)

type

integer

default

null

  • frequency_band_offset_stream2

See frequencyBandOffsetStream1

Range: Integer from -100000000 to 100000000 inclusive (+/- 0.5 * Frequency Slice BW)

type

integer

default

null

  • correlation

Correlation specific parameters

Correlation config 4.0

  • vlbi

Very Long Baseline Interferometry specific parameters. To be borrowed from IICD This section contains the parameters relevant only for VLBI. This section is forwarded only to CSP subelement.

default

null

VLBI config 4.0

additionalProperties

False

Correlation config 4.0

Correlation specific parameters

type

object

properties

  • processing_regions

type

array

items

Parameters that define a processing region of spectrum

Correlation Processing Region config 4.0

additionalProperties

False

Correlation Processing Region config 4.0

Parameters that define a processing region of spectrum

type

object

properties

  • fsp_ids

List of FSPs to be used for the processing region

For non-zoom, the limit is 13 because that is the number of FSPs needed to process data from one 2.5 GHz sub-band, which is the maximum bandwidth that can be stitched together. Band 5 sub-bands (a and b) cannot be combined in a single processing region.

Ranges:

Array Length: Array of 1 to 26 Integers inclusive

Array Element: Integer from 1 to 27 inclusive

Notes: AA0.5 supports an array of 1 to 4 integers AA1 supports an array of 1 to 8 integers

type

array

items

type

integer

  • receptors

Optionally a subset of receptors to be correlated can be specified. If not specified, all receptors that belong to the subarray are cross-correlated (i.e. visibilities for all the baselines in the subarray are generated and transmitted to SDP).

Valid receptor IDs include:

SKA dishes: “SKAnnn”, where nnn is a zero padded integer in the range of 001 to 133.

MeerKAT dishes: “MKTnnn”, where nnn is a zero padded integer in the range of 000 to 063.

type

array

default

null

items

anyOf

type

string

pattern

^SKA((?!000)0[0-9][0-9]|1[0-2][0-9]|13[0-3])$

type

string

pattern

^MKT0([0-5][0-9]|6[0-3])$

  • start_freq

Center frequency of the first fine channel in the output product in Hz.

Note: Range for start_freq has been specified to cover the frequency range of all bands, however the entire processing region ((start_freq - channel_width/2) + channel_width * channel_count) must fall within the frequency range for the band specified for the scan configuration

Range: Integer from 350000000 to 15400000000 inclusive

type

integer

  • channel_width

The width of each fine channel in Hz.

Allowed channel widths are a fraction/multiple of the default fine channel bandwidth: 13440 Hz.

Zoom mode will use channel width less than 13440 Hz.

Channel averaging will use channel width more than 13440 Hz.

Range: Enum value that is one of:

210
420
840
1680
3360
6720
13440
26880
40320
53760
80640
107520
161280
215040
322560
416640
430080
645120

Note: AA0.5/1 only supports 13440 channel width value

type

integer

  • channel_count

Number of fine channels in the output product.

Range: Integer from 1 to 2147483647 inclusive

Note: AA0.5/1: Integer from 1 to 58982 inclusive and must be a multiple of 20

type

integer

  • sdp_start_channel_id

In the output products (visibility packets) sent to SDP, Mid.CBF will number channels sequentially in increments of 1 starting at the sdp_start_channel_id.

sdp_start_channel_id allows TMC to configure Mid.CBF to provide SDP with unique channel IDs for every channel in a sub-array when multiple processing regions are used. Mid.CBF does not require or validate that each channel in a sub-array will have a unique channel ID. The channel ID provided to SDP will be the zero based channel number within the processing region plus the sdp_start_channel_id specified for the processing region. This means the channel with the center frequency of start_freq will have a channel ID of sdp_start_channel_id.

Range: Integer from 0 to 2147483647 inclusive

type

integer

  • integration_factor

Integration time for the correlation products, defines multiple of 140 milliseconds.

Range: Integer from 1-10 inclusive

type

integer

additionalProperties

False

VLBI config 4.0

Very Long Baseline Interferometry specific parameters. To be borrowed from IICD This section contains the parameters relevant only for VLBI. This section is forwarded only to CSP subelement.

type

object

properties

  • dummy_param

type

string

additionalProperties

False

PSS configuration 4.0

type

object

properties

  • beam_bandwidth

Beam bandwidth (MHz)

type

integer

  • channels_per_beam

Number of channels per beam

type

integer

  • acceleration_search

Processing Mode: Acceleration Search (a.k.a. Pulsar Search) and Single Pulse Search (a.k.a. Transient Search) can be performed concurrently.

type

boolean

  • single_pulse_search

Processing Mode: Acceleration Search (a.k.a. Pulsar Search) and Single Pulse Search (a.k.a. Transient Search) can be performed concurrently.

type

boolean

  • integration_time

Scan duration.

type

integer

  • acc_range

Range in source acceleration to be searched.

type

integer

default

null

  • number_of_trials

Number of trials to be performed.

type

integer

  • time_resolution

Time resolution of input data.

type

integer

  • ps_dm

Dispersion corretion for acceleration search.

type

number

  • sps_dm

Dispersion corretion for transient search.

type

number

  • timesample_per_block

Number of time samples in each block of data.

type

integer

  • sub_bands

Number of frequency band groups summed up during folding.

type

integer

  • buffer_size

Size of the buffer receiving raw data. (2**buffer_size)

type

integer

  • hsum_control

Number of the “harmonic folds” on the initial Fourier power-spectrum summed up.

type

integer

  • cxft_control

CXFT control parameters.

type

object

  • cand_sift

Constraints on matches between candidates.

type

object

  • cand_output

Define data sinks and subscriber to be notified.

type

object

  • sp_threshold

Threshold for a single pulse trigger. (Tuned to system noise and RFI env.)

type

number

  • sp_opt_pars

Single pulse optimization parameters.

type

object

  • dred_beam_stats

DRED: statistics of spectra to derive the normalization factors.

type

object

  • cdos_control

CDOS: control parameters and related statistical data.

type

object

  • rfim_control

RFIM control parameters.

type

object

  • fldo_control

FLDO control parameters.

type

object

properties

  • phase_split

type

boolean

  • channel_scale

type

boolean

  • max_phases

type

integer

additionalProperties

False

  • beam

type

array

items

PSS beam config 4.0

additionalProperties

False

PSS beam config 4.0

type

object

properties

  • beam_id

Search Beam ID.

type

integer

  • ra

Right Ascension of sub-array beam target, in degrees.

type

number

default

null

  • dec

Declination of sub-array beam target, in degrees.

type

number

default

null

  • reference_frame

reference frame for pointing coordinates

default

null

allOf

type

string

enum

ICRS, HORIZON

  • centre_frequency

Centre frequency of the search beam.

type

number

  • beam_delay_centre

Beam delay center, relative to the array delay center.

anyOf

type

number

type

string

  • dest_host

Per beam destination host address for PSS output.

type

string

default

null

  • dest_port

Per beam destination port for PSS output.

type

integer

default

null

additionalProperties

False

PST scan configuration 4.0

Pulsar Timing specific scan configuration parameters.

type

object

properties

  • activation_time

Date and time when to start the PST reconfiguration.

Units: UTC timestamp Keyword: ACTIVATION_TIME

type

string

  • timing_beam_id

Identifier assigned by LMC/TM used to identify the beam configuraiton.

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

default

null

  • bits_per_sample

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

Valid values are 16, 24, or 32.

Keyword: NBIT

type

integer

  • num_of_polarizations

The number of polarizations in the CBF output data.

Valid values are 1 or 2.

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_NSMAP

Range: 4 (Low), 32 (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.

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

type

integer

  • udp_nchan

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

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

Range: 1 to 82944 Keyword: OBSNCHAN

type

integer

  • centre_frequency

Centre frequency of to 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 observation mode used for the scan.

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

Keyword: OBSMODE

allOf

type

string

enum

PULSAR_TIMING, DYNAMIC_SPECTRUM, FLOW_THROUGH, VOLTAGE_RECORDER

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

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.

Units: metres Keyword: ITRF

type

array

items

type

number

  • receiver_id

The receiver name or ID (instrument).

Keyword: FRONTEND

type

string

  • feed_polarization

The native polarization of feed.

Range: LIN or CIRC Keyword: FD_POLN

allOf

type

string

enum

LIN, CIRC

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

Range: -1 or +1 Keyword: FD_HAND

allOf

type

integer

enum

-1, 1

  • 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 focuse receiver).

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 cordinate mode is GALATIC, 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.

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

allOf

type

string

enum

FA, CPA, SPA, TPA

  • 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 (parallic angle = 0) or with respect to the Galactic north for coordinate_mode = ‘GALACTIC’.

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]).

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 equitorial tracking which means uses RA/Dec J2000.0 coords but PST may support different tracking modes and coordinates the future.

PST RA_Dec coordinates 4.0

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

Range: 0 - 1024 Keyword: NMASK

type

integer

default

0

  • rfi_frequency_masks

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

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

The overall dimension of this array is num_frequency_mask x 2.

Units: Hz Keyword: FREQ_MASK

type

array

default

null

items

type

array

items

type

number

  • destination_address

The destination address for the PST output data.

Includes IPv4 Address, port number.

type

array

default

null

items

anyOf

type

string

type

integer

  • test_vector_id

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

Keyword: TEST_VECTOR

type

string

default

null

  • pt

Pulsar Timing specific parameters for the ‘PULSAR_TIMING’ mode configuration.

default

null

PST ‘PULSAR_TIMING’ mode configuration 4.0

  • ds

Pulsar Timing specific parameters for the ‘DYNAMIC_SPECTRUM’ mode configuration.

default

null

PST ‘DYNAMIC_SPECTRUM’ mode configuration 4.0

  • ft

Pulsar Timing specific parameters for the ‘FLOW_THROUGH’ mode configuration.

default

null

PST ‘FLOW_THROUGH’ mode configuration 4.0

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

Keyword: NSTAGE

type

integer

  • channelization_stages

List of configuration for each channelization stage.

type

array

items

Pulsar Timing specific parameters for channelization stage configuration.

PST channelization stage configuration 4.0

additionalProperties

False

PST RA_Dec coordinates 4.0

Pulsar Timing 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

default

2000.0

  • 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

False

PST ‘PULSAR_TIMING’ mode configuration 4.0

Pulsar Timing specific parameters for the ‘PULSAR_TIMING’ mode configuration.

type

object

properties

  • dispersion_measure

The dispersion measure for coherent/inchoerent de-dispersion.

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

type

number

  • rotation_measure

The rotation measure for phase-coherent Faraday rotation correction.

Units: radians per metre squared Keyword: RM

type

number

default

null

  • ephemeris

The ephemeris of the pulsar being observed.

Units: PSRCAT compatible ASCII string Keyword: EPHEMERIS

type

string

  • pulsar_phase_predictor

Pulsar phase predictor generated from ephemeris.

Units: TEMPO2 compatible ASCII string Keyword: PREDICTOR

type

string

  • output_frequency_channels

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

Keyword: OUTNCHAN

type

integer

  • output_phase_bins

The number of output phase bins.

Range: 64 - 2048 Keyword: OUTNBIN

type

integer

  • num_sk_config

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

Keyword: N_SK

type

integer

  • sk_config

List of spectral kurtosis configurations.

type

array

items

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

PST spectral kurtosis configuration 4.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

False

PST spectral kurtosis configuration 4.0

Pulsar Timing 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

False

PST ‘DYNAMIC_SPECTRUM’ mode configuration 4.0

Pulsar Timing specific parameters for the ‘DYNAMIC_SPECTRUM’ mode configuration.

type

object

properties

  • dispersion_measure

The dispersion measture for coherent/inchoerent 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

default

null

  • output_frequency_channels

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

Keyword: OUTNCHAN

type

integer

  • stokes_parameters

The Stokes parameters to output when in 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

allOf

type

integer

enum

1, 2, 4, 8, 16, 32

  • 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

default

null

  • sk_config

List of spectral kurtosis configurations.

type

array

default

null

items

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

PST spectral kurtosis configuration 4.0

  • requantisation_scale

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

Keyword: DIGITIZER_SCALE

type

number

  • requantisation_length

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

Units: seconds Keyword: DIGITIZER_LENGTH

type

number

additionalProperties

False

PST ‘FLOW_THROUGH’ mode configuration 4.0

Pulsar Timing 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

allOf

type

integer

enum

1, 2, 4, 8, 16, 32

  • 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 16 and 32 bits per sample, by default the data will be scaled such that the maximum fixed precision output value (2^{num_bits_out-1}) corresponds to 6 times the standard deviation.

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

allOf

type

string

enum

A, B, Both

  • 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

False

PST channelization stage configuration 4.0

Pulsar Timing specific parameters for channelization stage configuration.

type

object

properties

  • num_filter_taps

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

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.

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.

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]).

Keyword: OVERSAMP_k

type

array

items

type

integer

additionalProperties

False

PST beam configuration 4.0

Pulsar Timing specific beam configuration parameters.

As of version 2.3 this schema has no elements and is deprecated

type

object

properties

additionalProperties

False