JSON schema and example for Cheetah Configure version 1.1

PSS configuration schema 1.1

Example (PSS Cheetah configuration for scan 1.1)

{
    "interface": "https://schema.skao.int/ska-pss-cheetah-configure/1.1",
    "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
    }],
    "beams": [{
        "beam": {
            "active": true,
            "sinks": {
                "channels": {
                    "sps_events": {
                        "active": true,
                        "sink": [{
                            "id": "spccl_files"
                        }, {
                            "id": "candidate_files"
                        }]
                    }
                },
                "sink_configs": {
                    "spccl_files": {
                        "extension": ".spccl",
                        "dir": "/tmp/beam1",
                        "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
                        },
                        "id": "candidate_files"
                    }
                }
            },
            "source": {
                "sigproc": {
                    "file": "filterbank1.fil",
                    "chunk_samples": 1024,
                    "default-nbits": 8
                },
                "udp_low": {
                    "number_of_threads": 2,
                    "spectra_per_chunk": 2048,
                    "number_of_channels": 7776,
                    "max_buffers": 1,
                    "listen": {
                        "port": 60000,
                        "ip_address": "127.0.0.1"
                    }
                }
            },
            "id": 1
        }
    }, {
        "beam": {
            "active": false,
            "sinks": {
                "channels": {
                    "sps_events": {
                        "active": true,
                        "sink": [{
                            "id": "spccl_files"
                        }, {
                            "id": "candidate_files"
                        }]
                    }
                },
                "sink_configs": {
                    "spccl_files": {
                        "extension": ".spccl",
                        "dir": "/tmp/beam2",
                        "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
                        },
                        "id": "candidate_files"
                    }
                }
            },
            "source": {
                "sigproc": {
                    "file": "filterbank2.fil",
                    "chunk_samples": 1024,
                    "default-nbits": 8
                },
                "udp_low": {
                    "number_of_threads": 2,
                    "spectra_per_chunk": 2048,
                    "number_of_channels": 7776,
                    "max_buffers": 1,
                    "listen": {
                        "port": 60001,
                        "ip_address": "127.0.0.1"
                    }
                }
            },
            "id": 2
        }
    }, {
        "beam": {
            "active": false,
            "sinks": {
                "channels": {
                    "sps_events": {
                        "active": true,
                        "sink": [{
                            "id": "spccl_files"
                        }, {
                            "id": "candidate_files"
                        }]
                    }
                },
                "sink_configs": {
                    "spccl_files": {
                        "extension": ".spccl",
                        "dir": "/tmp/beam3",
                        "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
                        },
                        "id": "candidate_files"
                    }
                }
            },
            "source": {
                "sigproc": {
                    "file": "filterbank3.fil",
                    "chunk_samples": 1024,
                    "default-nbits": 8
                },
                "udp_low": {
                    "number_of_threads": 2,
                    "spectra_per_chunk": 2048,
                    "number_of_channels": 7776,
                    "max_buffers": 1,
                    "listen": {
                        "port": 60002,
                        "ip_address": "127.0.0.1"
                    }
                }
            },
            "id": 3
        }
    }],
    "ddtr": {
        "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
        }],
        "dedispersion_samples": 131072
    },
    "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"
        }
    },
    "config_id": 1
}

https://schema.skao.int/ska-pss-cheetah-configure/1.1
type	object
properties
interface	URI of JSON schema for this command’s JSON payload..
	type	string
beam	type	array
	items	PSS_beam_config_1.1
beams	List of up to 3 beams
	type	array
	items	PSS_beams_config_1.1
config_id	Configuration ID
	type	integer
ddtr	PSS_ddtr_config_1.1
sps	PSS_sps_config_1.1
additionalProperties	True

PSS_beam_config_1.1

type	object
properties
beam_id	Search Beam ID.
	type	integer
ra	Right Ascension of sub-array beam target, in degrees.
	type	number
dec	Declination of sub-array beam target, in degrees.
	type	number
reference_frame	reference frame for pointing coordinates
	type	string
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
dest_port	Per beam destination port for PSS output.
	type	integer
additionalProperties	True

PSS_beams_config_1.1

type	object
properties
beam	PSS_pss_beam_config_1.1
additionalProperties	True

PSS_pss_beam_config_1.1

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

PSS_sinks_config_1.1

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

PSS_channels_config_1.1

type	object
properties
sps_events	PSS_sps_events_config_1.1
additionalProperties	True

PSS_sps_events_config_1.1

type	object
properties
active	activate the channel.
	type	boolean
sink	activate the channel.
	type	array
	items	type	object
		properties
		id	type	string
		additionalProperties	True
additionalProperties	True

PSS_sink_configs_config_1.1

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

PSS_spccl_files_config_1.1

type	object
properties
extension	extension.
	type	string
dir	directory.
	type	string
id	id.
	type	string
additionalProperties	True

PSS_spccl_sigproc_files_config_1.1

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.1
id	id.
	type	string
additionalProperties	True

PSS_candidate_window_config_1.1

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.1

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

PSS_sigproc_config_1.1

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
additionalProperties	True

PSS_UDP_config_1.1

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
listen	PSS_UDP_address_config_1.1
additionalProperties	True

PSS_UDP_address_config_1.1

type	object
properties
port	the port of the endpoint.
	type	integer
ip_address	Valid IPv4 or IPv6 address.
	type	string
additionalProperties	True

PSS_ddtr_config_1.1

type	object
properties
cpu	dedispersion of time frequency data on CPU.
	type	object
	properties
	active	type	boolean
	additionalProperties	True
fpga	Dedispersion of time frequency data on CPU.
	type	object
	properties
	active	type	boolean
	additionalProperties	True
gpu_bruteforce	A GPU brute force algorithm to perform DDTR.
	type	object
	properties
	active	type	boolean
	copy_dmtrials_to_host	type	boolean
	additionalProperties	True
klotski	A Klotski algorithm to perform DDTR.
	type	object
	properties
	active	type	boolean
	additionalProperties	True
klotski_bruteforce	A Klotski brute force algorithm to perform DDTR.
	type	object
	properties
	active	type	boolean
	additionalProperties	True
dedispersion	type	array
	items	PSS_dedispersion_config_1.1
dedispersion_samples	max samples to process in each call to the dedisperser
	type	integer
additionalProperties	True

PSS_dedispersion_config_1.1

type	object
properties
start	start DM in cm^-3 pc.
	type	number
end	end DM in cm^-3 pc (inclusive).
	type	number
step	DM step size in cm^-3 pc.
	type	number
additionalProperties	True

PSS_sps_config_1.1

type	object
properties
cpu	dedispersion of time frequency data on CPU.
	type	object
	properties
	active	type	boolean
	samples_per_iteration	type	integer
	number_of_widths	type	integer
	additionalProperties	True
threshold	single pulse detection threshold in sigmas.
	type	number
klotski	PSS_klotski_config_1.1
klotski_bruteforce	PSS_klotski_config_1.1
additionalProperties	True

PSS_klotski_config_1.1

type	object
properties
active	Enable klotski sps mode.
	type	boolean
pulse_widths	Matched filter widths (in bins).
	type	string
additionalProperties	True