JSON schema and example for Cheetah Configure version 1.6
PSS configuration schema 1.6
Example (PSS Cheetah configuration for scan 1.6)
{
"interface": "https://schema.skao.int/ska-pss-cheetah-configure/1.6",
"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
},
"udp_low_lite": {
"number_of_threads": 10,
"spectra_per_chunk": 32768,
"number_of_channels": 432,
"max_buffers": 3,
"active": false
}
},
"beam_id": 1
}
}, {
"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/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
},
"udp_low_lite": {
"number_of_threads": 10,
"spectra_per_chunk": 32768,
"number_of_channels": 432,
"max_buffers": 3,
"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
},
"udp_low_lite": {
"number_of_threads": 10,
"spectra_per_chunk": 32768,
"number_of_channels": 432,
"max_buffers": 3,
"active": false
}
},
"beam_id": 3
}
}],
"cheetah_id": 1,
"psbc": {
"dump_time": 540
},
"acceleration": {
"fdas": {
"pool_id": "default",
"priority": 0,
"active": false,
"labyrinth": {
"active": true,
"threshold": 10.0
}
}
},
"sift": {
"pool_id": "default",
"priority": 2,
"strong_sift": {
"active": false,
"num_candidate_harmonics": 8,
"match_factor": 0.001,
"dm_match_range": 2
}
},
"sps_clustering": {
"pool_id": "default",
"priority": 0,
"active": false,
"fof_clustering": {
"active": false,
"time_tolerance": 10.0,
"dm_thresh": 10.0,
"linking_length": 1.5,
"width_matching_factor": 4.0
}
},
"spsift": {
"pool_id": "default",
"priority": 0,
"active": false,
"thresholding": {
"active": false,
"dm_thresh": 10.0,
"sigma_thresh": 7.0,
"pulse_width_threshold": 1100.0,
"maximum_candidates": 0,
"min_cluster_size": 15
}
}
}
type |
object |
|
properties |
||
|
URI of JSON schema for this command’s JSON payload.. |
|
type |
string |
|
|
Pipeline ID for the cheetah instance. |
|
type |
integer |
|
|
Configuration for the PSS Beamforming Collector (PSBC) |
|
|
Top-level acceleration configuration |
|
|
Top-level SIFT stage configuration |
|
|
List of up to 3 beams |
|
type |
array |
|
items |
||
|
Top-level SPS clustering stage configuration |
|
|
Top-level spsift stage configuration |
|
additionalProperties |
True |
|
PSS_PSBC_schema_1.6
Configuration for the PSS Beamforming Collector (PSBC)
type |
object |
|
properties |
||
|
Time interval (in seconds) at which beamformed data is dumped |
|
type |
integer |
|
additionalProperties |
True |
|
PSS_acceleration_schema_1.6
Top-level acceleration configuration
type |
object |
properties |
|
|
FDAS configuration |
additionalProperties |
True |
PSS_FDAS_schema_1.6
Configuration for the FDAS acceleration stage
type |
object |
|
properties |
||
|
Name of the processing pool to use |
|
type |
string |
|
|
Scheduling priority for FDAS tasks |
|
type |
integer |
|
|
Whether FDAS processing is active |
|
type |
boolean |
|
|
Labyrinth sub-configuration |
|
additionalProperties |
True |
|
PSS_labyrinth_schema_1.6
Configuration for the Labyrinth acceleration algorithm
type |
object |
|
properties |
||
|
Whether the labyrinth algorithm is enabled |
|
type |
boolean |
|
|
Threshold parameter for candidate detection |
|
type |
number |
|
additionalProperties |
True |
|
PSS_sift_schema_1.6
Top-level SIFT stage configuration
type |
object |
|
properties |
||
|
Pool ID to assign sift processing |
|
type |
string |
|
|
Execution priority of the sift stage |
|
type |
integer |
|
|
Configuration block for the strong sift logic |
|
additionalProperties |
True |
|
PSS_strong_sift_schema_1.6
Configuration for the strong SIFT algorithm
type |
object |
|
properties |
||
|
Whether the strong_sift stage is active |
|
type |
boolean |
|
|
Number of harmonics to consider per candidate |
|
type |
integer |
|
|
Factor to scale thresholding match window |
|
type |
number |
|
|
Allowed range in dispersion measure for match filtering |
|
type |
integer |
|
additionalProperties |
True |
|
PSS_beams_config_1.6
type |
object |
properties |
|
|
|
additionalProperties |
True |
PSS_pss_beam_config_1.6
type |
object |
|
properties |
||
|
enable this beam. |
|
type |
boolean |
|
|
Beam ID |
|
type |
integer |
|
|
||
|
||
additionalProperties |
True |
|
PSS_sinks_config_1.6
type |
object |
properties |
|
|
|
|
|
additionalProperties |
True |
PSS_channels_config_1.6
type |
object |
properties |
|
|
|
additionalProperties |
True |
PSS_sps_events_config_1.6
type |
object |
|||
properties |
||||
|
activate the channel. |
|||
type |
boolean |
|||
|
List of sink ids for sps_events. |
|||
type |
array |
|||
items |
Sink configuration schema 1.6 |
|||
Sink configuration for PSS |
||||
type |
object |
|||
properties |
||||
|
Sink ID |
|||
type |
string |
|||
additionalProperties |
True |
|||
additionalProperties |
True |
|||
PSS_sink_configs_config_1.6
type |
object |
properties |
|
|
|
|
|
additionalProperties |
True |
PSS_spccl_files_config_1.6
type |
object |
|
properties |
||
|
extension. |
|
type |
string |
|
|
directory. |
|
type |
string |
|
|
Sink ID |
|
type |
string |
|
additionalProperties |
True |
|
PSS_spccl_sigproc_files_config_1.6
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.6
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.6
type |
object |
properties |
|
|
|
|
|
|
|
additionalProperties |
True |
PSS_sigproc_config_1.6
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 |
|
|
enable udp low |
|
type |
boolean |
|
additionalProperties |
True |
|
PSS_UDP_config_1.6
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 |
|
|
enable udp low |
|
type |
boolean |
|
additionalProperties |
True |
|
PSS_SPS_clustering_schema_1.6
Top-level SPS clustering stage configuration
type |
object |
|
properties |
||
|
Pool ID to assign sift processing |
|
type |
string |
|
|
Execution priority of the sift stage |
|
type |
integer |
|
|
Whether the sps_clustering stage is active |
|
type |
boolean |
|
|
Configuration block for the FoF clustering logic |
|
additionalProperties |
True |
|
PSS_SPS_fof_clustering_schema_1.6
Configuration for the FoF clustering algorithm
type |
object |
|
properties |
||
|
Whether the fof_clustering stage is active |
|
type |
boolean |
|
|
Tolerance value for clustering in time (ms) |
|
type |
number |
|
|
Threshold value for clustering in DM (pc/cm^3) |
|
type |
number |
|
|
Linking length for FoF algorithm |
|
type |
number |
|
|
Tolerance value for clustering in width |
|
type |
number |
|
additionalProperties |
True |
|
PSS_spsift_schema_1.6
Top-level spsift stage configuration
type |
object |
|
properties |
||
|
Pool ID to assign spsift processing |
|
type |
string |
|
|
Execution priority of the spsift stage |
|
type |
integer |
|
|
Whether the spsift stage is active |
|
type |
boolean |
|
|
Configuration block for the spsift thresholding logic |
|
additionalProperties |
True |
|
PSS_spsift_thresholding_schema_1.6
Configuration for the spsift thresholding algorithm
type |
object |
|
properties |
||
|
Whether the thresholding stage is active |
|
type |
boolean |
|
|
Lower limit on DM values to keep (pc/cm^3) |
|
type |
number |
|
|
Signal-to-noise threshold |
|
type |
number |
|
|
Pulse width threshold (ms) |
|
type |
number |
|
|
Maximum number of candidates. If 0, no limit is set. |
|
type |
integer |
|
|
Minimum size of cluster to keep (default=15) |
|
type |
integer |
|
additionalProperties |
True |
|