Communication Symbols#

class StatedSymbols(symbols, states)[source]#

Bases: Symbols

A time-series of communication symbols and channel states located somewhere on the complex plane.

Parameters:

symbols (Union[Iterable, numpy.ndarray]) – A three-dimensional array of complex-valued communication symbols. The first dimension denotes the number of streams, the second dimension the number of symbol blocks per stream, the the dimension the number of symbols per block.
states (np.ndarray | SparseArray) – Four-dimensional numpy array with the first two dimensions indicating the MIMO receive and transmit streams, respectively and the last two dimensions indicating the number of symbol blocks and symbols per block.

copy()[source]#

Create a deep copy of this symbol sequence.

Returns:: Copied sequence.
Return type:: Symbols

dense_states()[source]#

Return the channel state in dense format.

Note that this method will convert the channel state to dense format if it is currently in sparse format. This operation may be computationally expensive and should be avoided if possible.

Returns: The channel state tensor in dense format.

Return type:: ndarray

property num_transmit_streams: int#

Number of impinging transmit streams.

Returns: Number of streams.

property states: ndarray | SparseArray#

Symbol state information.

Four-dimensional numpy array with the first two dimensions indicating the MIMO receive and transmit streams, respectively and the last two dimensions indicating the number of symbol blocks and symbols per block.

Raises:

ValueError – If the state array is not four-dimensional.
ValueError – If the state dimensions don’t match the symbol dimensions.

class Symbol(value, flag=SymbolType.DATA)[source]#

Bases: object

A single communication symbol located somewhere on the complex plane.

Parameters:

value (complex) – Symbol value.
flag (SymbolType, optional) – Assumed symbol type. Data is assumed by default.

flag: SymbolType#: Type of the symbol.

value: complex#: Value of the symbol.

class SymbolType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: Enum

Communication symbol type flag.

DATA = 0#: Data symbol transmitting information.

PILOT = 2#: Pilot symbol for frame detection.

REFERENCE = 1#: Reference symbol for channel estimation.

class Symbols(symbols=None)[source]#

Bases: HDFSerializable

A time-series of communication symbols located somewhere on the complex plane.

Parameters:: symbols (Union[Iterable, numpy.ndarray], optional) – A three-dimensional array of complex-valued communication symbols. The first dimension denotes the number of streams, the second dimension the number of symbol blocks per stream, the third dimension the number of symbols per block.

append_stream(symbols)[source]#

Append a new symbol stream to this symbol seris.

Represents a matrix concatenation in the first dimensions.

Parameters:: symbols (Union[Symbols, np.ndarray]) – Symbol stream to be appended to this symbol series.
Raises:: ValueError – If the number of symbols in time-domain do not match.
Return type:: None

append_symbols(symbols)[source]#

Append a new symbol sequence to this symbol seris.

Represents a matrix concatenation in the second dimensions.

Parameters:: symbols (Union[Symbols, np.ndarray]) – Symbol sequence to be appended to this symbol series.
Raises:: ValueError – If the number of symbol streams do not match.
Return type:: None

copy()[source]#

Create a deep copy of this symbol sequence.

Returns:: Copied sequence.
Return type:: Symbols

plot_constellation(axes=None, title='Symbol Constellation')[source]#

Plot the symbol constellation.

Essentially projects the time-series of symbols onto a single complex plane.

Parameters:

axes (Optional[plt.Axes], optional) – The axes to plot the graph to. By default, a new matplotlib figure is created.
title (str, optional) – Plot title. Only relevant if no axes were provided.

Returns:

Handle to the created matplotlib.pyplot figure object. None if the axes were provided.

Return type:

Optional[plt.Figure]

property num_blocks: int#

Number of symbol blocks within this symbol series.

Returns:: Number of symbols
Return type:: int

property num_streams: int#

Number of streams within this symbol series.

Returns:: Number of streams.
Return type:: int

property num_symbols: int#

Number of symbols per stream within this symbol series.

Returns:: Number of symbols
Return type:: int

property raw: ndarray#

Access the raw symbol array.

Returns:: The raw symbol array
Return type:: np.ndarray