Source code for ska.cdm.messages.subarray_node.configure.mccs

"""
The configure.mccs module contains Python classes that represent the various
aspects of MCCS configuration that may be specified in a SubArray.configure
command.
"""

from typing import List

__all__ = [
    "MCCSConfiguration",
    "StnConfiguration",
    "SubarrayBeamConfiguration",
    "SubarrayBeamTarget"
]


[docs]class SubarrayBeamTarget: """ Target encapsulates source coordinates and source metadata. The SubArrayNode ICD specifies that az and el must be provided """ # pylint: disable=too-many-arguments def __init__(self, az: float, el: float, name: str, system: str): """ Initialise the station configuration. :param az: Az specification with rates :type az: float :param el: El specification with rates :type el: float :param name: Source name :type name: str :param system: Target coordinate system :type system: str """ self.az = az self.el = el self.name = name self.system = system def __eq__(self, other): """ Check for equality between two SubarrayBeamTarget objects :param other: the object to check against this object :type other: SubarrayBeamTarget object :return: returns True if the objects are the same, else False :rtype: boolean """ if not isinstance(other, SubarrayBeamTarget): return False return (self.az == other.az and self.el == other.el and self.name == other.name and self.system == other.system)
[docs]class StnConfiguration: """A class to hold station configuration configuration""" def __init__(self, station_id: int): """ Initialise the station configuration. :param station_id: stations id :type station_id: int """ self.station_id = station_id def __eq__(self, other): """ Check for equality between two station configuration objects :param other: the object to check against this object :type other: station configuration object :return: returns True if the objects are the same, else False :rtype: boolean """ if not isinstance(other, StnConfiguration): return False return self.station_id == other.station_id
[docs]class SubarrayBeamConfiguration: """A class to hold subarray_beam configuration attributes""" def __init__( self, subarray_beam_id: int, station_ids: List[int], channels: List[List[int]], update_rate: float, target: SubarrayBeamTarget, antenna_weights: List[float], phase_centre: List[float] ): """ Initialise the station beam configuration. :param subarray_beam_id: stationbeam's id :type subarray_beam_id: int :param station_ids: station id's :type station_ids: List[int] :param channels: channels to form station beam :type channels: List[Tuple] :param update_rate: frequency of new Az/El during scan :type update_rate: float :param target: Az/El specification with target source :type target: SubarrayBeamTarget :param antenna_weights: antenna_weights :type antenna_weights: List[float] :param phase_centre: phase_centre :type phase_centre: List[float] """ self.subarray_beam_id = subarray_beam_id self.station_ids = station_ids self.channels = channels self.update_rate = update_rate self.target = target self.antenna_weights = antenna_weights self.phase_centre = phase_centre def __eq__(self, other): """ Check for equality between two station beam configuration objects :param other: the object to check against this object :type other: station beam configuration object :return: returns True if the objects are the same, else False :rtype: boolean """ if not isinstance(other, SubarrayBeamConfiguration): return False return ( self.subarray_beam_id == other.subarray_beam_id and self.station_ids == other.station_ids and self.channels == other.channels and self.update_rate == other.update_rate and self.target == other.target and self.antenna_weights == other.antenna_weights and self.phase_centre == other.phase_centre )
[docs]class MCCSConfiguration: """ Class to hold all subarray configuration. """ def __init__( self, station_configs: List[StnConfiguration], subarray_beam_configs: List[SubarrayBeamConfiguration], ): """ Create a new MCCSConfiguration. :param station_configs: a list of station configurations :type station_configs: List[StnConfiguration] :param subarray_beam_configs: a list of subarray beam configurations :type subarray_beam_configs: List[SubarrayBeamConfiguration] """ self.station_configs = station_configs self.subarray_beam_configs = subarray_beam_configs def __eq__(self, other): """ Check for equality between two mccs configuration objects :param other: the object to check against this object :type other: mccs configuration object :return: returns True if the objects are the same, else False :rtype: boolean """ if not isinstance(other, MCCSConfiguration): return False return ( self.station_configs == other.station_configs and self.subarray_beam_configs == other.subarray_beam_configs )