CSP configurescan 2.1

JSON schema and example for CSP Mid configure

CSP config 2.1

Example JSON (TMC input for science_a visibility scan)

{
    "interface": "https://schema.skao.int/ska-csp-configure/2.1",
    "subarray": {
        "subarray_name": "science period 23"
    },
    "common": {
        "config_id": "sbi-mvp01-20200325-00001-science_A",
        "frequency_band": "1",
        "subarray_id": 1
    },
    "cbf": {
        "fsp": [{
            "fsp_id": 1,
            "function_mode": "CORR",
            "frequency_slice_id": 1,
            "integration_factor": 1,
            "zoom_factor": 0,
            "channel_averaging_map": [
                [0, 2],
                [744, 0]
            ],
            "channel_offset": 0,
            "output_link_map": [
                [0, 0],
                [200, 1]
            ]
        }, {
            "fsp_id": 2,
            "function_mode": "CORR",
            "frequency_slice_id": 2,
            "integration_factor": 1,
            "zoom_factor": 1,
            "zoom_window_tuning": 650000,
            "channel_averaging_map": [
                [0, 2],
                [744, 0]
            ],
            "channel_offset": 744,
            "output_link_map": [
                [0, 4],
                [200, 5]
            ]
        }],
        "vlbi": {}
    },
    "pst": {}
}

Example JSON (CSP configuration for science_a visibility scan)

{
    "interface": "https://schema.skao.int/ska-csp-configure/2.1",
    "subarray": {
        "subarray_name": "science period 23"
    },
    "common": {
        "config_id": "sbi-mvp01-20200325-00001-science_A",
        "frequency_band": "1",
        "subarray_id": 1
    },
    "cbf": {
        "fsp": [{
            "fsp_id": 1,
            "function_mode": "CORR",
            "frequency_slice_id": 1,
            "integration_factor": 1,
            "zoom_factor": 0,
            "channel_averaging_map": [
                [0, 2],
                [744, 0]
            ],
            "channel_offset": 0,
            "output_link_map": [
                [0, 0],
                [200, 1]
            ],
            "output_host": [
                [0, "192.168.0.1"],
                [400, "192.168.0.2"]
            ],
            "output_mac": [
                [0, "06-00-00-00-00-00"]
            ],
            "output_port": [
                [0, 9000, 1],
                [400, 9000, 1]
            ]
        }, {
            "fsp_id": 2,
            "function_mode": "CORR",
            "frequency_slice_id": 2,
            "integration_factor": 1,
            "zoom_factor": 1,
            "zoom_window_tuning": 650000,
            "channel_averaging_map": [
                [0, 2],
                [744, 0]
            ],
            "channel_offset": 744,
            "output_link_map": [
                [0, 4],
                [200, 5]
            ],
            "output_host": [
                [0, "192.168.0.3"],
                [400, "192.168.0.4"]
            ],
            "output_mac": [
                [0, "06-00-00-00-00-01"]
            ],
            "output_port": [
                [0, 9000, 1],
                [400, 9000, 1]
            ]
        }],
        "vlbi": {}
    },
    "pst": {}
}

Example JSON (CSP configuration for cal_a visibility scan)

{
    "interface": "https://schema.skao.int/ska-csp-configure/2.1",
    "subarray": {
        "subarray_name": "science period 23"
    },
    "common": {
        "config_id": "sbi-mvp01-20200325-00001-science_A",
        "frequency_band": "1",
        "subarray_id": 1
    },
    "cbf": {
        "fsp": [{
            "fsp_id": 1,
            "function_mode": "CORR",
            "frequency_slice_id": 1,
            "integration_factor": 1,
            "zoom_factor": 0,
            "channel_averaging_map": [
                [0, 2],
                [744, 0]
            ],
            "channel_offset": 0,
            "output_link_map": [
                [0, 0],
                [200, 1]
            ],
            "output_host": [
                [0, "192.168.1.1"]
            ],
            "output_port": [
                [0, 9000, 1]
            ]
        }, {
            "fsp_id": 2,
            "function_mode": "CORR",
            "frequency_slice_id": 2,
            "integration_factor": 1,
            "zoom_factor": 1,
            "zoom_window_tuning": 650000,
            "channel_averaging_map": [
                [0, 2],
                [744, 0]
            ],
            "channel_offset": 744,
            "output_link_map": [
                [0, 4],
                [200, 5]
            ],
            "output_host": [
                [0, "192.168.1.1"]
            ],
            "output_port": [
                [0, 9744, 1]
            ]
        }],
        "vlbi": {}
    },
    "pst": {}
}

Example JSON (CSP configuration for PSS scan)

{
    "interface": "https://schema.skao.int/ska-csp-configure/2.1",
    "subarray": {
        "subarray_name": "science period 23"
    },
    "common": {
        "config_id": "sbi-mvp01-20200325-00001-science_A",
        "frequency_band": "1",
        "subarray_id": 1
    },
    "cbf": {
        "fsp": [{
            "fsp_id": 1,
            "function_mode": "PSS-BF",
            "frequency_slice_id": 1,
            "integration_factor": 1,
            "zoom_factor": 0,
            "output_link_map": [
                [0, 1],
                [200, 2]
            ]
        }, {
            "fsp_id": 2,
            "function_mode": "CORR",
            "frequency_slice_id": 1,
            "integration_factor": 1,
            "zoom_factor": 1,
            "zoom_window_tuning": 650000,
            "output_link_map": [
                [0, 4],
                [200, 5]
            ]
        }],
        "search_window": [{
            "search_window_id": 0,
            "search_window_tuning": 1000,
            "tdc_enable": true
        }]
    },
    "pss": {
        "beam_bandwidth": 300,
        "channels_per_beam": 4096,
        "acceleration_search": false,
        "single_pulse_search": true,
        "integration_time": 600,
        "acc_range": 0,
        "number_of_trials": 0,
        "time_resolution": 4,
        "ps_dm": 1000.0,
        "sps_dm": 1000.0,
        "timesample_per_block": 28125000,
        "sub_bands": 64,
        "buffer_size": 18,
        "hsum_control": 16,
        "cxft_control": {},
        "cand_sift": {},
        "cand_output": {},
        "sp_threshold": 10.0,
        "sp_opt_pars": {},
        "dred_beam_stats": {},
        "cdos_control": {},
        "fldo_control": {
            "phase_split": true,
            "channel_scale": true,
            "max_phases": 16
        },
        "rfim_control": {},
        "beam": [{
            "beam_id": 1,
            "reference_frame": "ICRS",
            "ra": 82.75,
            "dec": 21.0,
            "centre_frequency": 1400.0,
            "beam_delay_centre": 0.0,
            "dest_host": "192.168.178.25",
            "dest_port": 9021
        }, {
            "beam_id": 2,
            "reference_frame": "ICRS",
            "ra": 84.25,
            "dec": 21.5,
            "centre_frequency": 1400.0,
            "beam_delay_centre": 0.0,
            "dest_host": "192.168.178.26",
            "dest_port": 9021
        }]
    }
}

https://schema.skao.int/ska-csp-configure/2.1
type	object
properties
interface	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
	default	null
	properties
	subarray_name	Name and scope of current subarray the sub-array.
		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 2.1
cbf	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
	CBF config 2.1
pss	default	null
	PSS configuration 2.1
pst	Pulsar Timing specific parameters. To be borrowed from IICD
	type	object
	default	null
	properties
	dummy_param	type	string
		default	null
	additionalProperties	False
additionalProperties	False

Common configuration schema 2.1

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
	default	null
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
	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.
	type	string
	pattern	^(1|2|3|4|5(a|b))$
additionalProperties	False

CBF config 2.1

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 (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). Note: This is optional and does not need to be implemented in PI3, but would be great for demo; if Team Buttons is looking for opportunities to showcase interesting GUIs, Zoom Windows are perfect opportunity (would require TMC and CSP to support these two parameters, corrBandwidth values > 0 and zoom window tuning.)
	type	integer
	default	null
frequency_band_offset_stream2	See frequencyBandOffsetStream1
	type	integer
	default	null
delay_model_subscription_point	FQDN of TMC.DelayModel TANGO attribute which exposes delay values for all the dishes assigned to a Subarray in JSON format. Delay values are updated every 10 seconds.
	type	string
	default	null
doppler_phase_corr_subscription_point	The same model applies for all receptors that belong to the subarray. Delivered by TMC using publish-subscribe mechanism (see ICD Section 3.8.8.5.3). The Doppler phase correction, by default, applies only to the CSP_Mid Processing Mode Correlation; optionally may apply to other Processing Modes as well.
	type	string
	default	null
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
	default	null
	properties
	additionalProperties	False
fsp	type	array
	items	FSP config 2.1
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 2.1
search_window	type	array
	default	null
	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 2.1
additionalProperties	False

FSP config 2.1

type	object
properties
fsp_id	type	integer
function_mode	allOf	type	string
		enum	CORR, PSS-BF, PST-BF, VLBI
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	type	string
		pattern	^(SKA(00[1-9]|0[1-9][0-9]|1[0-2][0-9]|13[0-3]))| (MKT(0[0-5][0-9]|06[0-3]))$
frequency_slice_id	Frequency Slice to be processed on this FSP (valid range depends on the Frequency Band).
	type	integer
zoom_factor	Bandwidth to be correlated calculated as FSBW/2n, where n is in range [0..6]. When n=0 the full Frequency Slice bandwidth is correlated. BW > 0 implies ‘Zoom Window’ configuration; the spectral Zoom Window tuning must be specified.
	type	integer
zoom_window_tuning	The Zoom Window tuning provided in absolute terms as RF center frequency. Based on that, CSP_Mid calculates tuning within the data stream received from the receptor. Must be selected so that the entire Zoom Window is within the Frequency Slice. If partially out of the FS a warning is generated. If completely outside of the FS an exception is generated. Step size <= 0.01MHz. The Frequency Band Offset can be used to shift the entire observed band in order to accommodate a Zoom Window that spans across a Frequency Slice boundary.
	type	integer
	default	null
integration_factor	Integration time for the correlation products, defines multiple of 140 milliseconds.
	type	integer
output_mac	Output MAC address to send visibilities to for every channel, given as a list of start channel ID to IEEE 802 MAC addresses. Where no value is given for a concrete channel, the previous value should be used.
	type	array
	default	null
	items	type	array
		items	anyOf	type	integer
				type	string
channel_averaging_map	Table of up to 20 x 2 integers. Each of entries contains: Start channel ID, and averaging factor. Explanation: Each FSP produces 14880 (TBC) fine channels across the correlated bandwidth (Frequency Slice or Zoom Window). Channels are evenly spaced in frequency. TM shall provide the table that for each FSP and each group of 744 channels (there are 20 groups per FSP) indicates the channel averaging factor. More precisely, for each group the TMC provided table specifies: the channel ID (integer) of the first channel, and the averaging factor, as follows: 0 means do not send channels to SDP, 1 means no averaging, 2 means average two adjacent channels, 3 means average three adjacent channels, and so on. If no entry is present for an FSP, the averaging settings of the previous FSP are still applicable.
	type	array
	default	null
	items	type	array
		items	type	integer
channel_offset	Channel ID to use for visibilities of the first channel produced by this FSP. For example, if the channel offset is 5000 the first channel group would span IDs 5000-5743. Note that this offset does not apply to channel maps in this structure (such as channelAveragingMap or outputHost).
	type	integer
	default	null
output_link_map	Output links to emit visibilities on for every channel, given as a list of start channel ID to link ID. Where no value is given for concrete channel, the previous value should be used.
	type	array
	default	null
	items	type	array
		items	anyOf	type	integer
				type	string
output_host	Output host to send visibilities to for every channel, given as a list of start channel ID to host IP addresses in dot-decimal notation. Where no value is given for a concrete channel, the previous value should be used.
	type	array
	default	null
	items	type	array
		items	anyOf	type	integer
				type	string
output_port	Output port to send visibilities to for every channel, given as a list of start channel ID to port number. Where no value is given for a concrete channel, the previous value should be used.
	type	array
	default	null
	items	type	array
		items	type	integer
additionalProperties	False

VLBI config 2.1

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 2.1

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
tdc_enable	Enable / disable Transient Data Capturefor the Search Window.
	type	boolean
tdc_num_bits	Number of bits per sample (for the Transient Data Capture). Required if TDC is enabled, otherwise not specified.
	type	integer
	default	null
tdc_period_before_epoch	Users can trade the period of time for which data are saved and transmitted for the sample bit-width and/or the number of Search Windows. The exact information regarding the memory capacity per receptor and supported range will be provided in construction. The epoch is specified in the command that triggers TDC off-loading (transmission of data).
	type	integer
	default	null
tdc_period_after_epoch	see tdcPeriodBeforeEpoch
	type	integer
	default	null
tdc_destination_address	Destination addresses (MAC, IP, port) for off-loading of the content of the Transient Data Capture Buffer, specified per receptor. The destination addresses for the content of the Transient Data Capture can be provided either as a part of the scan configuration or by the command that triggers transmission of the captured data. The latter, if provided, overrides previously set addresses. Required if TDC is enabled, otherwise not specified.
	type	array
	default	null
	items	anyOf	type	integer
			type	string
additionalProperties	False

PSS configuration 2.1

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 2.1
additionalProperties	False

PSS beam config 2.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