Struct ConvertOptions 

pub struct ConvertOptions { /* private fields */ }

Options for convert. The default converts the whole source, stretched, with no rotation or flip, resamples with the processor’s interpolation, and maps pixels as Normalization::unsigned for float destinations.

let opts = ConvertOptions::new()
    .letterbox([0, 0, 0, 255])
    .placement(LetterboxPlacement::TopLeft)
    .pad_output([0.0; 4])
    .normalization(Normalization::imagenet())
    .rotation(Rotation::None);

Implementations

impl ConvertOptions

pub fn new() -> Self

The default options.

pub fn rotation(self, rotation: Rotation) -> Self

Rotate the output, in 90° steps.

pub fn flip(self, flip: Flip) -> Self

Flip the output.

pub fn crop(self, crop: Crop) -> Self

Set the source region and fit together.

pub fn source(self, source: Option<Region>) -> Self

Sample only source of the input; None samples all of it.

pub fn letterbox(self, pad: [u8; 4]) -> Self

Letterbox: keep the source aspect ratio and pad the rest with the RGBA pixel pad, which is mapped like the image.

pub fn placement(self, placement: LetterboxPlacement) -> Self

Where a letterboxed image sits. Ignored without a letterbox fit.

pub fn pad_output(self, pad: [f32; 4]) -> Self

Pad with these values as written to the destination (after normalization; quantized for integer destinations), instead of mapping the pixel pad. Ignored without a letterbox fit.

pub fn normalization(self, normalization: impl Into<Normalization>) -> Self

How pixel values map to the destination.

pub fn interpolation(self, interpolation: Interpolation) -> Self

Resample with interpolation when this convert resizes, instead of the processor’s setting (see ImageProcessor::set_interpolation). Interpolation::Bicubic and Interpolation::Area run as Interpolation::supported, with a warning logged once per mode. EDGEFIRST_INTERPOLATION, when set, takes precedence.

pub fn get_rotation(&self) -> Rotation

The output rotation.

pub fn get_flip(&self) -> Flip

The output flip.

pub fn get_crop(&self) -> Crop

The source region and fit.

pub fn get_placement(&self) -> LetterboxPlacement

The letterbox placement.

pub fn get_pad_output(&self) -> Option<[f32; 4]>

The output-domain pad, when set.

pub fn get_normalization(&self) -> Normalization

The pixel value mapping.

pub fn get_interpolation(&self) -> Option<Interpolation>

The per-convert interpolation, or None for the processor’s.

impl ConvertOptions

pub fn from_spec(spec: &PreprocessSpec) -> Result<Self>

Options that apply a model’s preprocessing: its normalization, fit, letterbox placement, pad and interpolation.

Errors

Error::InvalidOptions for a pixel-space pad outside 0–255 or a non-finite pad.

use edgefirst_image::{ConvertOptions, LetterboxPlacement, PadSpace, PreprocessSpec};

let mut spec = PreprocessSpec::new();
spec.placement = LetterboxPlacement::TopLeft;
spec.pad = [0.0; 3];
spec.pad_space = PadSpace::Normalized;
let opts = ConvertOptions::from_spec(&spec)?;
assert_eq!(opts.get_placement(), LetterboxPlacement::TopLeft);
assert_eq!(opts.get_pad_output(), Some([0.0, 0.0, 0.0, 1.0]));
assert_eq!(opts.get_interpolation(), Some(spec.interpolation));

pub fn with_spec(self, spec: &PreprocessSpec) -> Result<Self>

These options with a model’s preprocessing applied; rotation, flip and the source crop are kept. See from_spec.

Errors

As from_spec.

pub fn content_region( &self, src_w: usize, src_h: usize, dst_w: usize, dst_h: usize, ) -> Result<ContentRegion>

Where convert puts the image content when converting an src_w×src_h source into a dst_w×dst_h destination with these options: the letterbox rectangle, or the whole destination for a stretch. It is computed by the same code the convert paints with, so mapping results back through it is exact.

Errors

Error::CropInvalid when the source crop falls outside the source.

use edgefirst_image::{ConvertOptions, Region};

let opts = ConvertOptions::new().letterbox([114, 114, 114, 255]);
let r = opts.content_region(1280, 720, 640, 640)?;
assert_eq!(r.pixels, Region::new(0, 140, 640, 360));
assert_eq!(r.normalized, [0.0, 0.21875, 1.0, 0.78125]);

Trait Implementations

impl Clone for ConvertOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ContentRegionSource for ConvertOptions

fn content_region( &self, src_w: usize, src_h: usize, dst_w: usize, dst_h: usize, ) -> Result<ContentRegion>

The content region for an src_w×src_h source converted into a dst_w×dst_h destination.

impl Copy for ConvertOptions

impl Debug for ConvertOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConvertOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ConvertOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConvertOptions