Skip to main content

ComparisonResult

pedalkernel_validate::metrics

Struct ComparisonResult

pub struct ComparisonResult {
    pub normalized_rms_error_db: f64,
    pub peak_error_db: f64,
    pub thd_error_db: Option<f64>,
    pub thd_plus_n_error_db: Option<f64>,
    pub harmonic_mag_error_db: Option<f64>,
    pub even_odd_ratio_error_db: Option<f64>,
    pub spectral_error_db: f64,
    pub spectral_error_full_db: f64,
    pub even_odd_ratio_db: Option<f64>,
    pub dc_drift_mv: Option<f64>,
}

Expand description

Result of comparing WDF output to reference.

Fields§

§normalized_rms_error_db: f64§peak_error_db: f64§thd_error_db: Option<f64>§thd_plus_n_error_db: Option<f64>

THD+N error between WDF and reference in dB. None when fundamental_hz is not provided.

§harmonic_mag_error_db: Option<f64>

Maximum per-harmonic magnitude error in dB. None when fundamental_hz is not provided.

§even_odd_ratio_error_db: Option<f64>

Even/odd ratio error between WDF and reference in dB. None when fundamental_hz is not provided.

§spectral_error_db: f64

Spectral error within the audio band (capped at the audio Nyquist by the production runners). This is the value checked against pass criteria.

§spectral_error_full_db: f64

Spectral error across the full data spectrum (up to sample_rate / 2, i.e. the oversampled Nyquist). Informational only — shows what the audio-band cap removes (ultrasonic content the engine anti-aliases away).

§even_odd_ratio_db: Option<f64>§dc_drift_mv: Option<f64>

Implementations§

impl ComparisonResult

pub fn passes(&self, criteria: &PassCriteria) -> bool

Check if all metrics pass the given criteria.

Trait Implementations§

impl Clone for ComparisonResult

fn clone(&self) -> ComparisonResult

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

impl Debug for ComparisonResult

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

Formats the value using the given formatter. Read more

impl From<ComparisonResult> for ComparisonMetrics

fn from(cr: ComparisonResult) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

impl Freeze for ComparisonResult

impl RefUnwindSafe for ComparisonResult

impl Send for ComparisonResult

impl Sync for ComparisonResult

impl Unpin for ComparisonResult

impl UnsafeUnpin for ComparisonResult

impl UnwindSafe for ComparisonResult

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more