statumen 0.1.0

Statumen whole-slide image reader
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
138
139
140
141
142
143
144
145
146
147
148
149

//! Tolerance metrics and diff dumps for parity comparisons.

use std::path::PathBuf;

#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Tolerance {
    pub max_abs: u8,
    pub mean_abs: f64,
}

impl Tolerance {
    pub const JPEG_TIGHT: Self = Self {
        max_abs: 1,
        mean_abs: 0.05,
    };

    pub const TOLERANT: Self = Self {
        max_abs: 4,
        mean_abs: 1.0,
    };
}

#[derive(Debug, Clone)]
pub struct CompareReport {
    pub bytewise_equal_rate: f64,
    pub max_abs: u8,
    pub mean_abs: f64,
    pub psnr_db: f64,
    pub passed: bool,
    pub diff_dump: Option<PathBuf>,
}

pub fn compare_rgba(actual: &[u8], expected: &[u8], tol: Tolerance) -> CompareReport {
    assert_eq!(
        actual.len(),
        expected.len(),
        "compare_rgba: length mismatch ({} vs {})",
        actual.len(),
        expected.len()
    );
    assert!(
        actual.len().is_multiple_of(4),
        "compare_rgba: not RGBA-aligned"
    );

    if actual.is_empty() {
        return CompareReport {
            bytewise_equal_rate: 1.0,
            max_abs: 0,
            mean_abs: 0.0,
            psnr_db: f64::INFINITY,
            passed: true,
            diff_dump: None,
        };
    }

    let mut equal = 0u64;
    let mut max_abs = 0u8;
    let mut sum_abs = 0u64;
    let mut sum_sq = 0u64;
    for (actual, expected) in actual.iter().zip(expected.iter()) {
        if actual == expected {
            equal += 1;
        }
        let d = actual.abs_diff(*expected);
        max_abs = max_abs.max(d);
        sum_abs += u64::from(d);
        sum_sq += u64::from(d) * u64::from(d);
    }

    let n = actual.len() as f64;
    let mean_abs = sum_abs as f64 / n;
    let mse = sum_sq as f64 / n;
    let psnr_db = if mse == 0.0 {
        f64::INFINITY
    } else {
        10.0 * (255.0_f64 * 255.0 / mse).log10()
    };
    let passed = max_abs <= tol.max_abs && mean_abs <= tol.mean_abs;

    CompareReport {
        bytewise_equal_rate: equal as f64 / n,
        max_abs,
        mean_abs,
        psnr_db,
        passed,
        diff_dump: None,
    }
}

pub fn tolerance_failure(label: &str, report: &CompareReport) -> Option<String> {
    if report.passed {
        return None;
    }
    Some(format!(
        "{label}: exceeds tolerance (max_abs={} mean_abs={:.4} psnr={:.2}dB equal_rate={:.4})",
        report.max_abs, report.mean_abs, report.psnr_db, report.bytewise_equal_rate
    ))
}

#[cfg(test)]
mod tests {
    #[allow(unused_imports)]
    use super::*;

    #[test]
    fn identical_buffers_pass_with_psnr_inf() {
        let a = vec![10u8, 20, 30, 255, 40, 50, 60, 255];
        let r = compare_rgba(&a, &a, Tolerance::JPEG_TIGHT);
        assert!(r.passed);
        assert_eq!(r.max_abs, 0);
        assert_eq!(r.mean_abs, 0.0);
        assert!(r.psnr_db.is_infinite());
        assert_eq!(r.bytewise_equal_rate, 1.0);
    }

    #[test]
    fn off_by_one_passes_jpeg_tight() {
        let a = vec![10u8; 32];
        let mut b = a.clone();
        b[0] = 11;
        let r = compare_rgba(&a, &b, Tolerance::JPEG_TIGHT);
        assert!(r.passed);
        assert_eq!(r.max_abs, 1);
    }

    #[test]
    fn off_by_two_fails_jpeg_tight_passes_tolerant() {
        let a = vec![10u8, 20, 30, 255, 40, 50, 60, 255];
        let b = vec![12u8, 20, 30, 255, 40, 50, 60, 255];
        let tight = compare_rgba(&a, &b, Tolerance::JPEG_TIGHT);
        assert!(!tight.passed);
        let tol = compare_rgba(&a, &b, Tolerance::TOLERANT);
        assert!(tol.passed);
    }

    #[test]
    fn tolerance_failure_formats_failed_report() {
        let a = vec![10u8, 20, 30, 255, 40, 50, 60, 255];
        let b = vec![12u8, 20, 30, 255, 40, 50, 60, 255];
        let report = compare_rgba(&a, &b, Tolerance::JPEG_TIGHT);

        let failure = tolerance_failure("svs-001 level=0 signinum-vs-reference", &report)
            .expect("failed report should produce gate failure");

        assert!(failure.contains("svs-001 level=0 signinum-vs-reference"));
        assert!(failure.contains("max_abs=2"));
    }
}