Struct Image

pub struct Image {
    pub image_encoded: Vec<u8>,
    pub image_file_path: PathBuf,
    pub image_id: u32,
}

An encoded image.

Fields

image_encoded: Vec<u8>

Encoded image bytes.

image_file_path: PathBuf

Image file path.

image_id: u32

Image ID.

Implementations

impl Image

Interoperability with RgbImage.

pub fn decode_rgb(&self) -> Result<ImageBuffer<Rgb<u8>, Vec<u8>>, Error>

Decoding an RgbImage from Self::image_encoded.

pub fn encode_rgb( &mut self, image: ImageBuffer<Rgb<u8>, Vec<u8>>, ) -> Result<&mut Image, Error>

Encoding an RgbImage to Self::image_encoded.

impl Image

Dimension operations.

pub fn decode_dimensions(&self) -> Result<(u32, u32), Error>

Decoding the image dimensions to (width, height).

pub fn get_aspect_ratio(image: &ImageBuffer<Rgb<u8>, Vec<u8>>) -> f32

Return the aspect ratio of the image (width / height).

pub fn resize_max(&mut self, to: u32) -> Result<&mut Image, Error>

Resizing the image to the maximum side length of to.

impl Image

Interoperability with Tensor.

pub fn get_rgb_from_tensor<B>( tensor: Tensor<B, 3>, ) -> Result<ImageBuffer<Rgb<u8>, Vec<u8>>, Error>

where B: Backend,

Obtaining an RgbImage from a Tensor with shape of [H, W, C] where C == 3.

pub fn get_tensor_from_rgb<B>( image: ImageBuffer<Rgb<u8>, Vec<u8>>, device: &<B as Backend>::Device, ) -> Tensor<B, 3>

where B: Backend,

Obtaining a Tensor with shape of [H, W, C] from an RgbImage where C == 3.

pub fn decode_rgb_tensor<B>( &self, device: &<B as Backend>::Device, ) -> Result<Tensor<B, 3>, Error>

where B: Backend,

Decoding an RgbImage from Self::image_encoded, and converting it to a Tensor.

pub fn encode_rgb_tensor<B>( &mut self, tensor: Tensor<B, 3>, ) -> Result<&mut Image, Error>

where B: Backend,

Converting a Tensor with shape of [H, W, C] to an RgbImage, and encoding it to Self::image_encoded.

impl Image

I/O operations.

pub fn save(&self) -> Result<&Image, Error>

Writing Self::image_encoded to the file at Self::image_file_path.

Details

The image format is determined by ImageFormat::from_path(&self.image_file_path).

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Default for Image

fn default() -> Image

Returns the “default value” for a type.

impl PartialEq for Image

fn eq(&self, other: &Image) -> 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 StructuralPartialEq for Image