Station Beam Device

This module implements the MCCS station beam device.

class MccsStationBeam(*args: Any, **kwargs: Any)[source]

An implementation of a station beam Tango device for MCCS.

ApplyPointing() → ska_tango_base.type_hints.TaskFunctionType[source]

Apply pointing delays to antennas associated with the station_beam.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

AssignResources(subarray_id: int, subarray_beam_id: int, station_id: int, station_trl: str, channel_blocks: list[int], hardware_beam: int, aperture_id: str, first_subarray_channel: int, number_of_channels: int, **kwargs: Any) → ska_tango_base.type_hints.TaskFunctionType[source]

Assign resources to the station beam with all relevant parameters.

Parameters:

subarray_id – ID of the subarray to which the beam belongs
subarray_beam_id – ID of the subarray beam
station_id – ID of the associated station
station_trl – TRL of the associated station
channel_blocks – List of the allocated station channel blocks
hardware_beam – Allocated station hardware beam
first_subarray_channel – First channel
number_of_channels – Number of channels
aperture_id – ID of the aperture in format “APx.y”
kwargs – optional arguments including: - interface.

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

Configure(logical_bands: list[dict[str, int]], **kwargs: Any) → ska_tango_base.type_hints.TaskFunctionType[source]

Configure the station_beam with all relevant parameters.

Parameters:

logical_bands – Description of observed sky frequency bands
kwargs – optional arguments including: - update_rate: Update rate for pointing, default never - weighting_key_ref: Antenna weights, default uniform, - field: Pointing direction - calibration_id: Unique calibration id.

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

End() → ska_tango_base.type_hints.TaskFunctionType[source]

Deconfigure the station_beam.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

EndScan() → ska_tango_base.type_hints.TaskFunctionType[source]

Stop the current scan associated with the station_beam.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

ObsReset() → ska_tango_base.type_hints.TaskFunctionType[source]

Reset to IDLE the station_beam.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

ReleaseAllResources() → ska_tango_base.type_hints.TaskFunctionType[source]

Release all allocated resources from the station_beam.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

Restart() → ska_tango_base.type_hints.TaskFunctionType[source]

Restart to EMPTY the station_beam.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

Scan(scan_id: int, **kwargs: Any) → ska_tango_base.type_hints.TaskFunctionType[source]

Start the scan associated with the station_beam.

Parameters:

scan_id – The ID for this scan
kwargs – Optional arguments including: - start_time: UTC time for begin of scan, None for immediate start - duration: Scan duration in seconds. 0.0 or omitted means forever

Returns:

A tuple containing a return code and a string message indicating status. The message is for information purpose only.

ToFault() → tuple[list[ska_control_model.ResultCode], list[str | None]][source]

Put this station beam in ObsState.FAULT.

This is for use in testing only.

Returns:: A tuple containing a return code and a string message indicating status. The message is for information purpose only.

__init__(*args: Any, **kwargs: Any) → None[source]

Initialise this device object.

Parameters:

args – positional args to the init
kwargs – keyword args to the init

antennaWeights() → list[float][source]

Return the antenna weights configured for this beam.

Returns:: antenna weightd

apertureId() → str[source]

Return the Aperture Id.

Returns:: the station beam Aperture Id, in the form APx.y y=substation

beamId() → int[source]

Return the station beam id.

Returns:: the station beam id

beamWeightStoreTrl() → str[source]

Return the beam weight store TRL.

Returns:: the beam weight store TRL

calibrationId() → str[source]

Return the calibration ID set during the last Configure.

Returns:: the calibration ID, or an empty string if none was resolved.

channels() → list[list[int]][source]

Return the ids of the channels configured for this beam.

Returns:: channel ids

completed_Abort() → None[source]: Abort command completed callback.

completed_AssignResources() → None[source]: Assign Resources command completed callback.

completed_Configure() → None[source]: Configure command completed callback.

completed_ObsReset() → None[source]: Obs Reset command completed callback.

completed_ReleaseAllResources() → None[source]: Release All Resources command completed callback.

completed_Restart() → None[source]: Restart command completed callback.

create_component_manager() → StationBeamComponentManager[source]

Create and return a component manager for this device.

Returns:: a component manager for this device.

desiredPointing() → list[float] | str[source]

Return the desired pointing of this beam.

Returns:: the desired point of this beam, conforming to the Sky Coordinate Set definition

failedPointingUpdates() → int | None[source]

Return how many failed pointing updates we have had in a row.

Returns:: how many failed pointing updates we have had in a row.

hardwareBeamId() → int[source]

Return the timestamp used for the pointing coordinates.

Returns:: the timestamp used for the pointing coordinates.

healthModelParams(argin: str) → None[source]

Set the params for health transition rules.

Parameters:: argin – JSON-string of dictionary of health states

healthReport() → str[source]

Get the health report.

Returns:: the health report.

init_device() → None[source]: Initialise the device.

isBeamLocked() → bool | None[source]

Return a flag indicating whether the beam is locked or not.

Returns:: whether the beam is locked or not

logicalBeamId() → int[source]

Return the logical beam id.

Todo:: this documentation needs to differentiate logical beam id from beam id
Returns:: the logical beam id

phaseCentre() → list[float][source]

Return the phase centre.

Returns:: the phase centre

pointingDelay() → list[float][source]

Return the pointing delay of this beam.

Returns:: the pointing delay of this beam

pointingDelayRate() → list[float][source]

Return the pointing delay rate of this beam.

Returns:: the pointing delay rate of this beam

pointingReferenceFrame() → str[source]

Return the Reference Frame ID for the pointing coordinates.

Returns:: the Reference Frame ID for the pointing coordinates

pointingTimestamp() → str[source]

Return the timestamp used for the pointing coordinates.

Returns:: the timestamp used for the pointing coordinates.

scanId() → int[source]

Return the scan ID for the current scan.

Returns:: the scan ID or 0 if not scanning

schedule_abort_task(task_callback: ska_tango_base.type_hints.TaskCallbackType) → tuple[ska_control_model.TaskStatus, str][source]

Schedule an Abort task to begin executing immediately.

Subclasses should override this to change the behaviour of the Abort() command.

Parameters:: task_callback – Notified of progress of the abort command.
Returns:: A tuple containing TaskStatus.IN_PROGRESS and a message

started_Abort() → None[source]: Abort command started callback.

started_AssignResources() → None[source]: Assign Resources command started callback.

started_Configure() → None[source]: Configure command started callback.

started_ObsReset() → None[source]: Obs Reset command started callback.

started_ReleaseAllResources() → None[source]: Release All Resources command started callback.

started_Restart() → None[source]: Restart command started callback.

stationId() → int[source]

Return the station id.

Returns:: the station id

stationTrl() → str[source]

Return the station TRL.

Returns:: the station TRL

subarrayId() → int[source]

Return the subarray id.

Returns:: the subarray id

updateRate() → float[source]

Return the update rate (in seconds) for this station beam.

Returns:: the update rate for this station beam

main(*args: str, **kwargs: str) → int[source]

Entry point for module.

Parameters:

args – positional arguments
kwargs – named arguments

Returns:

exit code