Skip to main content

EvalSession

Struct EvalSession 

Source
pub struct EvalSession { /* private fields */ }
Expand description

Evaluation session for codec comparison.

§Example

use codec_eval::{EvalSession, EvalConfig, ViewingCondition, ImageData};

let config = EvalConfig::builder()
    .report_dir("./reports")
    .viewing(ViewingCondition::desktop())
    .build();

let mut session = EvalSession::new(config);

session.add_codec("my-codec", "1.0.0", Box::new(|image, request| {
    // Encode the image
    Ok(encoded_bytes)
}));

let report = session.evaluate_image("test.png", image_data)?;

Implementations§

Source§

impl EvalSession

Source

pub fn new(config: EvalConfig) -> Self

Create a new evaluation session.

Source

pub fn add_codec( &mut self, id: &str, version: &str, encode: EncodeFn, ) -> &mut Self

Register a codec with an encode callback.

Source

pub fn add_codec_with_decode( &mut self, id: &str, version: &str, encode: EncodeFn, decode: DecodeFn, ) -> &mut Self

Register a codec with both encode and decode callbacks.

Source

pub fn codec_count(&self) -> usize

Get the number of registered codecs.

Source

pub fn evaluate_image( &self, name: &str, image: ImageData, ) -> Result<ImageReport>

Evaluate a single image across all registered codecs.

§Arguments
  • name - Image name or identifier.
  • image - The image data to evaluate.
§Returns

An ImageReport containing results for all codec/quality combinations.

Source

pub fn write_image_report(&self, report: &ImageReport) -> Result<()>

Write an image report to the configured report directory.

Source

pub fn write_corpus_report(&self, report: &CorpusReport) -> Result<()>

Write a corpus report to the configured report directory.

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> 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, 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.