Skip to main content

SamplingThresholds

Struct SamplingThresholds 

Source
pub struct SamplingThresholds {
    pub resolved_min_samples_per_wavelength: f64,
    pub marginal_min_samples_per_wavelength: f64,
    pub resolved_max_envelope_fraction_per_cell: f64,
    pub marginal_max_envelope_fraction_per_cell: f64,
}
Expand description

Explicit thresholds used to classify a SamplingCertificate.

The default resolved carrier requirement is eight samples per wavelength, which gives four samples across the worst-case half-wavelength power fringe. Four carrier samples (two per power fringe) is the marginal Nyquist floor. Point-source 1/r envelope change defaults to five percent for resolved and ten percent for marginal.

Fields§

§resolved_min_samples_per_wavelength: f64

Comfortable carrier samples per wavelength on both axes.

§marginal_min_samples_per_wavelength: f64

Marginal carrier samples per wavelength on both axes.

§resolved_max_envelope_fraction_per_cell: f64

Comfortable maximum fractional 1/r change across a cell.

§marginal_max_envelope_fraction_per_cell: f64

Marginal maximum fractional 1/r change across a cell.

Implementations§

Source§

impl SamplingThresholds

Source

pub fn new( resolved_min_samples_per_wavelength: f64, marginal_min_samples_per_wavelength: f64, resolved_max_envelope_fraction_per_cell: f64, marginal_max_envelope_fraction_per_cell: f64, ) -> Result<Self, InterferenceError>

Validates explicit resolved and marginal classification thresholds.

Source

pub fn validate(self) -> Result<Self, InterferenceError>

Revalidates a threshold record, including one built with field syntax.

Trait Implementations§

Source§

impl Clone for SamplingThresholds

Source§

fn clone(&self) -> SamplingThresholds

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 Copy for SamplingThresholds

Source§

impl Debug for SamplingThresholds

Source§

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

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

impl Default for SamplingThresholds

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SamplingThresholds

Source§

fn eq(&self, other: &SamplingThresholds) -> 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 SamplingThresholds

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.