iqa 1.2.1

A single, ergonomic API over the patchwork of visual quality assessment metrics in the Rust ecosystem.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! Universal property battery for full-reference IQA metrics.
//!
//! [`run_property_suite`] encodes the rules any correct full-reference metric
//! must satisfy regardless of its algorithm. Because [`Image`] is generic over
//! its pixel format, the battery is dispatched at compile time: the
//! [`property_matrix!`] macro instantiates the suite once per pixel format for
//! each metric. A new metric inherits the whole battery by adding one module.

// With no metric features enabled there is nothing to instantiate the suite
// for, leaving the import and macro below genuinely unused.
#![cfg_attr(
    not(any(
        feature = "psnr",
        feature = "ssim",
        feature = "dssim",
        feature = "ms-ssim",
        feature = "iw-ssim",
        feature = "psnr-hvs-m",
        feature = "ciede2000",
        feature = "ssimulacra2",
        feature = "butteraugli"
    )),
    allow(unused_imports, unused_macros)
)]

mod common;

use common::*;

/// Generates one `#[test]` per pixel format, each running the full property
/// suite for the given metric on that format.
macro_rules! property_matrix {
    ($metric:ty, $($fmt:ident),+ $(,)?) => {
        $(
            #[test]
            #[allow(non_snake_case)]
            fn $fmt() {
                run_property_suite::<$fmt, $metric>();
            }
        )+
    };
}

#[cfg(feature = "psnr")]
mod psnr_rgb_averaged {
    use super::*;
    property_matrix!(PsnrRgbAvg, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "psnr")]
mod psnr_luma709 {
    use super::*;
    property_matrix!(PsnrLuma, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "ssim")]
mod ssim_rgb_averaged {
    use super::*;
    property_matrix!(SsimRgbAvg, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "ssim")]
mod ssim_luma709 {
    use super::*;
    property_matrix!(SsimLuma, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "dssim")]
mod dssim_rgb_averaged {
    use super::*;
    property_matrix!(DssimRgbAvg, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "dssim")]
mod dssim_luma709 {
    use super::*;
    property_matrix!(DssimLuma, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "ms-ssim")]
mod ms_ssim_rgb_averaged {
    use super::*;
    property_matrix!(MsssimRgbAvg, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "ms-ssim")]
mod ms_ssim_luma709 {
    use super::*;
    property_matrix!(MsssimLuma, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "iw-ssim")]
mod iw_ssim_rgb_averaged {
    use super::*;
    property_matrix!(IwssimRgbAvg, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "iw-ssim")]
mod iw_ssim_luma709 {
    use super::*;
    property_matrix!(IwssimLuma, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "psnr-hvs-m")]
mod psnr_hvs_m_rgb_averaged {
    use super::*;
    property_matrix!(PsnrHvsMRgbAvg, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "psnr-hvs-m")]
mod psnr_hvs_m_luma709 {
    use super::*;
    property_matrix!(PsnrHvsMLuma, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

#[cfg(feature = "ciede2000")]
mod ciede2000 {
    use super::*;
    property_matrix!(Ciede2000, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

// Every line below compiles only because the named format implements
// `Ssimulacra2Input`; a non-sRGB format would be rejected here by the type
// checker, which is exactly the guarantee the metric's signature provides.
#[cfg(feature = "ssimulacra2")]
mod ssimulacra2 {
    use super::*;
    property_matrix!(Ssim2, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}

// Like the ssimulacra2 block, every line compiles only because the named format
// implements `ButteraugliInput`.
#[cfg(feature = "butteraugli")]
mod butteraugli {
    use super::*;
    property_matrix!(Butteraugli, Srgb8, Srgb16, Gray8, Gray16, Rgba8, Rgba16);
}