Enum refimage::DynamicImageData

#[non_exhaustive]
pub enum DynamicImageData<'a> {
    U8(ImageData<'a, u8>),
    U16(ImageData<'a, u16>),
    F32(ImageData<'a, f32>),
}

Image data with a dynamic pixel type, backed by owned or slice of data.

This represents a matrix of pixels which are composed of primitive and common types, i.e. u8, u16, and f32. The matrix is stored in a row-major order. More variants that adhere to these principles may get added in the future, in particular to cover other combinations typically used. The data is stored in a single contiguous buffer, which is either backed by a slice or a vector, and aims to enable reuse of allocated memory without re-allocation.

Note

• Internally DynamicImageData and DynamicImageOwned serialize to the same representation, and can be deserialized into each other.

Usage

use refimage::{ImageData, ColorSpace, DynamicImageData};

let data = vec![1u8, 2, 3, 4, 5, 6];
let img = ImageData::from_owned(data, 3, 2, ColorSpace::Gray).unwrap();
let img = DynamicImageData::from(img);

This type acts as a type-erased version of ImageData and can be used to store image data with different pixel types. The pixel type is determined at runtime.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

U8(ImageData<'a, u8>)

Image data with a u8 primitive type.

U16(ImageData<'a, u16>)

Image data with a u16 primitive type.

F32(ImageData<'a, f32>)

Image data with a f32 primitive type.

Implementations

impl<'a> DynamicImageData<'a>

pub fn width(&self) -> usize

Get the width of the image.

pub fn height(&self) -> usize

Get the height of the image.

pub fn channels(&self) -> u8

Get the number of channels in the image.

pub fn color_space(&self) -> ColorSpace

Get the color space of the image.

impl<'a: 'b, 'b> DynamicImageData<'a>

pub fn into_luma(&'a self) -> Result<DynamicImageData<'a>, &'static str>

Convert the image to a luminance image.

This function uses the formula Y = 0.299R + 0.587G + 0.114B to calculate the corresponding luminance image.

Errors

• If the image is not debayered and is not a grayscale image.
• If the image is not an RGB image.

pub fn into_luma_custom( &'a self, coeffs: [f64; 3], ) -> Result<DynamicImageData<'a>, &'static str>

Convert the image to a luminance image with custom coefficients.

Arguments

• wts: The weights to use for the conversion. The weights should be in the order [R, G, B].

Errors

• If the image is not debayered and is not a grayscale image.
• If the image is not an RGB/RGBA image.

pub fn into_luma_alpha(&self) -> Result<DynamicImageData<'a>, &'static str>

Convert the image to a grayscale image with alpha channel.

In case the original image does not contain an alpha channel, the alpha channel will be filled with the maximum value of the pixel type.

Errors

• If the image is not debayered and is not a grayscale image.
• If the image is not an RGB image.

pub fn into_luma_alpha_custom( &self, coeffs: [f64; 3], ) -> Result<DynamicImageData<'a>, &'static str>

Convert the image to a grayscale image with alpha channel with custom coefficients.

In case the original image does not contain an alpha channel, the alpha channel will be filled with the maximum value of the pixel type.

Arguments

• wts: The weights to use for the conversion. The weights should be in the order [R, G, B].

Errors

• If the image is not debayered and is not a grayscale image.
• If the image is not an RGB/RGBA image.

pub fn remove_alpha(&self) -> Result<DynamicImageData<'a>, &'static str>

Remove the alpha channel from the image.

impl<'a> DynamicImageData<'a>

pub fn as_raw_u8(&self) -> &[u8]

Get the data as a slice of u8, regardless of the underlying type.

pub fn as_raw_u8_checked(&self) -> Option<&[u8]>

Get the data as a slice of u8, regardless of the underlying type.

pub fn as_slice_u8(&self) -> Option<&[u8]>

Get the data as a slice of u8.

pub fn as_mut_slice_u8(&mut self) -> Option<&mut [u8]>

Get the data as a mutable slice of u8.

pub fn as_slice_u16(&self) -> Option<&[u16]>

Get the data as a slice of u16.

pub fn as_mut_slice_u16(&mut self) -> Option<&mut [u16]>

Get the data as a mutable slice of u16.

pub fn as_slice_f32(&self) -> Option<&[f32]>

Get the data as a slice of f32.

pub fn as_mut_slice_f32(&mut self) -> Option<&mut [f32]>

Get the data as a mutable slice of f32.

pub fn into_u8(self) -> DynamicImageOwned

Convert the image to a DynamicImageOwned with u8 pixel type.

Note: This operation is parallelized if the rayon feature is enabled.

Trait Implementations

impl<'a> CalcOptExp for DynamicImageData<'a>

fn calc_opt_exp( self, eval: &OptimumExposure, exposure: Duration, bin: u8, ) -> Result<(Duration, u16), &'static str>

Calculate the optimum exposure time and binning.

impl<'a> Clone for DynamicImageData<'a>

fn clone(&self) -> DynamicImageData<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a: 'b, 'b> Debayer<'a, 'b> for DynamicImageData<'b>

fn debayer(&'b self, alg: DemosaicMethod) -> Result<Self, BayerError>

Debayer the image.

impl<'a> Debug for DynamicImageData<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for DynamicImageData<'a>

fn deserialize<D>(deserializer: D) -> Result<DynamicImageData<'a>, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&DynamicImageData<'a>> for PixelType

fn from(data: &DynamicImageData<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<DynamicImageData<'a>> for DynamicImageOwned

fn from(data: DynamicImageData<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<ImageData<'a, f32>> for DynamicImageData<'a>

fn from(data: ImageData<'a, f32>) -> Self

Converts to this type from the input type.

impl<'a> From<ImageData<'a, u16>> for DynamicImageData<'a>

fn from(data: ImageData<'a, u16>) -> Self

Converts to this type from the input type.

impl<'a> From<ImageData<'a, u8>> for DynamicImageData<'a>

fn from(data: ImageData<'a, u8>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for DynamicImageData<'a>

fn eq(&self, other: &DynamicImageData<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DynamicImageData<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DynamicImage> for DynamicImageData<'_>

Available on crate feature image only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(data: DynamicImage) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<DynamicImageData<'a>> for DynamicImage

Available on crate feature image only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: DynamicImageData<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<DynamicImageData<'a>> for ImageData<'a, f32>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(data: DynamicImageData<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<DynamicImageData<'a>> for ImageData<'a, u16>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(data: DynamicImageData<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<DynamicImageData<'a>> for ImageData<'a, u8>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(data: DynamicImageData<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> StructuralPartialEq for DynamicImageData<'a>