ska_oso_pdm.entities.csp.common

The csp.common module models SB entities concerned with CSP (Central Signal Processing) beam former and correlator configuration. The contents of the module are presented in the diagram below.

Class diagram for the common module within csp

An example serialisation of this model to JSON is shown below.

  # JSON modelled specifically by csp_configuration
  ...
"csp_configurations": [{
    "config_id": "csp-mvp01-20220329-00001",
    "subarray": {"subarray_name": "science period 23"},
    "common": {
      "subarray_id": 1,
      "band_5_tuning": [5.85,7.25]
    },
    "cbf": {
      "fsp": [{
          "fsp_id": 1,
          "function_mode": "CORR",
          "frequency_slice_id": 1,
          "integration_factor": 1,
          "zoom_factor": 0,
          "channel_averaging_map": [[0,2],[744,0]],
          "channel_offset": 0,
          "output_link_map": [[0,0],[200,1]]
        },
        {
          "fsp_id": 2,
          "function_mode": "CORR",
          "frequency_slice_id": 2,
          "integration_factor": 1,
          "zoom_factor": 1,
          "zoom_window_tuning": 650000
        }]
    }
  }
],
  ...

The entities.csp_configuration module defines a simple Python representation of CSP and FSP configurations.

class CSPConfiguration(config_id: str = None, subarray_config: ska_oso_pdm.entities.csp.common.SubarrayConfiguration = None, common_config: ska_oso_pdm.entities.csp.common.CommonConfiguration = None, cbf_config: ska_oso_pdm.entities.csp.common.CBFConfiguration = None, pst_config: ska_oso_pdm.entities.csp.common.PSTConfiguration = None, pss_config: ska_oso_pdm.entities.csp.common.PSSConfiguration = None)

Class to hold all CSP configuration.

CSPConfigurationID

alias of builtins.str

class FSPConfiguration(fsp_id: int, function_mode: ska_oso_pdm.entities.csp.common.FSPFunctionMode, frequency_slice_id: int, integration_factor: int, zoom_factor: int, channel_averaging_map: List[Tuple] = None, output_link_map: List[Tuple] = None, channel_offset: int = None, zoom_window_tuning: int = None)

FSPConfiguration defines the configuration for a CSP Frequency Slice Processor.

class FSPFunctionMode

FSPFunctionMode is an enumeration of the available FSP modes.

class CBFConfiguration(fsp_configs: List[ska_oso_pdm.entities.csp.common.FSPConfiguration], vlbi_config: Optional[ska_oso_pdm.entities.csp.common.VLBIConfiguration] = None)

Class to hold all FSP and VLBI configurations.

class SubarrayConfiguration(subarray_name: str)

Class to hold the parameters relevant only for the current sub-array device.

class CommonConfiguration(subarray_id: Optional[int] = None, band_5_tuning: Optional[List[float]] = None)

Class to hold the CSP sub-elements.