JSON schema and example for Cheetah Configure version 1.2

PSS configuration schema 1.2

{
    "interface": "https://schema.skao.int/ska-pss-cheetah-configure/1.2",
    "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": 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
                }
            },
            "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
        }
    }],
    "cheetah_id": 1
}

https://schema.skao.int/ska-pss-cheetah-configure/1.2
type	object
properties
interface	URI of JSON schema for this command’s JSON payload..
	type	string
beams	List of up to 3 beams
	type	array
	items	PSS_beams_config_1.2
cheetah_id	Pipeline ID for the cheetah instance.
	type	integer
additionalProperties	True

PSS_beams_config_1.2

type	object
properties
beam	PSS_pss_beam_config_1.2
additionalProperties	True

PSS_pss_beam_config_1.2

type	object
properties
active	enable this beam.
	type	boolean
beam_id	Beam ID
	type	integer
sinks	PSS_sinks_config_1.2
source	PSS_source_config_1.2
additionalProperties	True

PSS_sinks_config_1.2

type	object
properties
channels	PSS_channels_config_1.2
sink_configs	PSS_sink_configs_config_1.2
additionalProperties	True

PSS_channels_config_1.2

type	object
properties
sps_events	PSS_sps_events_config_1.2
additionalProperties	True

PSS_sps_events_config_1.2

type	object
properties
active	activate the channel.
	type	boolean
sink	List of sink ids for sps_events.
	type	array
	items	Sink configuration schema 1.2
		Sink configuration for PSS
		type	object
		properties
		sink_id	Sink ID
			type	string
		additionalProperties	True
additionalProperties	True

PSS_sink_configs_config_1.2

type	object
properties
spccl_files	PSS_spccl_files_config_1.2
spccl_sigproc_files	PSS_spccl_sigproc_files_config_1.2
additionalProperties	True

PSS_spccl_files_config_1.2

type	object
properties
extension	extension.
	type	string
dir	directory.
	type	string
sink_id	Sink ID
	type	string
additionalProperties	True

PSS_spccl_sigproc_files_config_1.2

type	object
properties
spectra_per_file	spectra per file.
	type	integer
dir	directory.
	type	string
extension	extension.
	type	string
candidate_window	PSS_candidate_window_config_1.2
sink_id	Sink ID
	type	string
additionalProperties	True

PSS_candidate_window_config_1.2

type	object
properties
ms_before	Number of milliseconds before the candidate start.
	type	number
ms_after	Number of milliseconds after the candidate end time.
	type	number
additionalProperties	True

PSS_source_config_1.2

type	object
properties
sigproc	PSS_sigproc_config_1.2
udp_low	PSS_UDP_config_1.2
additionalProperties	True

PSS_sigproc_config_1.2

type	object
properties
file	specify the sigproc file(s) to read as input data.
	type	string
chunk_samples	the number of time samples in each chunk.
	type	integer
default-nbits	specify the default number of bits to use.
	type	integer
active	enable udp low
	type	boolean
additionalProperties	True

PSS_UDP_config_1.2

type	object
properties
number_of_threads	the number of threads to run LOW ingest services
	type	integer
spectra_per_chunk	the number of time slices in each chunk.
	type	integer
number_of_channels	Total number of frequency channels.
	type	integer
max_buffers	the max number of udp packet buffers to use.
	type	integer
active	enable udp low
	type	boolean
additionalProperties	True