Skip to main content

Wiener2d

Struct Wiener2d 

Source
pub struct Wiener2d { /* private fields */ }
Expand description

The 2-D Wiener interpolator of a set of pilots (see the module).

Implementations§

Source§

impl Wiener2d

Source

pub fn new( pilots: Vec<(usize, usize)>, corr: Correlation2d, noise_to_pilot: f64, n_taps: usize, ) -> Result<Wiener2d>

The interpolator of the pilots at (symbol, subcarrier) positions, for the correlation corr, the noise of the LS estimates noise_to_pilot = $\sigma^{2}/E_{p}$ and $N_{\mathrm{tap}}$ = n_taps pilots per position (at most the number of pilots).

§Errors

comnum_core::Error::Config without pilots, for no tap or more taps than pilots, a negative noise or Doppler.

Source

pub fn pilots(&self) -> &[(usize, usize)]

The pilots, (symbol, subcarrier).

Source

pub fn n_taps(&self) -> usize

The pilots per estimated position, $N_{\mathrm{tap}}$.

Source

pub fn taps(&self, l: usize, k: usize) -> Vec<usize>

The pilots (indices into the pilot list) used for the position (l, k): the $N_{\mathrm{tap}}$ nearest in $|\Delta l| f_{D} T_{s} + |\Delta k| \tau \Delta F$.

Source

pub fn plan(&self, targets: &[(usize, usize)]) -> Result<WienerPlan>

The estimator of the positions targets, factored once per set of taps: apply it to the LS estimates of every symbol that shares the pilots and the correlation.

§Errors

comnum_core::Error::Numerical for a singular system.

Source

pub fn estimate( &self, h_ls: &[C64], targets: &[(usize, usize)], ) -> Result<Vec<C64>>

The estimates at the positions targets from the LS estimates h_ls at the pilots (in their order).

§Errors

comnum_core::Error::Shape unless h_ls has one value per pilot, comnum_core::Error::Numerical for a singular system.

Source

pub fn mse(&self, targets: &[(usize, usize)]) -> Result<Vec<f64>>

The mean square error $J_{o}$ of the estimate at every position of targets (eq. (12)), for a channel of the assumed correlation.

§Errors

comnum_core::Error::Numerical for a singular system.

Trait Implementations§

Source§

impl Clone for Wiener2d

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Wiener2d

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Wiener2d

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Wiener2d

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.