# Ssimulacra2 v0.1.0 - Table of Contents

> SSIMULACRA2 perceptual image-quality metric for Elixir (fast-ssim2 NIF)

## Pages

- [ssimulacra2](readme.md)
- [Changelog](changelog.md)

## Modules

- [Ssimulacra2](Ssimulacra2.md): SSIMULACRA2 perceptual image-quality metric for Elixir, backed by the
`fast-ssim2` Rust crate.
- [Ssimulacra2.CancelRef](Ssimulacra2.CancelRef.md): A cancellation handle for aborting an in-flight `Ssimulacra2.compare/5` or
`Ssimulacra2.Reference.compare/3`.
- [Ssimulacra2.Reference](Ssimulacra2.Reference.md): A precomputed SSIMULACRA2 reference image for efficient batch comparison.
- [Ssimulacra2.Vix](Ssimulacra2.Vix.md): Convenience wrappers that accept `Vix.Vips.Image` structs.

- Exceptions
  - [Ssimulacra2.Error](Ssimulacra2.Error.md): Raised by the `!` variants when a comparison fails.

