Expand description
Metrics for complex fields such as reconstructed objects and pupils.
Re-exports§
pub use comparison::ComplexFieldComparisonMetrics;pub use comparison::compare_complex_fields;pub use comparison::compare_complex_fields_masked;pub use statistics::RadialFourierSpectrum;pub use statistics::radial_fourier_spectrum;
Modules§
- comparison
- Metrics comparing a reference and candidate complex field.
- statistics
- Metrics calculated from one complex-valued field.
Enums§
- Complex
Alignment - Alignment applied to an estimate before evaluating a complex-image metric.
- Complex
Metric Error - Errors returned by explicit-alignment complex-image metrics.
Functions§
- amplitude_
nrmse - Compare magnitudes after alignment, normalized by reference magnitude energy.
- bias
- Return the arithmetic mean of
aligned_estimate - reference. - correlation
- Return normalized complex correlation after alignment.
- mae
- Return the mean residual magnitude,
mean(|aligned_estimate - reference|). - mse
- Return
mean(|aligned_estimate - reference|²). - nrmse
- Return
||aligned_estimate - reference||₂ / ||reference||₂. - relative_
l1 - Return
sum(|aligned_estimate - reference|) / sum(|reference|). - rmse
- Return
sqrt(mean(|aligned_estimate - reference|²)).