Struct Ufmc 

pub struct Ufmc {
    pub n_fft: usize,
    pub n_subbands: usize,
    pub subband_size: usize,
    pub filter_len: usize,
    pub sidelobe_db: f64,
    pub sample_rate: Hertz,
}

A UFMC modem (see the module): its fields are its parameters, set by struct update from Ufmc::default and checked by Ufmc::check (and by the modulator and the demodulator).

Fields

n_fft: usize

Size of the grid and of the IDFT, $N$.

n_subbands: usize

Sub-bands $B$.

subband_size: usize

Subcarriers per sub-band, $Q$.

filter_len: usize

Taps of the filters, $L$ (1: plain OFDM without prefix).

sidelobe_db: f64

Attenuation of the sidelobes of the Dolph–Chebyshev filters (dB).

sample_rate: Hertz

The rate of the samples, $N \Delta f$: the rate of the Signal of Modulate and the rate Demodulate expects; 1 Hz by default (time in samples).

Implementations

impl Ufmc

pub fn check(&self) -> Result<()>

Check the configuration.

Errors

comnum_core::Error::Config if the sub-bands do not fit the grid, if the filter has no tap or is longer than $N + 1$ taps (a symbol must fit the DFT of $2N$ of the receiver), or for a sample rate that is not positive and finite.

pub fn n_active(&self) -> usize

The number of active subcarriers $K = BQ$.

pub fn block_len(&self) -> usize

Samples per symbol, $N + L - 1$.

pub fn subcarrier(&self, i: usize) -> isize

The subcarrier index (centred on the carrier) of the active subcarrier i.

pub fn subband_taps(&self, b: usize) -> Vec<C64>

The taps of the filter of sub-band b: the window shifted to the centre of the sub-band.

pub fn response(&self, i: usize) -> C64

The response of the filter of the sub-band of the active subcarrier i at its frequency, the gain the receiver divides by.

pub fn modulate(&self, data: &[C64]) -> Result<Vec<C64>>

Modulate the symbols data, $K$ per UFMC symbol.

Errors

comnum_core::Error::Shape unless data holds whole symbols, and the errors of Ufmc::check.

pub fn demodulate(&self, samples: &[C64]) -> Result<Vec<C64>>

Demodulate whole symbols: zeros up to $2N$, DFT, the even bins divided by the response of the filters.

Errors

comnum_core::Error::Shape unless samples holds whole symbols, and the errors of Ufmc::check.

Trait Implementations

impl Clone for Ufmc

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 Ufmc

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

Formats the value using the given formatter.

impl Default for Ufmc

fn default() -> Ufmc

4 sub-bands of 12 subcarriers on a grid of 64, filtered by Dolph–Chebyshev filters of 16 taps whose sidelobes are 40 dB below their main lobe, at the sample rate 1 Hz (the example of the module).

impl Demodulate for Ufmc

UFMC as a Demodulate block: one stream of samples at Ufmc::sample_rate.

fn demodulate_into(&mut self, y: &Signal, out: &mut Symbols) -> Result<()>

Errors

comnum_core::Error::Config for several streams or a signal at another sample rate, and the errors of Ufmc::demodulate.

fn demodulate(&mut self, y: &Signal) -> Result<Out, Error>

where Out: Default,

Demodulate y (allocates, calls Demodulate::demodulate_into).

impl Modulate for Ufmc

UFMC as a Modulate block: one stream of symbols into one stream of samples at Ufmc::sample_rate.

fn modulate_into(&self, x: &Symbols, out: &mut Signal) -> Result<()>

Modulate x into out.

fn modulate(&self, x: &In) -> Result<Signal, Error>

Modulate x (allocates, calls Modulate::modulate_into).

impl PartialEq for Ufmc

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Ufmc