Skip to main content

Module helpers

Module helpers 

Source
Expand description

Lightweight evaluation helpers for codec testing.

These helpers provide simple APIs for common use cases:

  • Evaluate a single encoded image against a reference
  • Assert quality thresholds in CI tests
  • Quick quality checks during development

§Example

use codec_eval::eval::helpers::{evaluate_single, assert_quality};
use codec_eval::metrics::MetricConfig;
use imgref::ImgVec;
use rgb::RGB8;

// Evaluate quality
let reference: ImgVec<RGB8> = // ...
let encoded_data = encode_image(&reference);
let decoded = decode_image(&encoded_data);

let config = MetricConfig::perceptual();
let result = evaluate_single(&reference, &decoded, &config).unwrap();

println!("DSSIM: {:?}", result.dssim);
println!("SSIMULACRA2: {:?}", result.ssimulacra2);

// Assert quality in tests
assert_quality(&reference, &decoded, Some(80.0), Some(0.002)).unwrap();

Functions§

assert_perception_level
Assert that quality is at the specified perception level or better.
assert_quality
Assert that quality meets specified thresholds.
evaluate_single
Evaluate a single encoded image against a reference.