Struct deltae::DeltaE

pub struct DeltaE { /* fields omitted */ }

The measured difference between two colors

There are many different methods of calculating color difference. Different methods have a specific purpose, mainly in determining the level of tolerance for describing the difference between two colors. Regardless of the DEMethod used, DeltaE is always calculated based on the LabValues of the two colors.

Implementations

impl DeltaE

pub fn new<A, B>(a: A, b: B, method: DEMethod) -> DeltaE where
    A: Delta,
    B: Delta, 

New DeltaE from two colors and a DEMethod.

use deltae::{LabValue, DeltaE, DEMethod::DE2000};

let lab0 = LabValue::new(89.73, 1.88, -6.96).unwrap();
let lab1 = LabValue::new(95.08, -0.17, -10.81).unwrap();
let de0 = DeltaE::new(&lab0, &lab1, DE2000);
assert_eq!(de0, 5.316941);

pub fn with_method(self, method: DEMethod) -> Self

Recalculate DeltaE with another DEMethod

use deltae::{Delta, DeltaE, LabValue, DEMethod};

let lab0 = LabValue::new(89.73, 1.88, -6.96).unwrap();
let lab1 = LabValue::new(95.08, -0.17, -10.81).unwrap();
let de2000 = lab0.delta(lab1, DEMethod::DE2000);
let de1976 = de2000.with_method(DEMethod::DE1976);
assert_eq!(de1976, 6.902716);

pub fn method(&self) -> &DEMethod

Return a reference the DeltaE method used in the calculation

pub fn value(&self) -> &f32

Return a reference to the DeltaE value

pub fn reference(&self) -> &LabValue

Return a reference to the reference LabValue used in the calculation. A reference color is the base color to which the sample color is being compared.

pub fn sample(&self) -> &LabValue

Return a reference to the sample LabValue used in the calculation. A sample color is the color being compared to the reference color.

Trait Implementations

impl Clone for DeltaE

fn clone(&self) -> DeltaE

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeltaE

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

Formats the value using the given formatter.

impl Display for DeltaE

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

Formats the value using the given formatter.

impl PartialEq<DeltaE> for DeltaE

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialEq<f32> for DeltaE

fn eq(&self, f: &f32) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialOrd<DeltaE> for DeltaE

One should be careful when ordering DeltaE. A DE2000:1.0 value is not necessarily the same amount of color difference as a amount of color difference DE1976:1.0 value.

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Round for DeltaE

fn round_to(self, places: i32) -> Self

Rounds the value to a number of decimal places

impl Tolerance for DeltaE

fn tolerance(self) -> f32

Return a tolerance value

impl Copy for DeltaE