Mid TMC configure 4.2

Example JSON.

{
    "interface": "https://schema.skao.int/ska-tmc-configure/4.2",
    "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",
        "groups": [{
            "receptors": ["SKA001", "SKA036", "SKA063"],
            "field": {
                "target_name": "Cen-A",
                "reference_frame": "ICRS",
                "attrs": {
                    "c1": 201.365,
                    "c2": -43.0191667
                }
            },
            "trajectory": {
                "name": "fixed",
                "attrs": {
                    "x": 1.23,
                    "y": 4.56
                }
            },
            "projection": {
                "name": "SSN",
                "alignment": "ICRS"
            }
        }, {
            "receptors": ["SKA100"],
            "field": {
                "target_name": "Cen-A",
                "reference_frame": "ICRS",
                "attrs": {
                    "c1": 201.365,
                    "c2": -43.0191667
                }
            },
            "trajectory": {
                "name": "constant-velocity",
                "attrs": {
                    "x_rate": 1.23,
                    "y_rate": 4.56
                }
            },
            "projection": {
                "name": "SSN",
                "alignment": "ICRS"
            }
        }],
        "ie_offset_arcsec": 5.0,
        "ca_offset_arcsec": -5.0,
        "wrap_sector": 0
    },
    "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.2
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
pointing	Pointing configuration specification.
	type	object
	properties
	wrap_sector	Cable wrap sector, with allowed values 0 and -1. wrap_sector= 0 means move to the sector that allows the most clockwise rotation, the sector that allows azimuth 0 to +270 degrees. wrap_sector= -1 means move to the other sector, the sector that allows azimuth 0 to -270 degrees. If pointing.wrap_sector is not in the JSON, TMC will make no sector change.
		allOf	type	integer
	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
	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
	groups	Receptor groups definitions. Receptors assigned to a receptor group can be steered as a whole around the sky. Objects and attributes within the receptor group define the pointing coordinate and tracking/mapping strategy to use for the group.
		type	array
		items	type	object
			properties
			receptors	List of receptor IDs to assign to the receptor group for the upcoming scan. List values must be valid SKA receptor IDs, e.g., [“SKA001”, “SKA063”].
				type	array
				default	null
				items	type	string
			field	A union of the various standard sky direction representations supported by SKA, as defined in ADR-63.
				default	null
				Sky direction
			trajectory	A union of the various standard trajectories supported by SKA, as defined in ADR-106.
				default	null
				Trajectory
			projection	type	object
				default	SIN
				properties
				name	Projection type. Must be one of ‘SIN’, ‘TAN’, ‘ARC’, ‘STG’, ‘CAR’, or ‘SSN’, though values are not case sensitive. Defaults to ‘SIN’. The following projections are implemented: Orthographic (SIN): This is the standard projection in aperture synthesis radio astronomy, as it ties in closely with the 2-D Fourier imaging equation and the resultant (l, m) coordinate system. It is the simple orthographic projection of AIPS. Gnomonic (TAN): This is commonly used in optical astronomy. Great circles are projected as straight lines, so that the shortest distance between two points on the sphere is represented as a straight line interval (non-uniformly divided though). Zenithal equidistant (ARC): This is commonly used for single-dish maps, and is obtained if relative (cross-el, el) coordinates are directly plotted (cross-elevation is azimuth scaled by the cosine of elevation).It preserves angular distances from the reference point. Stereographic (STG): This is useful to represent polar regions and large fields. It preserves angles and circles. Plate carree (CAR): This is a very simple cylindrical projection that directly maps azimuth and elevation to a rectangular (x, y) grid, and returns offsets from the reference point on this plane. The x offset is therefore equal to the azimuth offset, while the y offset is equal to the elevation offset. It does not preserve angles, distances or circles. Swapped orthographic (SSN): This is the standard SIN projection with the roles of reference and target points reversed. It is useful for holography and other beam pattern measurements where a dish moves relative to a fixed beacon but the beam pattern is referenced to the boresight of the moving dish.
					allOf	type	string
				alignment	Projection alignment
					type	string
				additionalProperties	True
			additionalProperties	True
	target	DEPRECATED Target coordinates This field has been superseded by pointing.groups and is deprecated from schema version 4.1. If pointing.groups is present, any value provided in pointing.target will be ignored.
		type	object
		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’.
			allOf	type	string
		target_name	celestial source
			type	string
		ra	Pointing Right Ascension coordinates.
			type	string
		dec	Pointing Declination coordinates.
			type	string
		ca_offset_arcsec	DEPRECATED: use pointing.ca_offset_arcsec. If both pointing.ca_offset_arcsec and pointing.target.ca_offset_arcsec are set, then pointing.ca_offset_arcsec takes priority. 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
		ie_offset_arcsec	DEPRECATED: use pointing.ie_offset_arcsec. If both pointing.ie_offset_arcsec and pointing.target.ie_offset_arcsec are set, then pointing.ie_offset_arcsec takes priority. 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
		additionalProperties	True
	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.
		allOf	type	string
	additionalProperties	True
csp	CSP configuration specification.
	type	object
	properties
	interface	type	string
	transaction_id	A transaction ID specific to the command
		type	string
	subarray	subarray section, containing the parameters relevant only for the current sub-array device. This section is not forwarded to any subelement.
		type	object
		properties
		subarray_name	Name and scope of current subarray the sub-array.
			type	string
		additionalProperties	False
	pss	type	object
		properties
		beam	type	array
			items	PSS_beam_config_0.1
		interface	URI of JSON schema for this command’s JSON payload.
			type	string
		additionalProperties	False
	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 Mid.CBF sub-element. This section is forwarded only to Mid.CBF subelement.
		Mid.CBF_config_4.0
	pst	PST specific parameters. To be borrowed from IICD
		type	object
		properties
		scan	PST specific scan configuration parameters.
			PST_scan_configuration_2.5
		beam	PST specific beam configuration parameters. Deprecated: As of version 2.3 this schema has no elements and is deprecated, and has been removed in version 3.0 of the schema.
			PST_beam_configuration_2.5
		additionalProperties	False
	additionalProperties	False
sdp	SDP configuration specification.
	type	object
	properties
	interface	type	string
	transaction_id	type	string
	scan_type	type	string
	new_scan_types	type	array
		items	A scan configuration for SDP. Once AssignResources has been performed successfully, subsequent Configure commands can select from these scan types in order to coordinate SDP with other sub-systems participating in the observation - for instance to switch between targets, or perform special calibration scans.
			Scan_type_0.4
	additionalProperties	True
tmc	TMC Mid TMC configuration specification.
	type	object
	properties
	scan_duration	Scan duration in seconds. Value must be >= 0.0
		allOf	type	number
	partial_configuration	Partial Configuration Flag. Partial configurations assume that previously set state is maintained, and undergo less strict JSON validation.
		type	boolean
	additionalProperties	True
dish	Dish band configuration
	type	object
	properties
	receiver_band	Dish Receiver band configuration
		type	string
	additionalProperties	True
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_4.2
	A sky direction defined in the AltAz reference frame
	AltAz_sky_direction_4.2
	A sky direction defined in the Galactic reference frame.
	Galactic_sky_direction_4.2
	A sky direction whose coordinates are defined in Katpoint.
	Special_sky_direction_4.2
	A sky direction defined by a Two-Line Element (TLE) set.
	Two_Line_Element_sky_direction_4.2

ICRS_sky_direction_4.2

A sky direction defined in the ICRS reference frame.

type	object
properties
target_name	A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.
	type	string
reference_frame	Must be “icrs” for a sky direction defined in the ICRS reference frame. Validation is case-insensitive.
	type	string
attrs	Attributes for an ICRS sky direction
	type	object
	properties
	c1	The longitude coordinate, specifying degrees right ascension in the ICRS reference frame. Value must be in the range 0 <= c1 < 360.
		type	number
	c2	The latitude coordinate, specifying degrees declination in the ICRS reference frame. Value must be in the range -90 <= c2 <= 90.
		type	number
	pm_c1	Longitudinal proper motion of target, measured in arcseconds per year.
		type	number
		default	0.0
	pm_c2	Latitudinal proper motion of target, measured in arcseconds per year.
		type	number
		default	0.0
	epoch	Epoch of proper motion, giving the date when the proper motion offset was zero.
		type	number
		default	2000.0
	parallax	The parallax in seconds of arc.
		type	number
		default	0.0
	radial_velocity	Radial velocity along the line of sight in m/s.
		type	number
		default	0.0
	additionalProperties	True
additionalProperties	True

AltAz_sky_direction_4.2

A sky direction defined in the AltAz reference frame

type	object
properties
target_name	A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.
	type	string
reference_frame	Fixed as “altaz” for a sky direction defined in the AltAz reference frame. Validation is case-insensitive.
	type	string
attrs	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_4.2

A sky direction defined in the Galactic reference frame.

type	object
properties
target_name	A name for the target. If reference_frame is ‘special’ or ‘tle’ then the name might be of a solar system body or a satellite in Earth orbit.
	type	string
reference_frame	Must be “galactic” for a sky direction defined in the Galactic reference frame. Validation is case-insensitive.
	type	string
attrs	Attributes for a Galactic sky direction
	type	object
	properties
	c1	The longitude coordinate, specifying degrees right ascension in the Galactic reference frame. Value must be in the range 0 <= c1 < 360.
		type	number
	c2	The latitude coordinate, specifying degrees declination in the Galactic reference frame. Value must be in the range -90 <= c2 <= 90.
		type	number
	pm_c1	Longitudinal proper motion of target, measured in arcseconds per year.
		type	number
		default	0.0
	pm_c2	Latitudinal proper motion of target, measured in arcseconds per year.
		type	number
		default	0.0
	epoch	Epoch of proper motion, giving the date when the proper motion offset was zero.
		type	number
		default	2000.0
	parallax	The parallax in seconds of arc.
		type	number
		default	0.0
	radial_velocity	Radial velocity along the line of sight in m/s.
		type	number
		default	0.0
	additionalProperties	True
additionalProperties	True

Special_sky_direction_4.2

A sky direction whose coordinates are defined in Katpoint.

type	object
properties
target_name	A name for the target. This should be the name of a resolvable entity in Katpoint, for example, the name of a solar system body.
	type	string
reference_frame	Must be “special” for a catalogue sky direction. Validation is case-insensitive.
	type	string
additionalProperties	True

Two_Line_Element_sky_direction_4.2

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

type	object
properties
target_name	A name for the target. For a TLE sky direction, this could be the name of a satellite in orbit.
	type	string
reference_frame	Must be “tle” for a sky direction defined in the TLE reference frame. Validation is case-insensitive.
	type	string
attrs	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

Trajectory

A union of the various standard trajectories supported by SKA, as defined in ADR-106.

anyOf	DEPRECATED - A mosaic consisting of a set of fixed-offsetpointings.
	Mosaic_trajectory___DEPRECATED_4.2
	A trajectory defined by a fixed offset from a reference coordinate.
	Fixed_offset_trajectory_4.2
	A trajectory defined by a constant velocity and fixed offsetfrom a reference coordinate.
	Constant_velocity_trajectory_4.2

Mosaic_trajectory___DEPRECATED_4.2

DEPRECATED - A mosaic consisting of a set of fixed-offsetpointings.

type	object
properties
name	Must be “mosaic” for a mosaic trajectory. Validation is case-insensitive.
	type	string
attrs	Attributes for a mosaic trajectory
	type	object
	properties
	x_offsets	x offsets in arcseconds from the reference fieldposition.
	y_offsets	y offset in arcseconds from the reference fieldposition.
	additionalProperties	True
additionalProperties	True

Fixed_offset_trajectory_4.2

A trajectory defined by a fixed offset from a reference coordinate.

type	object
properties
name	Must be “fixed” for a fixed-offset trajectory. Validation is case-insensitive.
	type	string
attrs	Attributes for a fixed-offset trajectory
	type	object
	properties
	x	Fixed x offset in arcseconds from the reference field position.
		type	string
	y	Fixed y offset in arcseconds from the reference field position.
		type	string
	additionalProperties	True
additionalProperties	True

Constant_velocity_trajectory_4.2

A trajectory defined by a constant velocity and fixed offsetfrom a reference coordinate.

type	object
properties
name	Must be “constant-velocity” for a constant velocity trajectory. Validation is case-insensitive.
	type	string
attrs	Attributes for a constant velocity trajectory
	type	object
	properties
	x	Initial x offset in arcseconds from the reference field position.
		type	string
		default	0.0
	y	Initial y offset in arcseconds from the reference field position.
		type	string
		default	0.0
	x_rate	x tracking rate in arcseconds per second.
		type	string
	y_rate	y tracking rate in arcseconds per second.
		type	string
	additionalProperties	True
additionalProperties	True

PSS_beam_config_0.1

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

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]+$
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
	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 Mid.CBF sub-element. This section is forwarded only to Mid.CBF subelement.

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
frequency_band_offset_stream2	See frequencyBandOffsetStream1 Range: Integer from -100000000 to 100000000 inclusive (+/- 0.5 * Frequency Slice BW)
	type	integer
rfi_flagging_mask	Specified as needed in advance of the scan start and/or during the scan. Delivered using publish-subscribe mechanism (see ICD Section 3.8.8.5.7).
	type	object
	properties
	additionalProperties	False
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.
	VLBI_config_4.0
search_window	type	array
	items	Up to two 300 MHz Search Windows can be optionally configured and used as input for Transient Data Capture and/or Pulsar Search beam-forming.
		Search_window_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

Search_window_config_4.0

Up to two 300 MHz Search Windows can be optionally configured and used as input for Transient Data Capture and/or Pulsar Search beam-forming.

type	object
properties
search_window_id	Identifier of the 300MHz Search Window. Unique within a sub-array.
	type	integer
search_window_tuning	The Search Window tuning is provided in absolute terms as RF center frequency. The Search Window must be placed within the observed band. If partially out of the observed Band a warning is generated. If completely outside of the observed Band an exception is generated.
	type	integer
additionalProperties	False

PST_scan_configuration_2.5

PST specific scan configuration parameters.

type	object
properties
activation_time	Date and time when to start the PST reconfiguration. Deprecated: this field has been removed in version 3.0 of the PST schema. This field has never been used by PST and was always ignored. Units: UTC timestamp Keyword: ACTIVATION_TIME
	type	string
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
	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. 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
	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. Deprecated: this field has been removed in version 3.0 of the PST schema. 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 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
	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 (parallactic angle = 0) or with respect to the Galactic north for coordinate_mode = ‘GALACTIC’. Deprecated: this field has been removed in version 3.0 of the PST schema. Range: -180 to +180. Keyword: FA_REQ
	type	number
oversampling_ratio	The oversampling ratio expressed as a fraction as an array of int, with the first value the numerator and the second is the denominator. (e.g. 8/7 is assigned as [8,7]). Deprecated: this field has been removed in version 3.0 of the PST schema. This can be inferred from the telescope and and frequency band. Range: 8/7 or 4/3 Keyword: OVERSAMP
	type	array
	items	type	integer
coordinates	The tied-array beam’s tracking co-ordinates. As of version 2.2 of the schema this only handles equatorial tracking which means uses RA/Dec J2000.0 coords but PST may support different tracking modes and coordinates the future.
	PST_RA_Dec_coordinates_2.5
max_scan_length	The maximum length of the observation. Units: seconds Range: 30 - 43200 Keyword: SCANLEN_MAX
	type	number
subint_duration	The length of each output sub-integration. Units: seconds Range: 1 - 60 Keyword: OUTSUBINT
	type	number
receptors	An array of receptor IDs for the receptors included in the sub-array. Keyword: ANTENNA
	type	array
	items	type	string
receptor_weights	Weight for each receptor. Range: 0 - 1.0 Keyword: ANT_WEIGHTS
	type	array
	items	type	number
num_rfi_frequency_masks	The number of frequency ranges to be masked. Deprecated: this field has been removed in version 3.0 of the PST schema. This is will be inferred by length of rfi_frequency_masks. Range: 0 - 1024 Keyword: NMASK
	type	integer
rfi_frequency_masks	A two-dimensional array of length of num_frequency_mask of known RFI frequency ranges to excise from the data. The array contains mask pairs of [f_min, f_max] pairs for known frequency ranges containing RFI not excised by the CBF. The overall dimension of this array is num_frequency_mask x 2. Units: Hz Keyword: FREQ_MASK
	type	array
	items	type	array
		items	type	number
destination_address	The destination address for the PST output data. Includes IPv4 Address, port number. Deprecated: this field has been removed in version 3.0 of the PST schema.
	type	array
	items	anyOf	type	string
			type	integer
test_vector_id	Identifier for a test vector that will be present in the tied-array beam data stream beam CBF and PST. Deprecated: This field has never been used and has been removed in version 3.0 of the PST schema. Keyword: TEST_VECTOR
	type	string
pt	PST specific parameters for the ‘PULSAR_TIMING’ mode configuration.
	PST_PULSAR_TIMING_mode_configuration_2.5
ds	PST specific parameters for the ‘DYNAMIC_SPECTRUM’ mode configuration.
	PST_DYNAMIC_SPECTRUM_mode_configuration_2.5
ft	PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.
	PST_FLOW_THROUGH_mode_configuration_2.5
num_channelization_stages	The number of stages used to channelize the data: e.g. * for Low, there are 2 stages: 1 in LFAA and 1 in CBF * for Mid, there are 2 stages: 1 in FSP and 1 in PST BF. Deprecated: This field has been removed in version 3.0 of the PST schema. The information for this field and channelization_stages can be inferred from the telescope and frequency band. Keyword: NSTAGE
	type	integer
channelization_stages	List of configuration for each channelization stage. Deprecated: This field has been removed in version 3.0 of the PST schema. The information for this field and num_channelization_stages can be inferred from the telescope and frequency band.
	type	array
	items	PST specific parameters for channelization stage configuration. Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema.
		PST_channelization_stage_configuration_2.5
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 TMC to PST capability id. Keyword: BEAM
	type	string
additionalProperties	False

PST_RA_Dec_coordinates_2.5

PST specific parameters for RA/Dec tracking coordinates.

type	object
properties
equinox	The coordinate epoch. This can be in Julian date or Modified Julian Date. Units: years Range: >= 2000 Keyword: EQUINOX
	type	number
ra	The Right Accession (RA) of the coordinates used for tracking. Valid formats is ‘hh:mm:ss.sss’ or ‘ddd.ddd’ Keyword: STT_CTD1
	type	string
dec	The declination (Dec) of the coordinates used for tracking. Valid formats is ‘hh:mm:ss.sss’ or ‘ddd.ddd’ Keyword: STT_CTD2
	type	string
additionalProperties	False

PST_PULSAR_TIMING_mode_configuration_2.5

PST specific parameters for the ‘PULSAR_TIMING’ mode configuration.

type	object
properties
dispersion_measure	The dispersion measure for coherent/incoherent de-dispersion. Units: pccm^-3 Range: 0 - 100000 Keyword: DM
	type	number
rotation_measure	The rotation measure for phase-coherent Faraday rotation correction. Units: radians per metre squared Keyword: RM
	type	number
ephemeris	The ephemeris of the pulsar being observed. Units: PSRCAT compatible ASCII string Keyword: EPHEMERIS
	type	string
pulsar_phase_predictor	Pulsar phase predictor generated from ephemeris. Units: TEMPO2 compatible ASCII string Keyword: PREDICTOR
	type	string
output_frequency_channels	The number of output frequency channels. This must be between 1 and the number of observation channels. Keyword: OUTNCHAN
	type	integer
output_phase_bins	The number of output phase bins. Range: 64 - 2048 Keyword: OUTNBIN
	type	integer
num_sk_config	The number of spectral kurtosis (SK) configurations to apply. Keyword: N_SK
	type	integer
sk_config	List of spectral kurtosis configurations.
	type	array
	items	PST specific parameters for the spectral kurtosis (SK) for the ‘PULSAR_TIMING’ mode.
		PST_spectral_kurtosis_configuration_2.5
target_snr	The signal-to-noise ratio (SNR) of the on-pulse flux for the scan. May be used to prematurely end a scan when the integrated SNR reaches the target. A value of 0 indicates there is no limit. Keyword: TARGET_SNR
	type	number
additionalProperties	False

PST_spectral_kurtosis_configuration_2.5

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

type	object
properties
sk_range	Frequency ranges for each spectral kurtosis (SK) configuration. Units: Hz Keyword: SK_RNG
	type	array
	items	type	number
sk_integration_limit	The number of input time samples integrated into each spectral kurtosis (SK) statistic. Range: 64 - 1024 Keyword: SK_INTS
	type	integer
sk_excision_limit	Spectral kurtosis excision limits (RFI threshold) in units of standard deviations. Range: 1 - 100 Keyword: SK_EXIS
	type	number
additionalProperties	False

PST_DYNAMIC_SPECTRUM_mode_configuration_2.5

PST specific parameters for the ‘DYNAMIC_SPECTRUM’ mode configuration.

type	object
properties
dispersion_measure	The dispersion measure for coherent/incoherent de-dispersion. This is only required for pulsar timing and dynamic spectrum modes. Range: [0, 100000] Keyword: DM
	type	number
rotation_measure	The rotation measure for phase-coherent Faraday rotation correction. Units: radians per metre squared Keyword: RM
	type	number
output_frequency_channels	The number of output frequency channels. This must be between 1 and the number of observation channels. Keyword: OUTNCHAN
	type	integer
stokes_parameters	The Stokes parameters to output when in Dynamic spectrum mode. Range: string with a combination of I, Q, U, and V. Keyword: STOKES_FB
	type	string
num_bits_out	The number of bits per output sample. Range: 1, 2, 4, 8, 16 or 32 Keyword: NBIT_OUT
	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
sk_config	List of spectral kurtosis configurations.
	type	array
	items	PST specific parameters for the spectral kurtosis (SK) for the ‘PULSAR_TIMING’ mode.
		PST_spectral_kurtosis_configuration_2.5
requantisation_scale	Scale factor to govern the dynamic range for fixed precision output to be applied during re-quantisation. Keyword: DIGITIZER_SCALE
	type	number
requantisation_length	Length of data to be used when determining the scaling factors used for fixed precision output during re-quantisation. Units: seconds Keyword: DIGITIZER_LENGTH
	type	number
additionalProperties	False

PST_FLOW_THROUGH_mode_configuration_2.5

PST specific parameters for the ‘FLOW_THROUGH’ mode configuration.

type	object
properties
num_bits_out	The number of bits per output sample. Range: 1, 2, 4, 8, 16 or 32 Keyword: NBIT_OUT
	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 more than 8 bits per sample, the values from Table 3 of Jenet & Anderson (1998) are extrapolated to num_bits_out-2, such that 2 bits are retained as additional headroom for RFI. For all num_bits_out, the standard deviation is that of either the real or imaginary part of each complex-valued sample. The default scale factor is computed such that, after multiplication by this scale factor, the data would satisfy the conditions described above. This default scale factor is multiplied by requantisation_scale. Therefore, a requantisation_scale value greater than 1 increases the value of the floating point data before it is cast to a fixed precision value, thereby reducing the overhead available to represent RFI and increasing the probability of clipping. Keyword: DIGITIZER_SCALE
	type	number
polarizations	The polarizations to be recorded. Valid values: A, B, or Both Keyword: POLN_FT
	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_2.5

PST specific parameters for channelization stage configuration.

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

type	object
properties
num_filter_taps	Total number of taps in the prototype filter (i.e. over all arms) used in the stage. Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema. This field can also be inferred from the length of the filter_coefficients field. Keyword: NSTAP_k
	type	integer
filter_coefficients	An array of filter coefficients that define the (time domain) response function of the prototype filter used in the stage. Length of this is num_filter_taps. Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema. Keyword: COEFF_k
	type	array
	items	type	number
num_frequency_channels	The number of frequency channels output by each polyphase filter bank (PFB) for this stage. Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema. This field can be determined by which telescope and frequency band. Keyword: NCHAN_PFB_k
	type	integer
oversampling_ratio	The oversampling ratio expressed as a fraction as an array of int, with the first value the numerator and the second is the denominator. (e.g. 8/7 is assigned as [8,7]). Deprecated: This field has been deprecated and has been removed in version 3.0 of PST schema. This field can be determined by which telescope and frequency band. Keyword: OVERSAMP_k
	type	array
	items	type	integer
additionalProperties	False

PST_beam_configuration_2.5

PST specific beam configuration parameters.

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

type	object
properties
additionalProperties	False

Scan_type_0.4

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

type	object
properties
scan_type_id	type	string
reference_frame	Specification of the reference frame or system for a set of pointing coordinates (see ADR-49)
	type	string
	default	null
ra	Right Ascension in degrees (see ADR-49)
	type	string
	default	null
dec	Declination in degrees (see ADR-49)
	type	string
	default	null
channels	type	array
	default	null
	items	Informs SDP ingest about the expected channel configuration, especially which frequencies are expected to be mapped to which channel ID. Note that channel IDs are not guaranteed to be continuous, so this might involve gaps and/or strides.
		Scan_channels_0.4
additionalProperties	True

Scan_channels_0.4

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

type	object
properties
count	Number of channels
	type	integer
start	First channel ID
	type	integer
stride	Distance between subsequent channel IDs
	type	integer
	default	null
freq_min	Lower bound of first channel
	type	number
freq_max	Upper bound of last channel
	type	number
link_map	Channel map that specifies which network link is going to get used to send channels to SDP. Intended to allow SDP to optimise network and receive node configuration.
	type	array
	default	null
	items
additionalProperties	True