|
| 1 | +//! # Peak Signal-to-Noise Ratio (PSNR) |
| 2 | +//! |
| 3 | +//! Measures the quality of a reconstructed or compressed image relative to the original. |
| 4 | +//! A higher PSNR generally indicates better quality. |
| 5 | +//! |
| 6 | +//! Reference: <https://en.wikipedia.org/wiki/Peak_signal-to-noise_ratio> |
| 7 | +
|
| 8 | +const PIXEL_MAX: f64 = 255.0; |
| 9 | + |
| 10 | +/// Computes the PSNR in decibels (dB) between an original and a compressed image. |
| 11 | +/// |
| 12 | +/// # Arguments |
| 13 | +/// * `original` - Pixel values of the original image (u8 slice, any channel layout) |
| 14 | +/// * `compressed` - Pixel values of the compressed/reconstructed image (same length) |
| 15 | +/// |
| 16 | +/// # Returns |
| 17 | +/// * `f64::INFINITY` when the images are identical (MSE = 0) |
| 18 | +/// * Otherwise the PSNR value in dB |
| 19 | +/// |
| 20 | +/// # Panics |
| 21 | +/// Panics if `original` and `compressed` have different lengths. |
| 22 | +pub fn peak_signal_to_noise_ratio(original: &[u8], compressed: &[u8]) -> f64 { |
| 23 | + assert_eq!( |
| 24 | + original.len(), |
| 25 | + compressed.len(), |
| 26 | + "original and compressed images must have the same number of pixels" |
| 27 | + ); |
| 28 | + |
| 29 | + let mse: f64 = original |
| 30 | + .iter() |
| 31 | + .zip(compressed.iter()) |
| 32 | + .map(|(&o, &c)| { |
| 33 | + let diff = o as f64 - c as f64; |
| 34 | + diff * diff |
| 35 | + }) |
| 36 | + .sum::<f64>() |
| 37 | + / original.len() as f64; |
| 38 | + |
| 39 | + if mse == 0.0 { |
| 40 | + return f64::INFINITY; |
| 41 | + } |
| 42 | + |
| 43 | + 20.0 * (PIXEL_MAX / mse.sqrt()).log10() |
| 44 | +} |
| 45 | + |
| 46 | +#[cfg(test)] |
| 47 | +mod tests { |
| 48 | + use super::*; |
| 49 | + |
| 50 | + #[test] |
| 51 | + fn identical_images_returns_infinity() { |
| 52 | + let img = vec![100u8, 150, 200, 50, 75, 25]; |
| 53 | + assert_eq!(peak_signal_to_noise_ratio(&img, &img), f64::INFINITY); |
| 54 | + } |
| 55 | + |
| 56 | + #[test] |
| 57 | + fn single_pixel_off_by_one() { |
| 58 | + // original: [0], compressed: [1] → MSE = 1.0 → PSNR = 20·log10(255) ≈ 48.13 dB |
| 59 | + let original = vec![0u8]; |
| 60 | + let compressed = vec![1u8]; |
| 61 | + let psnr = peak_signal_to_noise_ratio(&original, &compressed); |
| 62 | + let expected = 20.0 * 255.0_f64.log10(); |
| 63 | + assert!((psnr - expected).abs() < 1e-6, "got {psnr}"); |
| 64 | + } |
| 65 | + |
| 66 | + #[test] |
| 67 | + fn uniform_noise() { |
| 68 | + // original all-zero, compressed all-10 → MSE = 100 → PSNR = 20·log10(255/10) ≈ 28.13 dB |
| 69 | + let original = vec![0u8; 16]; |
| 70 | + let compressed = vec![10u8; 16]; |
| 71 | + let psnr = peak_signal_to_noise_ratio(&original, &compressed); |
| 72 | + let expected = 20.0 * (PIXEL_MAX / 10.0).log10(); |
| 73 | + assert!((psnr - expected).abs() < 1e-6, "got {psnr}"); |
| 74 | + } |
| 75 | + |
| 76 | + #[test] |
| 77 | + fn known_psnr_value() { |
| 78 | + // 4 pixels: diffs = [15, 15, 15, 15] → MSE = 225 → PSNR ≈ 24.61 dB |
| 79 | + let original = vec![0u8, 0, 0, 0]; |
| 80 | + let compressed = vec![15u8, 15, 15, 15]; |
| 81 | + let psnr = peak_signal_to_noise_ratio(&original, &compressed); |
| 82 | + let expected = 20.0 * (PIXEL_MAX / 15.0).log10(); |
| 83 | + assert!((psnr - expected).abs() < 1e-6, "got {psnr}"); |
| 84 | + } |
| 85 | + |
| 86 | + #[test] |
| 87 | + #[should_panic(expected = "same number of pixels")] |
| 88 | + fn mismatched_lengths_panics() { |
| 89 | + let original = vec![0u8; 4]; |
| 90 | + let compressed = vec![0u8; 8]; |
| 91 | + peak_signal_to_noise_ratio(&original, &compressed); |
| 92 | + } |
| 93 | +} |
0 commit comments