ska-low-tmc-configure

Low TMC configure 3.1

Example JSON.

{
    "interface": "https://schema.skao.int/ska-low-tmc-configure/3.1",
    "transaction_id": "txn-....-00001",
    "mccs": {
        "stations": [{
            "station_id": 1
        }, {
            "station_id": 2
        }],
        "subarray_beams": [{
            "subarray_beam_id": 1,
            "station_ids": [1, 2],
            "update_rate": 0.0,
            "channels": [
                [0, 8, 1, 1],
                [8, 8, 2, 1],
                [24, 16, 2, 1]
            ],
            "antenna_weights": [1.0, 1.0, 1.0],
            "phase_centre": [0.0, 0.0],
            "target": {
                "reference_frame": "HORIZON",
                "target_name": "DriftScan",
                "az": 180.0,
                "el": 45.0
            }
        }]
    },
    "sdp": {
        "interface": "https://schema.skao.int/ska-sdp-configure/0.4",
        "scan_type": "science_A"
    },
    "csp": {
        "interface": "https://schema.skao.int/ska-low-csp-configure/0.0",
        "common": {
            "config_id": "sbi-mvp01-20200325-00001-science_A"
        },
        "lowcbf": {
            "stations": {
                "stns": [
                    [1, 1],
                    [2, 1],
                    [3, 1],
                    [4, 1],
                    [5, 1],
                    [6, 1]
                ],
                "stn_beams": [{
                    "stn_beam_id": 1,
                    "freq_ids": [400]
                }]
            },
            "vis": {
                "fsp": {
                    "function_mode": "vis",
                    "fsp_ids": [1]
                },
                "stn_beams": [{
                    "stn_beam_id": 1,
                    "host": [
                        [0, "192.168.1.00"]
                    ],
                    "port": [
                        [0, 9000, 1]
                    ],
                    "mac": [
                        [0, "02-03-04-0a-0b-0c"]
                    ],
                    "integration_ms": 849
                }]
            }
        }
    },
    "tmc": {
        "scan_duration": 10.0
    }
}

https://schema.skao.int/ska-low-tmc-configure/3.1

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • transaction_id

A transaction id specific to the command

type

string

default

null

  • mccs

MCCS configuration specification.

type

object

properties

  • stations

IDs of the MCCS stations to configure.

Maximum array size = 512, the maximum number of MCCS stations.

type

array

items

type

object

properties

  • station_id

MCCS Station ID.

Each ID must be between 1 and 512.

type

integer

additionalProperties

True

  • subarray_beams

MCCS sub-array beam configuration.

type

array

items

type

object

properties

  • subarray_beam_id

ID of MCCS sub-array beam to configure.

ID must be an integer between 1 and 48.

type

integer

  • station_ids

IDs of MCCS stations within this sub-array beamto configure.

Array size must be less than 512, the maximum number of MCCS stations.

Each item in the list must be an integer between 1 and 512.

type

array

items

type

integer

  • update_rate

Update rate for pointing information.

Value must be 0.0 or greater.

TODO: clarify whether this is specified as a frequency or as a cadence, plus units.

type

number

  • channels

Channel block configurations.

Each item in the list is a channel block configuration, each specified as a list of 4 numbers as follows:

[start channel, number of channels, beam index, sub-station index]

Constraints are:

0 < start channel < 376

start channel must be a multiple of 8

8 < number of channels < 48

1 < beam index < 48

1 < sub-station index < 8

type

array

items

type

array

items

type

integer

  • antenna_weights

Antenna weights.

Maximum array size = 512 (=256 antennas x2 pols per sub-array beam).

Antennas signals can be weighted to modify the station beam, varying from 0.0 for full exclusion to potentially 256.0 for an antenna contribution compensated for the number of antennas in the beam. This value is an amplitude multiplier added to that antenna signal before adding into the sum.

Weights apply to all channels assigned to a beam.

type

array

items

type

number

  • phase_centre

Phase centre offset for the station beam, in metres.

The reference position for station phase must be modified to reflect antenna weighting and their contribution to the station beam. This offset can be can considered the desired centre of mass for the station.

Constraints: array size = 2 -20 < phase centre value < 20

type

array

items

type

number

  • target

Target position for the sub-array beam.

Only drift scan targets are currently implemented by MCCS, hence only azimuth and elevation are specified.

type

object

properties

  • reference_frame

Co-ordinate system.

Must be HORIZON for drift scan.

type

string

  • target_name

Name of target.

type

string

  • az

Pointing azimuth in degrees.

type

number

  • el

Pointing elevation in degrees.

type

number

additionalProperties

False

additionalProperties

False

additionalProperties

False

  • csp

CSP configuration specification.

type

object

properties

  • interface

CSP Interface configuration

type

string

  • common

CSP Common configuration specification

type

object

properties

  • config_id

CSP config id configuration

type

string

additionalProperties

False

  • lowcbf

LOWCBF configuration specification.

type

object

properties

  • stations

Subarray Stations and station beam descriptions

type

object

properties

  • stns

type

array

items

type

array

items

type

integer

  • stn_beams

type

array

items

type

object

properties

  • stn_beam_id

station beam id

type

integer

  • freq_ids

list of station beam frequency ids

type

array

items

type

integer

additionalProperties

False

additionalProperties

False

  • vis

Visibility output descriptions

type

object

properties

  • fsp

FSPs used for correlation

type

object

properties

  • function_mode

Function mode name

type

string

  • fsp_ids

List of IDs (integer)

type

array

items

type

integer

additionalProperties

False

  • stn_beams

SDP visibility destinations

type

array

items

type

object

properties

  • stn_beam_id

Station Beam ID

type

integer

  • integration_ms

milliseconds integration

type

integer

  • host

SDP channel & IP Address

type

array

items

type

array

items

anyOf

type

integer

type

string

  • port

SDP chan & UDP port, stride

type

array

items

type

array

items

type

integer

  • mac

SDP channel & server MAC

type

array

default

null

items

type

array

items

anyOf

type

integer

type

string

additionalProperties

False

additionalProperties

False

additionalProperties

False

additionalProperties

False

  • sdp

SDP configuration specification.

type

object

properties

  • interface

type

string

default

null

  • transaction_id

type

string

pattern

^txn\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

default

null

  • scan_type

type

string

  • new_scan_types

type

array

default

null

items

type

object

properties

  • scan_type_id

const

(any scan type)

  • derive_from

type

string

  • beams

type

object

additionalProperties

False

additionalProperties

False

  • tmc

TMC configuration specification.

type

object

default

null

properties

  • scan_duration

Scan duration in seconds.

Value must be >= 0.0

type

number

additionalProperties

True

additionalProperties

False

Low TMC configure 3.0

Example JSON.

{
    "interface": "https://schema.skao.int/ska-low-tmc-configure/3.0",
    "transaction_id": "txn-....-00001",
    "mccs": {
        "stations": [{
            "station_id": 1
        }, {
            "station_id": 2
        }],
        "subarray_beams": [{
            "subarray_beam_id": 1,
            "station_ids": [1, 2],
            "update_rate": 0.0,
            "channels": [
                [0, 8, 1, 1],
                [8, 8, 2, 1],
                [24, 16, 2, 1]
            ],
            "antenna_weights": [1.0, 1.0, 1.0],
            "phase_centre": [0.0, 0.0],
            "target": {
                "reference_frame": "HORIZON",
                "target_name": "DriftScan",
                "az": 180.0,
                "el": 45.0
            }
        }]
    },
    "sdp": {
        "interface": "https://schema.skao.int/ska-sdp-configure/0.4",
        "scan_type": "target:a"
    },
    "csp": {
        "interface": "https://schema.skao.int/ska-csp-configure/2.0",
        "subarray": {
            "subarray_name": "science period 23"
        },
        "common": {
            "config_id": "sbi-mvp01-20200325-00001-science_A"
        },
        "lowcbf": {
            "stations": {
                "stns": [
                    [1, 0],
                    [2, 0],
                    [3, 0],
                    [4, 0]
                ],
                "stn_beams": [{
                    "beam_id": 1,
                    "freq_ids": [64, 65, 66, 67, 68, 69, 70, 71],
                    "boresight_dly_poly": "url"
                }]
            },
            "timing_beams": {
                "beams": [{
                    "pst_beam_id": 13,
                    "stn_beam_id": 1,
                    "offset_dly_poly": "url",
                    "stn_weights": [0.9, 1.0, 1.0, 0.9],
                    "jones": "url",
                    "dest_ip": ["10.22.0.1:2345", "10.22.0.3:3456"],
                    "dest_chans": [128, 256],
                    "rfi_enable": [true, true, true],
                    "rfi_static_chans": [1, 206, 997],
                    "rfi_dynamic_chans": [242, 1342],
                    "rfi_weighted": 0.87
                }]
            }
        }
    },
    "tmc": {
        "scan_duration": 10.0
    }
}

https://schema.skao.int/ska-low-tmc-configure/3.0

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • transaction_id

A transaction id specific to the command

type

string

default

null

  • mccs

MCCS configuration specification.

type

object

properties

  • stations

IDs of the MCCS stations to configure.

Maximum array size = 512, the maximum number of MCCS stations.

type

array

items

type

object

properties

  • station_id

MCCS Station ID.

Each ID must be between 1 and 512.

type

integer

additionalProperties

True

  • subarray_beams

MCCS sub-array beam configuration.

type

array

items

type

object

properties

  • subarray_beam_id

ID of MCCS sub-array beam to configure.

ID must be an integer between 1 and 48.

type

integer

  • station_ids

IDs of MCCS stations within this sub-array beamto configure.

Array size must be less than 512, the maximum number of MCCS stations.

Each item in the list must be an integer between 1 and 512.

type

array

items

type

integer

  • update_rate

Update rate for pointing information.

Value must be 0.0 or greater.

TODO: clarify whether this is specified as a frequency or as a cadence, plus units.

type

number

  • channels

Channel block configurations.

Each item in the list is a channel block configuration, each specified as a list of 4 numbers as follows:

[start channel, number of channels, beam index, sub-station index]

Constraints are:

0 < start channel < 376

start channel must be a multiple of 8

8 < number of channels < 48

1 < beam index < 48

1 < sub-station index < 8

type

array

items

type

array

items

type

integer

  • antenna_weights

Antenna weights.

Maximum array size = 512 (=256 antennas x2 pols per sub-array beam).

Antennas signals can be weighted to modify the station beam, varying from 0.0 for full exclusion to potentially 256.0 for an antenna contribution compensated for the number of antennas in the beam. This value is an amplitude multiplier added to that antenna signal before adding into the sum.

Weights apply to all channels assigned to a beam.

type

array

items

type

number

  • phase_centre

Phase centre offset for the station beam, in metres.

The reference position for station phase must be modified to reflect antenna weighting and their contribution to the station beam. This offset can be can considered the desired centre of mass for the station.

Constraints: array size = 2 -20 < phase centre value < 20

type

array

items

type

number

  • target

Target position for the sub-array beam.

Only drift scan targets are currently implemented by MCCS, hence only azimuth and elevation are specified.

type

object

properties

  • reference_frame

Co-ordinate system.

Must be HORIZON for drift scan.

type

string

  • target_name

Name of target.

type

string

  • az

Pointing azimuth in degrees.

type

number

  • el

Pointing elevation in degrees.

type

number

additionalProperties

False

additionalProperties

False

additionalProperties

False

  • csp

CSP configuration specification.

type

object

properties

  • interface

CSP Interface configuration

type

string

  • subarray

Subarray description

type

object

properties

  • subarray_name

type

string

additionalProperties

True

  • common

CSP Common configuration specification

type

object

properties

  • config_id

CSP config id configuration

type

string

additionalProperties

False

  • lowcbf

LOWCBF configuration specification.

type

object

properties

  • stations

Subarray Stations and station beam input descriptions

type

object

properties

  • stns

type

array

items

type

array

items

type

integer

  • stn_beams

type

array

items

type

object

properties

  • beam_id

station beam id

type

integer

  • freq_ids

list of station beam frequency ids

type

array

items

type

integer

  • boresight_dly_poly

URL

type

string

additionalProperties

False

additionalProperties

False

  • timing_beams

PST beam outputs descriptions

type

object

default

null

properties

  • beams

inner

type

array

items

type

object

properties

  • stn_beam_id

Station beam ID for pst beamforming

type

integer

  • pst_beam_id

PST beam ID

type

integer

  • firmware

Firmware name

type

string

default

null

  • offset_dly_poly

Delay polynomial source URI

type

string

  • dest_ip

Beam destination [ip_addr:port]

type

array

items

type

string

  • dest_chans

Number of fine chans to a destination

type

array

items

type

integer

  • jones

Jones matrix source URI

type

string

  • stn_weights

weights for each station

type

array

items

type

number

  • rfi_enable

Master enable for RFI flagging

type

array

default

null

items

type

boolean

  • rfi_static_chans

Freqency IDs to be always flagged

type

array

default

null

items

type

integer

  • rfi_dynamic_chans

Frequency IDs to be dynamically flagged

type

array

default

null

items

type

integer

  • rfi_weighted

Parameter for dynamic flagging

type

number

default

null

additionalProperties

False

additionalProperties

False

  • search_beams

PSS beam outputs descriptions

type

string

default

null

  • visibilities

Visibility output descriptions

type

string

default

null

  • zooms

Zoom visibility output descriptions

type

string

default

null

additionalProperties

False

additionalProperties

False

  • sdp

SDP configuration specification.

type

object

properties

  • interface

type

string

default

null

  • transaction_id

type

string

pattern

^txn\-[a-z0-9]+\-[0-9]{8}\-[a-z0-9]+$

default

null

  • scan_type

type

string

  • new_scan_types

type

array

default

null

items

type

object

properties

  • scan_type_id

const

(any scan type)

  • derive_from

type

string

  • beams

type

object

additionalProperties

False

additionalProperties

False

  • tmc

TMC configuration specification.

type

object

default

null

properties

  • scan_duration

Scan duration in seconds.

Value must be >= 0.0

type

number

additionalProperties

True

additionalProperties

False

Low TMC configure 2.0

Example JSON.

{
    "interface": "https://schema.skao.in/ska-low-tmc-configure/2.0",
    "transaction_id": "txn-....-00001",
    "mccs": {
        "stations": [{
            "station_id": 1
        }, {
            "station_id": 2
        }],
        "subarray_beams": [{
            "subarray_beam_id": 1,
            "station_ids": [1, 2],
            "update_rate": 0.0,
            "channels": [
                [0, 8, 1, 1],
                [8, 8, 2, 1],
                [24, 16, 2, 1]
            ],
            "antenna_weights": [1.0, 1.0, 1.0],
            "phase_centre": [0.0, 0.0],
            "target": {
                "reference_frame": "HORIZON",
                "target_name": "DriftScan",
                "az": 180.0,
                "el": 45.0
            }
        }]
    },
    "tmc": {
        "scan_duration": 10.0
    }
}

https://schema.skao.int/ska-low-tmc-configure/2.0

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • transaction_id

A transaction id specific to the command

type

string

default

null

  • mccs

MCCS configuration specification.

type

object

properties

  • stations

IDs of the MCCS stations to configure.

Maximum array size = 512, the maximum number of MCCS stations.

type

array

items

type

object

properties

  • station_id

MCCS Station ID.

Each ID must be between 1 and 512.

type

integer

additionalProperties

True

  • subarray_beams

MCCS sub-array beam configuration.

type

array

items

type

object

properties

  • subarray_beam_id

ID of MCCS sub-array beam to configure.

ID must be an integer between 1 and 48.

type

integer

  • station_ids

IDs of MCCS stations within this sub-array beamto configure.

Array size must be less than 512, the maximum number of MCCS stations.

Each item in the list must be an integer between 1 and 512.

type

array

items

type

integer

  • update_rate

Update rate for pointing information.

Value must be 0.0 or greater.

TODO: clarify whether this is specified as a frequency or as a cadence, plus units.

type

number

  • channels

Channel block configurations.

Each item in the list is a channel block configuration, each specified as a list of 4 numbers as follows:

[start channel, number of channels, beam index, sub-station index]

Constraints are:

0 < start channel < 376

start channel must be a multiple of 8

8 < number of channels < 48

1 < beam index < 48

1 < sub-station index < 8

type

array

items

type

array

items

type

integer

  • antenna_weights

Antenna weights.

Maximum array size = 512 (=256 antennas x2 pols per sub-array beam).

Antennas signals can be weighted to modify the station beam, varying from 0.0 for full exclusion to potentially 256.0 for an antenna contribution compensated for the number of antennas in the beam. This value is an amplitude multiplier added to that antenna signal before adding into the sum.

Weights apply to all channels assigned to a beam.

type

array

items

type

number

  • phase_centre

Phase centre offset for the station beam, in metres.

The reference position for station phase must be modified to reflect antenna weighting and their contribution to the station beam. This offset can be can considered the desired centre of mass for the station.

Constraints: array size = 2 -20 < phase centre value < 20

type

array

items

type

number

  • target

Target position for the sub-array beam.

Only drift scan targets are currently implemented by MCCS, hence only azimuth and elevation are specified.

type

object

properties

  • reference_frame

Co-ordinate system.

Must be HORIZON for drift scan.

type

string

  • target_name

Name of target.

type

string

  • az

Pointing azimuth in degrees.

type

number

  • el

Pointing elevation in degrees.

type

number

additionalProperties

False

additionalProperties

False

additionalProperties

False

  • tmc

TMC configuration specification.

type

object

default

null

properties

  • scan_duration

Scan duration in seconds.

Value must be >= 0.0

type

number

additionalProperties

True

additionalProperties

False

Low TMC configure 1.0

Example JSON.

{
    "interface": "https://schema.skatelescope.org/ska-low-tmc-configure/1.0",
    "mccs": {
        "stations": [{
            "station_id": 1
        }, {
            "station_id": 2
        }],
        "subarray_beams": [{
            "subarray_beam_id": 1,
            "station_ids": [1, 2],
            "update_rate": 0.0,
            "channels": [
                [0, 8, 1, 1],
                [8, 8, 2, 1],
                [24, 16, 2, 1]
            ],
            "antenna_weights": [1.0, 1.0, 1.0],
            "phase_centre": [0.0, 0.0],
            "target": {
                "system": "HORIZON",
                "name": "DriftScan",
                "az": 180.0,
                "el": 45.0
            }
        }]
    },
    "tmc": {
        "scan_duration": 10.0
    }
}

https://schema.skatelescope.org/ska-low-tmc-configure/1.0

type

object

properties

  • interface

URI of JSON schema applicable to this JSON payload.

type

string

  • transaction_id

A transaction id specific to the command

type

string

default

null

  • mccs

MCCS configuration specification.

type

object

properties

  • stations

IDs of the MCCS stations to configure.

Maximum array size = 512, the maximum number of MCCS stations.

type

array

items

type

object

properties

  • station_id

MCCS Station ID.

Each ID must be between 1 and 512.

type

integer

additionalProperties

True

  • subarray_beams

MCCS sub-array beam configuration.

type

array

items

type

object

properties

  • subarray_beam_id

ID of MCCS sub-array beam to configure.

ID must be an integer between 1 and 48.

type

integer

  • station_ids

IDs of MCCS stations within this sub-array beamto configure.

Array size must be less than 512, the maximum number of MCCS stations.

Each item in the list must be an integer between 1 and 512.

type

array

items

type

integer

  • update_rate

Update rate for pointing information.

Value must be 0.0 or greater.

TODO: clarify whether this is specified as a frequency or as a cadence, plus units.

type

number

  • channels

Channel block configurations.

Each item in the list is a channel block configuration, each specified as a list of 4 numbers as follows:

[start channel, number of channels, beam index, sub-station index]

Constraints are:

0 < start channel < 376

start channel must be a multiple of 8

8 < number of channels < 48

1 < beam index < 48

1 < sub-station index < 8

type

array

items

type

array

items

type

integer

  • antenna_weights

Antenna weights.

Maximum array size = 512 (=256 antennas x2 pols per sub-array beam).

Antennas signals can be weighted to modify the station beam, varying from 0.0 for full exclusion to potentially 256.0 for an antenna contribution compensated for the number of antennas in the beam. This value is an amplitude multiplier added to that antenna signal before adding into the sum.

Weights apply to all channels assigned to a beam.

type

array

items

type

number

  • phase_centre

Phase centre offset for the station beam, in metres.

The reference position for station phase must be modified to reflect antenna weighting and their contribution to the station beam. This offset can be can considered the desired centre of mass for the station.

Constraints: array size = 2 -20 < phase centre value < 20

type

array

items

type

number

  • target

Target position for the sub-array beam.

Only drift scan targets are currently implemented by MCCS, hence only azimuth and elevation are specified.

type

object

properties

  • system

Co-ordinate system.

Must be HORIZON for drift scan.

type

string

  • name

Name of target.

type

string

  • az

Pointing azimuth in degrees.

type

number

  • el

Pointing elevation in degrees.

type

number

additionalProperties

False

additionalProperties

False

additionalProperties

False

  • tmc

TMC configuration specification.

type

object

default

null

properties

  • scan_duration

Scan duration in seconds.

Value must be >= 0.0

type

number

additionalProperties

True

additionalProperties

False