Struct Frame 

pub struct Frame {

    pub constellation: Option<Constellation>,
    pub pmf: Option<Vec<f64>>,
    pub bits: Vec<u8>,
    pub indices: Vec<usize>,
    pub symbols: Vec<C64>,
    pub excluded: Vec<bool>,
    pub samples: Vec<C64>,
    pub antennas: Vec<Vec<C64>>,
    pub sps: f64,
    pub symbol_rate: f64,
    pub layout: Layout,
    pub channel: ChannelState,
    pub receiver: ReceiverState,
    pub coding: Coding,
    pub in_flight: InFlight,
    pub capture: CaptureState,
    pub trial: u64,
    pub values: Vec<(String, f64)>,
    pub probes: Record,
}

The state carried along a link during one trial: what was transmitted, the current samples, and the contexts that some blocks set for the following ones.

Fields

constellation: Option<Constellation>

The constellation of the source (unit mean energy for uniform symbols).

pmf: Option<Vec<f64>>

The probabilities of the points of the constellation (probabilistic shaping); uniform if None. The rate metrics, the soft demapper and awgn_ebn0 use them.

bits: Vec<u8>

Transmitted bits (Gray labels of the constellation, MSB first).

indices: Vec<usize>

Transmitted symbol indices.

symbols: Vec<C64>

Transmitted symbols (of polarisation x, then y, with two polarisations).

excluded: Vec<bool>

Symbols excluded from the metrics (pilots, preambles), one flag per symbol.

samples: Vec<C64>

Current samples of antenna (or polarisation) 0.

antennas: Vec<Vec<C64>>

The samples of the other antennas or polarisations (1, 2, …); empty for one.

sps: f64

Current samples per symbol.

symbol_rate: f64

Symbol rate (Bd; 1 for a normalised time axis).

layout: Layout

What the streams are: antennas, layers, polarisations.

channel: ChannelState

The channel of the trial, as a genie-aided receiver knows it.

receiver: ReceiverState

What the receiver declares about its outputs.

coding: Coding

The information bits, the LLRs and the decisions of a coded link.

in_flight: InFlight

The frames between a transmitter block and its receiver (OFDM, WDM).

capture: CaptureState

A measured capture.

trial: u64

The index of the trial of the condition (set by the runner; 0 outside a campaign), for the blocks that save or label a trial.

values: Vec<(String, f64)>

Diagnostic values recorded by the blocks, reported as means.

probes: Record

The metrics measured by the probe blocks, merged into the results of the trial.

Implementations

impl Frame

pub fn fs(&self) -> f64

Sampling rate symbol_rate · sps (Hz).

pub fn n_symbols(&self) -> usize

Number of transmitted symbols.

pub fn constellation(&self, block: &str) -> Result<&Constellation>

The constellation, or an error naming the block that needs it.

Errors

Error::Config if no source has set the constellation before block.

pub fn int_sps(&self, block: &str) -> Result<usize>

The integer samples per symbol, or an error naming the block.

Errors

Error::Config unless the signal is aligned at an integer number of samples per symbol.

pub fn require_one_sps(&self, block: &str) -> Result<()>

Check that the signal is at one sample per symbol: the symbols of a source, or the output of a decimation.

Errors

Error::Config naming block unless the signal is at one sample per symbol.

pub fn require_symbols(&self, block: &str) -> Result<()>

Check that the samples are at one sample per symbol and aligned on the symbols.

Errors

Error::Config unless the signal is aligned at one sample per symbol.

pub fn record(&mut self, label: &str, name: &str, value: f64)

Record a diagnostic value.

pub fn n_streams(&self) -> usize

Number of antenna streams (1 for a single antenna).

pub fn streams(&self) -> impl Iterator<Item = &Vec<C64>>

The samples of every antenna.

pub fn streams_mut(&mut self) -> impl Iterator<Item = &mut Vec<C64>>

The samples of every antenna, mutable.

pub fn take_streams(&mut self) -> Vec<Vec<C64>>

Take the samples of every antenna, leaving the signal without samples.

pub fn set_streams(&mut self, streams: Vec<Vec<C64>>)

Set the samples of every antenna (at least one stream).

pub fn reference_power(&self) -> f64

The reference power of a noise block: the power entering the fading channel if there is one, else the mean power of the samples.

pub fn mean_power(&self) -> f64

Mean power of the samples over every antenna: their energy (comnum_math::energy) over their number.

pub fn pooled(&self) -> Cow<'_, Frame>

The signal with the polarisations of a dual-polarisation channel concatenated into one stream, aligned on symbols (the signal itself otherwise).

pub fn symbol_noise(&self, block: &str) -> Result<Vec<f64>>

The noise variance of every symbol the receiver sees: symbol_noise, else the declared posterior noise_var, else the channel’s noise_var.

Errors

Error::Config if no block has set the noise variance.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Frame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

Returns the “default value” for a type.