JSON schema and example for Configure version 1.2
JSON schema and example for PSS configure
PSS configuration schema 1.2
Example (PSS configuration 1.2)
{ "interface": "https://schema.skao.int/ska-pss-configure/1.2", "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 }], "ddtr": { "dedispersion_samples": 131072, "cpu": { "active": false }, "fpga": { "active": false }, "gpu_bruteforce": { "active": false, "copy_dmtrials_to_host": true }, "klotski": { "active": true }, "klotski_bruteforce": { "active": false }, "dedispersion": [{ "start": 0.0, "end": 100.0, "step": 0.1 }, { "start": 100.0, "end": 300.0, "step": 0.2 }, { "start": 300.0, "end": 700.0, "step": 0.4 }, { "start": 700.0, "end": 1500.0, "step": 0.8 }, { "start": 1500.0, "end": 3100.0, "step": 1.6 }] }, "config_id": 1, "sps": { "cpu": { "active": false, "samples_per_iteration": 1, "number_of_widths": 1 }, "threshold": 8.0, "klotski": { "active": true, "pulse_widths": "1,2,4,8,16,32,64,128" }, "klotski_bruteforce": { "active": false, "pulse_widths": "1,2,4,8,16,32,64,128" } }, "common": { "config_id": "sbi-mvp01-20200325-00001-science_A", "subarray_id": 1, "frequency_band": "low", "eb_id": "eb-x449-20231105-34696" }, "transaction_id": "txn-....-00001", "cheetah": [{ "cheetah_id": 1, "beams": [{ "beam": { "active": true, "sinks": { "channels": { "sps_events": { "active": true, "sink": [{ "sink_id": "spccl_files" }, { "sink_id": "candidate_files" }] } }, "sink_configs": { "spccl_files": { "extension": ".spccl", "dir": "/tmp/beam1", "sink_id": "spccl_files" }, "spccl_sigproc_files": { "spectra_per_file": 0, "dir": "/tmp/beam1", "extension": ".fil", "candidate_window": { "ms_before": 500.0, "ms_after": 1000.0 }, "sink_id": "candidate_files" } } }, "source": { "sigproc": { "file": "filterbank1.fil", "chunk_samples": 1024, "default-nbits": 8, "active": true }, "udp_low": { "number_of_threads": 2, "spectra_per_chunk": 2048, "number_of_channels": 7776, "max_buffers": 1, "active": false } }, "beam_id": 1 } }, { "beam": { "active": true, "sinks": { "channels": { "sps_events": { "active": true, "sink": [{ "sink_id": "spccl_files" }, { "sink_id": "candidate_files" }] } }, "sink_configs": { "spccl_files": { "extension": ".spccl", "dir": "/tmp/beam2", "sink_id": "spccl_files" }, "spccl_sigproc_files": { "spectra_per_file": 0, "dir": "/tmp/beam2", "extension": ".fil", "candidate_window": { "ms_before": 500.0, "ms_after": 1000.0 }, "sink_id": "candidate_files" } } }, "source": { "sigproc": { "file": "filterbank2.fil", "chunk_samples": 1024, "default-nbits": 8, "active": true }, "udp_low": { "number_of_threads": 2, "spectra_per_chunk": 2048, "number_of_channels": 7776, "max_buffers": 1, "active": false } }, "beam_id": 2 } }, { "beam": { "active": false, "sinks": { "channels": { "sps_events": { "active": true, "sink": [{ "sink_id": "spccl_files" }, { "sink_id": "candidate_files" }] } }, "sink_configs": { "spccl_files": { "extension": ".spccl", "dir": "/tmp/beam3", "sink_id": "spccl_files" }, "spccl_sigproc_files": { "spectra_per_file": 0, "dir": "/tmp/beam3", "extension": ".fil", "candidate_window": { "ms_before": 500.0, "ms_after": 1000.0 }, "sink_id": "candidate_files" } } }, "source": { "sigproc": { "file": "filterbank3.fil", "chunk_samples": 1024, "default-nbits": 8, "active": true }, "udp_low": { "number_of_threads": 2, "spectra_per_chunk": 2048, "number_of_channels": 7776, "max_buffers": 1, "active": false } }, "beam_id": 3 } }] }] }
Main configuration for the Pulsar Search sub-system
type |
object |
|
properties |
||
|
URI of JSON schema for this command’s JSON payload. |
|
type |
string |
|
|
A transaction id specific to the command |
|
type |
string |
|
|
Common section, containing the parameters and the sections belonging to all CSP subsystems. This section is forwarded to all sub-elements. |
|
|
type |
array |
items |
||
|
||
|
Configuration ID |
|
type |
integer |
|
|
||
|
type |
array |
items |
Configuration for the Cheetah beams |
|
additionalProperties |
True |
|
Common_configuration_schema_1.2
Common section, containing the parameters and the sections belonging to all CSP subsystems. This section is forwarded to all sub-elements.
type |
object |
|
properties |
||
|
type |
string |
|
The Subarray ID that the list of receptors will be assigned to. For Mid, there are a maximum of 16 subarrays. Range: Integer from 1-16 inclusive |
|
type |
integer |
|
|
Execution block ID to associate scan configs to an observation. This ID is used for associating generated data, especially data products, for a given observation. Multiple scans can be linked to one observation and this ID is used as metadata to associate the data products from all scans of the same observation. This ID does not have to be unique for a scan configuration but should be unique for different observations. For example, all the data and weights files will have an EB_ID header value populated with the value supplied in this field. |
|
type |
string |
|
|
Frequency band applies for all the receptors (VCCs) that belong to the sub-array. The value of ‘low’ is used to only within SKA Low. As this field is a mandatory field but bands 1, 2, 3, 4, 5a and 5b only make sense for SKA Mid. |
|
type |
string |
|
additionalProperties |
True |
|
PSS_beam_config_1.1
type |
object |
||
properties |
|||
|
Search Beam ID. |
||
type |
integer |
||
|
Right Ascension of sub-array beam target, in degrees. |
||
type |
number |
||
default |
null |
||
|
Declination of sub-array beam target, in degrees. |
||
type |
number |
||
default |
null |
||
|
reference frame for pointing coordinates |
||
type |
string |
||
default |
null |
||
|
Centre frequency of the search beam. |
||
type |
number |
||
|
Beam delay center, relative to the array delay center. |
||
anyOf |
type |
number |
|
type |
string |
||
|
Per beam destination host address for PSS output. |
||
type |
string |
||
default |
null |
||
|
Per beam destination port for PSS output. |
||
type |
integer |
||
default |
null |
||
additionalProperties |
True |
||
PSS_ddtr_config_1.1
type |
object |
||
properties |
|||
|
max samples to process in each call to the dedisperser |
||
type |
integer |
||
|
dedispersion of time frequency data on CPU. |
||
type |
object |
||
properties |
|||
|
type |
boolean |
|
additionalProperties |
True |
||
|
Dedispersion of time frequency data on CPU. |
||
type |
object |
||
properties |
|||
|
type |
boolean |
|
additionalProperties |
True |
||
|
A GPU brute force algorithm to perform DDTR. |
||
type |
object |
||
properties |
|||
|
type |
boolean |
|
|
type |
boolean |
|
additionalProperties |
True |
||
|
A Klotski algorithm to perform DDTR. |
||
type |
object |
||
properties |
|||
|
type |
boolean |
|
additionalProperties |
True |
||
|
A Klotski brute force algorithm to perform DDTR. |
||
type |
object |
||
properties |
|||
|
type |
boolean |
|
additionalProperties |
True |
||
|
type |
array |
|
items |
|||
additionalProperties |
True |
||
PSS_dedispersion_config_1.1
type |
object |
|
properties |
||
|
start DM in cm^-3 pc. |
|
type |
number |
|
|
end DM in cm^-3 pc (inclusive). |
|
type |
number |
|
|
DM step size in cm^-3 pc. |
|
type |
number |
|
additionalProperties |
True |
|
PSS_sps_config_1.1
type |
object |
||
properties |
|||
|
dedispersion of time frequency data on CPU. |
||
type |
object |
||
properties |
|||
|
type |
boolean |
|
|
type |
integer |
|
|
type |
integer |
|
additionalProperties |
True |
||
|
single pulse detection threshold in sigmas. |
||
type |
number |
||
|
|||
|
|||
additionalProperties |
True |
||
PSS_klotski_config_1.1
type |
object |
|
properties |
||
|
Enable klotski sps mode. |
|
type |
boolean |
|
|
Matched filter widths (in bins). |
|
type |
string |
|
additionalProperties |
True |
|
PSS_cheetah_beams_configure_1.1
Configuration for the Cheetah beams
type |
object |
|
properties |
||
|
Pipeline ID. |
|
type |
integer |
|
|
type |
array |
items |
||
additionalProperties |
True |
|
PSS_beams_config_1.1
type |
object |
properties |
|
|
|
additionalProperties |
True |
PSS_pss_beam_config_1.1
type |
object |
|
properties |
||
|
enable this beam. |
|
type |
boolean |
|
|
||
|
||
|
Beam ID |
|
type |
integer |
|
additionalProperties |
True |
|
PSS_sinks_config_1.1
type |
object |
properties |
|
|
|
|
|
additionalProperties |
True |
PSS_channels_config_1.1
type |
object |
properties |
|
|
|
additionalProperties |
True |
PSS_sps_events_config_1.1
type |
object |
|||
properties |
||||
|
activate the channel. |
|||
type |
boolean |
|||
|
activate the channel. |
|||
type |
array |
|||
items |
type |
object |
||
properties |
||||
|
type |
string |
||
additionalProperties |
True |
|||
additionalProperties |
True |
|||
PSS_sink_configs_config_1.1
type |
object |
properties |
|
|
|
|
|
additionalProperties |
True |
PSS_spccl_files_config_1.1
type |
object |
|
properties |
||
|
extension. |
|
type |
string |
|
|
directory. |
|
type |
string |
|
|
Sink ID. |
|
type |
string |
|
additionalProperties |
True |
|
PSS_spccl_sigproc_files_config_1.1
type |
object |
|
properties |
||
|
spectra per file. |
|
type |
integer |
|
|
directory. |
|
type |
string |
|
|
extension. |
|
type |
string |
|
|
||
|
Sink ID. |
|
type |
string |
|
additionalProperties |
True |
|
PSS_candidate_window_config_1.1
type |
object |
|
properties |
||
|
Number of milliseconds before the candidate start. |
|
type |
number |
|
|
Number of milliseconds after the candidate end time. |
|
type |
number |
|
additionalProperties |
True |
|
PSS_source_config_1.1
type |
object |
properties |
|
|
|
|
|
additionalProperties |
True |
PSS_sigproc_config_1.1
type |
object |
|
properties |
||
|
specify the sigproc file(s) to read as input data. |
|
type |
string |
|
|
the number of time samples in each chunk. |
|
type |
integer |
|
|
specify the default number of bits to use. |
|
type |
integer |
|
|
activate the sigproc data source. Only one source between’sigproc’ and ‘udp_low’ should be active at the same time |
|
type |
boolean |
|
additionalProperties |
True |
|
PSS_UDP_config_1.1
type |
object |
|
properties |
||
|
the number of threads to run LOW ingest services |
|
type |
integer |
|
|
the number of time slices in each chunk. |
|
type |
integer |
|
|
Total number of frequency channels. |
|
type |
integer |
|
|
the max number of udp packet buffers to use. |
|
type |
integer |
|
|
activate the udp_low data source. Only one source between’sigproc’ and ‘udp_low’ should be active at the same time |
|
type |
boolean |
|
additionalProperties |
True |
|