Enum IntensityMetricError 

pub enum IntensityMetricError {
    ShapeMismatch {
        reference: (usize, usize),
        estimate: (usize, usize),
    },
    MaskShapeMismatch {
        actual: (usize, usize),
        expected: (usize, usize),
    },
    EmptyValidMask,
    UnsupportedScalar {
        input: &'static str,
    },
    NonFinite {
        input: &'static str,
    },
    ZeroReferenceNormalization {
        metric: &'static str,
    },
    ZeroVariance,
    NegativeIntensity {
        metric: &'static str,
    },
    InvalidDataRange,
    InvalidEpsilon,
    SsimImageTooSmall {
        shape: (usize, usize),
    },
    NoValidSsimWindow,
}

Errors returned by intensity comparison metrics.

Variants

ShapeMismatch

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

Fields

reference: (usize, usize)

Reference image shape.

estimate: (usize, usize)

Estimate image shape.

MaskShapeMismatch

A validity mask does not match the image shape.

Fields

actual: (usize, usize)

Supplied mask shape.

expected: (usize, usize)

Required image shape.

EmptyValidMask

No pixel was selected by the optional mask.

UnsupportedScalar

A generic scalar could not be represented as f64.

Fields

input: &'static str

Name of the input containing the unsupported scalar.

NonFinite

An input contains NaN or infinity.

Fields

input: &'static str

Name of the non-finite input.

ZeroReferenceNormalization

A relative metric has zero reference norm.

Fields

metric: &'static str

Metric whose denominator was zero.

ZeroVariance

Pearson correlation is undefined because an input has zero variance.

NegativeIntensity

A square-root or Poisson metric received a negative intensity.

Fields

metric: &'static str

Metric requiring non-negative values.

InvalidDataRange

PSNR or SSIM received a non-positive or non-finite data range.

InvalidEpsilon

A Poisson metric received a non-positive or non-finite numerical floor.

SsimImageTooSmall

An image is smaller than the canonical 11-by-11 SSIM window.

Fields

shape: (usize, usize)

Supplied image shape.

NoValidSsimWindow

A mask excludes every complete SSIM window.

Trait Implementations

impl Debug for IntensityMetricError

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

Formats the value using the given formatter.

impl Display for IntensityMetricError

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

Formats the value using the given formatter.

impl Error for IntensityMetricError

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 IntensityMetricError

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