Skip to main content

MetricConfig

Struct MetricConfig 

Source
pub struct MetricConfig {
    pub dssim: bool,
    pub ssimulacra2: bool,
    pub butteraugli: bool,
    pub psnr: bool,
    pub xyb_roundtrip: bool,
}
Expand description

Configuration for which metrics to calculate.

Fields§

§dssim: bool

Calculate DSSIM (structural dissimilarity).

§ssimulacra2: bool

Calculate SSIMULACRA2 (perceptual similarity, higher is better).

§butteraugli: bool

Calculate Butteraugli (perceptual difference, lower is better).

§psnr: bool

Calculate PSNR (peak signal-to-noise ratio). NOT RECOMMENDED.

§xyb_roundtrip: bool

Roundtrip reference through XYB color space before comparing.

When enabled, the reference image is converted RGB → XYB → u8 → XYB → RGB before computing metrics. This isolates true compression error from color space conversion error.

Recommended for codecs that operate in XYB color space (e.g., jpegli).

Implementations§

Source§

impl MetricConfig

Source

pub fn all() -> Self

Calculate all available metrics.

Source

pub fn fast() -> Self

Fast metric set (PSNR only). NOT RECOMMENDED for quality comparison.

Source

pub fn perceptual() -> Self

Perceptual metrics only (DSSIM, SSIMULACRA2, Butteraugli). RECOMMENDED.

Source

pub fn perceptual_xyb() -> Self

Perceptual metrics with XYB roundtrip. RECOMMENDED for XYB codecs.

Same as perceptual() but with XYB roundtrip enabled. This gives fairer comparisons for codecs that operate in XYB color space (like jpegli) by isolating compression error from color space conversion error.

Source

pub fn ssimulacra2_only() -> Self

SSIMULACRA2 only - good balance of speed and accuracy.

Source

pub fn with_xyb_roundtrip(self) -> Self

Enable XYB roundtrip on this config.

Trait Implementations§

Source§

impl Clone for MetricConfig

Source§

fn clone(&self) -> MetricConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetricConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MetricConfig

Source§

fn default() -> MetricConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for MetricConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MetricConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,