Receiver

class Receiver(seed=None, reference=None, selected_receive_ports=None, carrier_frequency=None)

Bases: Generic[ReceptionType], MixingOperator, RandomNode

Operator receiving from a device.

Parameters:

• seed (int, optional) – Random seed used to initialize the pseudo-random number generator.

• reference (Device, optional) – Reference device to which the channel shall be estimated.

• selected_receive_ports (Sequence[int] | None) – Indices of antenna ports selected for reception from the operated Device's antenna array. If not specified, all available antenna ports will be considered.

• carrier_frequency (float, optional) – Central frequency of the mixed signal in radio-frequency transmission band. If not specified, the operated device’s default carrier frequency will be assumed during signal processing.

add_receive_callback(callback)

Add a callback to be called after processing the receive DSP algorithm.

Parameters:

callback (Callable[[ReceptionType], None]) – Function to be called after processing the receive DSP algorithm. The receive output is passed as the only argument.

Return type:

Hook[TypeVar(ReceptionType, bound= Reception)]

Returns: Hook to be used for removal.

receive(signal, state, notify=True)

Process a received signal by the receiver.

Wrapper around the abstract _receive method.

Parameters:

• signal (Signal) – Model of the signal samples to be processed by the DSP algorithm.

• state (DeviceState) – State of the receiving device to be conmsidered by the DSP algorithm.

• notify (bool, optional) – Notify the receiver’s callbacks. Enabled by default.

Return type:

TypeVar(ReceptionType, bound= Reception)

Returns: Information received by this operator.

Raises:

ValueError – If the number of signal streams does not match the number of receive ports.

abstract property power: float

Expected power of the received signal in Watts.

Note

Applies only to the signal-carrying parts of the transmission, silent parts shuch as guard intervals should not be considered.

property reference: Device | None

Reference transmitter for this receiver.

Returns:

A handle to the referenced device. None if the device was not specified.

property selected_receive_ports: Sequence[int] | None

Indices of antenna ports selected for reception from the operated Device's antenna array.

If None, all available antenna ports will be considered.