Enum ComplexMetricError 

pub enum ComplexMetricError {
    ShapeMismatch {
        reference: (usize, usize),
        estimate: (usize, usize),
    },
    MaskShapeMismatch {
        actual: (usize, usize),
        expected: (usize, usize),
    },
    EmptyMask,
    UnsupportedScalar {
        input: &'static str,
    },
    NonFinite {
        input: &'static str,
    },
    ZeroReferenceNormalization {
        metric: &'static str,
    },
    ZeroEstimateNormalization {
        metric: &'static str,
    },
    DegenerateAlignment {
        alignment: ComplexAlignment,
        reason: &'static str,
    },
}

Errors returned by explicit-alignment complex-image metrics.

Variants

ShapeMismatch

Reference and estimate have different (height, width) shapes.

Fields

reference: (usize, usize)

Reference field shape.

estimate: (usize, usize)

Estimate field shape.

MaskShapeMismatch

A selection mask does not match the field shape.

Fields

actual: (usize, usize)

Supplied mask shape.

expected: (usize, usize)

Required field shape.

EmptyMask

No pixel was selected by the optional mask.

UnsupportedScalar

A generic complex component could not be represented as f64.

Fields

input: &'static str

Name of the input containing the unsupported component.

NonFinite

An input contains a non-finite real or imaginary component.

Fields

input: &'static str

Name of the non-finite input.

ZeroReferenceNormalization

A relative metric has zero reference norm.

Fields

metric: &'static str

Metric whose reference denominator was zero.

ZeroEstimateNormalization

A normalized correlation has zero aligned-estimate norm.

Fields

metric: &'static str

Metric whose estimate denominator was zero.

DegenerateAlignment

The selected alignment cannot be fitted to the selected pixels.

Fields

alignment: ComplexAlignment

Requested alignment mode.

reason: &'static str

Explanation of the degenerate fit.

Trait Implementations

impl Debug for ComplexMetricError

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

Formats the value using the given formatter.

impl Display for ComplexMetricError

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

Formats the value using the given formatter.

impl Error for ComplexMetricError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for ComplexMetricError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ComplexMetricError