Precoding

Precodings are HermesPy’s way of representing a sequence of operations on parallel complex-valued data streams.

class Precoder

Bases: Generic[PrecodingType]

Base class for signal processing algorithms operating on parallel complex data streams.

property precoding: PrecodingType | None

Access the precoding configuration this precoder is attached to.

Returns:

Handle to the precoding. None if the precoder is considered floating.

Raises:

RuntimeError – If this precoder is currently floating.

class TransmitEncoder

Bases: ABC, Precoder[TransmitPrecodingType], Generic[TransmitPrecodingType]

Base class of precoding steps within transmit precoding configurations.

class ReceiveDecoder

Bases: ABC, Precoder[ReceivePrecodingType], Generic[ReceivePrecodingType]

Base class of precoding steps within receive precoding configurations.

abstract num_receive_output_streams(num_input_streams)

Get required number of output streams during decoding.

Parameters:

num_input_streams (int) – Number of input streams.

Return type:

int

Returns: The number of output streams. Negative numbers indicate infeasible configurations.

class Precoding

Bases: Sequence[PrecoderType], Generic[PrecoderType], Serializable

Base class of precoding configurations.

classmethod from_yaml(constructor, node)

Recall a new Precoding instance from YAML.

Parameters:

• constructor (SafeConstructor) – A handle to the constructor extracting the YAML information.

• node (Node) – YAML node representing the Precoding serialization.

Returns:

Newly created Precoding instance.

Return type:

Precoding

pop_precoder(index)

Remove a precoder from the processing chain.

Parameters:

index (int) – Index of the precoder to be removed.

Return type:

TypeVar(PrecoderType, bound= Precoder)

Returns: Handle to the removed precoder.

classmethod to_yaml(representer, node)

Serialize a Precoding configuration to YAML.

Parameters:

• representer (SafeRepresenter) – A handle to a representer used to generate valid YAML code. The representer gets passed down the serialization tree to each node.

• node (Precoding) – The Precoding instance to be serialized.

Returns:

The serialized YAML node. None if the object state is default.

Return type:

Node

class TransmitPrecoding

Bases: Precoding[TransmitEncoderType], Generic[TransmitEncoderType]

Base class for transmit encoding configurations.

num_transmit_input_streams(num_output_streams)

Get number of input streams required for encoding.

Parameters:

num_output_streams (int) – Number of desired output streams.

Return type:

int

Returns: The number of input streams

class ReceivePrecoding

Bases: Precoding[ReceiveDecoderType], Generic[ReceiveDecoderType]

Base class for receive decoding configurations.

num_receive_output_streams(num_input_streams)

Get number of output streams after decoding.

Parameters:

num_input_streams (int) – Number of input streams.

Return type:

int

Returns: The number of output streams.

class TransmitStreamEncoder

Bases: TransmitEncoder[TransmitSignalCoding]

Base class for multi-stream MIMO coding steps during signal transmission.

abstract encode_streams(streams, num_output_streams, device)

Encode a signal MIMO stream during transmission.

Parameters:

• streams (Signal) – The signal stream to be encoded.

• num_output_streams (int) – Number of desired output streams.

• device (TransmitState) – Physical state of the device.

Return type:

Signal

Returns: The encoded signal stream.

class ReceiveStreamDecoder

Bases: ReceiveDecoder[ReceiveSignalCoding]

Base class for multi-stream MIMO coding steps during signal reception.

abstract decode_streams(streams, num_output_streams, device)

Encode a signal MIMO stream during signal recepeption.

Parameters:

• streams (Signal) – The signal stream to be decoded.

• num_output_streams (int) – Number of desired output streams.

• device (ReceiveState) – Physical state of the device.

Return type:

Signal

Returns: The decoded signal stream.

class TransmitSignalCoding

Bases: TransmitPrecoding[TransmitStreamEncoder]

Stream MIMO coding configuration during signal transmission.

encode_streams(signal, device)

Encode a signal MIMO stream during transmission.

This operation may modify the number of streams.

Parameters:

• streams (Signal) – The signal stream to be encoded.

• device (TransmitState) – Physical state of the device.

Return type:

Signal

Returns: The encoded signal stream.

Raises:

ValueError – If the number of input streams does not match the configuration.

yaml_tag: Optional[str] = 'TransmitCoding'

YAML serialization tag.

class ReceiveSignalCoding

Bases: ReceivePrecoding[ReceiveStreamDecoder], Serializable

Stream MIMO coding configuration during signal transmission.

decode_streams(signal, device)

Decode a signal MIMO stream during reception.

This operation may modify the number of streams.

Parameters:

• streams (Signal) – The signal stream to be decoded.

• device (ReceiveState) – Physical state of the device.

Return type:

Signal

Returns: The decode signal stream.

Raises:

ValueError – If the number of input streams does not match the configuration.

yaml_tag: Optional[str] = 'ReceiveCoding'

YAML serialization tag.

class PrecoderType

Type of precoder.

alias of TypeVar(‘PrecoderType’, bound=Precoder)

class TransmitEncoderType

Type of transmit encoder.

alias of TypeVar(‘TransmitEncoderType’, bound=TransmitEncoder)

class ReceiveDecoderType

Type of receive decoder.

alias of TypeVar(‘ReceiveDecoderType’, bound=ReceiveDecoder)

class PrecodingType

Type of precoding.

alias of TypeVar(‘PrecodingType’, bound=Precoding)

class TransmitPrecodingType

Type of transmit precoding.

alias of TypeVar(‘TransmitPrecodingType’, bound=TransmitPrecoding)

class ReceivePrecodingType

Type of receive precoding.

alias of TypeVar(‘ReceivePrecodingType’, bound=ReceivePrecoding)