fpm_rs::metrics::complex_field::comparison

Struct ComplexFieldComparisonMetrics

pub struct ComplexFieldComparisonMetrics {
    pub amplitude_rmse: f64,
    pub amplitude_nrmse: f64,
    pub complex_rmse: f64,
    pub complex_nrmse: f64,
    pub phase_rmse: f64,
    pub phase_mae: f64,
    pub fourier_nrmse: f64,
    pub global_phase_offset: f64,
}

Expand description

Aggregate errors between reference and globally phase-aligned complex fields.

Fields§

§amplitude_rmse: f64

Root-mean-square amplitude error.

§amplitude_nrmse: f64

Amplitude L2 error normalized by reference-field L2 norm.

§complex_rmse: f64

Root-mean-square complex residual after global-phase alignment.

§complex_nrmse: f64

Complex residual L2 norm divided by reference-field L2 norm.

§phase_rmse: f64

Root-mean-square wrapped phase error in radians over non-dark reference pixels.

§phase_mae: f64

Mean absolute wrapped phase error in radians over non-dark reference pixels.

§fourier_nrmse: f64

Centered Fourier-spectrum residual L2 norm divided by reference-spectrum norm.

§global_phase_offset: f64

Fitted global candidate-to-reference phase offset in radians.

Trait Implementations§

Source §

impl Clone for ComplexFieldComparisonMetrics

Source §

fn clone(&self) -> ComplexFieldComparisonMetrics

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 ComplexFieldComparisonMetrics

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for ComplexFieldComparisonMetrics

Source §

fn default() -> ComplexFieldComparisonMetrics

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

Source §

impl<'de> Deserialize<'de> for ComplexFieldComparisonMetrics

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Serialize for ComplexFieldComparisonMetrics

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ComplexFieldComparisonMetrics

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> DynClone for T
where T: Clone,

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§