Pilot Section#

class PilotSection(pilot_elements=None, frame=None)[source]#

Bases: FrameSection, Serializable

Pilot symbol section within an OFDM frame.

Parameters:
  • pilot_elements (Optional[Symbols], optional) – Symbols with which the subcarriers within the pilot will be modulated. By default, a pseudo-random sequence from the frame mapping will be generated.

  • frame (Optional[CommunicationWaveformOfdm], optional) – The frame configuration this pilot section belongs to.

demodulate(_)[source]#

Demodulate a time section of a complex OFDM base-band signal into data symbols.

Parameters:

signal (np.ndarray) – Vector of complex-valued base-band samples.

Return type:

ndarray

Returns: Sequence of demodulated data and reference symbols.

classmethod from_yaml(constructor, node)[source]#

Recall a new serializable class instance from YAML.

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

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

Return type:

PilotSection

Returns: The de-serialized object.

modulate(_=None)[source]#

Modulate this section into a complex base-band signal.

Parameters:

symbols (np.ndarray) – The palced complex symbols encoded in this OFDM section. This includes both reference and data symbols to be transmitted.

Returns:

The modulated signal vector.

Return type:

np.ndarray

classmethod to_yaml(representer, node)[source]#

Serialize a serializable object 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 (PilotSection) – The channel instance to be serialized.

Return type:

MappingNode

Returns: The serialized YAML node.

property num_samples: int#

Number of samples within this OFDM time-section.

Returns:

Number of samples

Return type:

int

property pilot_elements: Symbols | None#

Symbols with which the subcarriers within the pilot will be modulated.

Returns:

A stream of symbols. None, if no subsymbols where specified.

Raises:

ValueError – If the configured symbols contains multiple streams.

yaml_tag: Optional[str] = 'OFDM-Pilot'#

YAML serialization tag