Enum AlignGrade 

pub enum AlignGrade {
    Excellent,
    Good,
    Acceptable,
    Poor,
    Failed,
}

Overall quality grade for an alignment result.

Variants

Excellent

Perfect alignment (sub-sample accuracy)

Good

Good alignment (within 1 frame)

Acceptable

Acceptable alignment (within 2-3 frames)

Poor

Poor alignment (more than 3 frames off)

Failed

Alignment failed entirely

Implementations

impl AlignGrade

pub fn from_frame_error(error_frames: f64) -> Self

Convert a numeric error (in frames) to a quality grade.

pub fn label(&self) -> &'static str

Return a human-readable label for this grade.

pub fn score(&self) -> f64

Return a numeric score from 0.0 (Failed) to 1.0 (Excellent).

Trait Implementations

impl Clone for AlignGrade

fn clone(&self) -> AlignGrade

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AlignGrade

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

Formats the value using the given formatter.

impl Ord for AlignGrade

fn cmp(&self, other: &AlignGrade) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AlignGrade

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

fn partial_cmp(&self, other: &AlignGrade) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for AlignGrade

impl Eq for AlignGrade

impl StructuralPartialEq for AlignGrade