Struct SamplingCheck 

pub struct SamplingCheck {
    pub bandwidth_hz: f64,
    pub rate_hz: f64,
    pub min_rate_hz: f64,
    pub window_s: f64,
    pub walkoff_s: f64,
}

The sampling conditions of a split-step simulation of a signal of bandwidth $B$ over a dispersive link (Musetti et al. 2018, Appendix B): the sampling rate must hold the four-wave mixing that falls on the signal, at least $\frac{3}{2} B$ (all of the first-order mixing needs $3 B$), and the block must be longer than the walk-off across $B$ over the whole link, $|\beta_{2}| , 2\pi B , L$, or the circular convolution wraps the fast channels onto the slow ones. sampling_check computes them; SamplingCheck::is_sufficient says whether both hold.

Fields

bandwidth_hz: f64

The bandwidth of the launched signal (Hz, signal_bandwidth).

rate_hz: f64

The sampling rate (Hz).

min_rate_hz: f64

The smallest rate that holds the four-wave mixing on the signal, $\frac{3}{2} B$ (Hz).

window_s: f64

The duration of the block (s).

walkoff_s: f64

The walk-off across the bandwidth over the link (s).

Implementations

impl SamplingCheck

pub fn is_sufficient(&self) -> bool

Whether the rate and the block are sufficient.

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

Nothing when SamplingCheck::is_sufficient.

Errors

Error::Config naming what is missing otherwise.

Trait Implementations

impl Clone for SamplingCheck

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SamplingCheck

impl Debug for SamplingCheck

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

Formats the value using the given formatter.

impl PartialEq for SamplingCheck

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SamplingCheck