Enum PineappleImage 

pub enum PineappleImage {
    U8(PineappleBuffer<u8, Vec<u8>>),
    U16(PineappleBuffer<u16, Vec<u16>>),
    U32(PineappleBuffer<u32, Vec<u32>>),
    U64(PineappleBuffer<u64, Vec<u64>>),
    I32(PineappleBuffer<i32, Vec<i32>>),
    I64(PineappleBuffer<i64, Vec<i64>>),
    F32(PineappleBuffer<f32, Vec<f32>>),
    F64(PineappleBuffer<f64, Vec<f64>>),
}

A wrapper for representing and storing array-shaped pixels

The enum holds all valid, or potentially valid, image formats in terms of their subpixel data types. All external image types (e.g DynamicImage) should be converted to a PineappleImage via a method on this enum.

Examples

use image::{RgbImage, DynamicImage};
use pineapple_core::im::PineappleImage;

let rgb = RgbImage::new(10, 10);
let dynamic = DynamicImage::ImageRgb8(rgb);
let image = PineappleImage::new_from_default(dynamic);

use image::ImageReader;
use pineapple_core::im::PineappleImage;

let dynamic = ImageReader::open("image.png")
    .expect("Failed to read image")
    .with_guessed_format()
    .unwrap()
    .decode()
    .unwrap();

let image = PineappleImage::new_from_default(dynamic);

Variants

U8(PineappleBuffer<u8, Vec<u8>>)

U16(PineappleBuffer<u16, Vec<u16>>)

U32(PineappleBuffer<u32, Vec<u32>>)

U64(PineappleBuffer<u64, Vec<u64>>)

I32(PineappleBuffer<i32, Vec<i32>>)

I64(PineappleBuffer<i64, Vec<i64>>)

F32(PineappleBuffer<f32, Vec<f32>>)

F64(PineappleBuffer<f64, Vec<f64>>)

Implementations

impl PineappleImage

pub fn open<P: AsRef<Path>>(path: P) -> Result<PineappleImage, PineappleError>

Open a new image from a provided path

Arguments

• path - A path to an image with a valid extension

use pineapple_core::im::PineappleImage;
let image = PineappleImage::open("image.png");

pub fn new_from_default( image: DynamicImage, ) -> Result<PineappleImage, PineappleError>

Initialize a new image from a DynamicImage

Arguments

• image - An 8 or 16-bit grayscale or rgb DynamicImage

Examples

use image::{GrayImage, DynamicImage};
use pineapple_core::im::PineappleImage;

let gray = GrayImage::new(10, 10);
let dynamic = DynamicImage::ImageLuma8(gray);
let image = PineappleImage::new_from_default(dynamic);

pub fn new_from_numpy( npy: NpyFile<&[u8]>, ) -> Result<PineappleImage, PineappleError>

Initialize a new image from a numpy array buffer

Arguments

• npy - A (height, width, channel) shaped numpy array buffer

Examples

use npyz::NpyFile;
use pineapple_core::im::PineappleImage;

let bytes = std::fs::read("image.npy").unwrap();
let npy = NpyFile::new(&bytes[..]).unwrap();
let image = PineappleImage::new_from_numpy(npy);

pub fn save<P: AsRef<Path>>(self, path: P) -> Result<(), PineappleError>

Save image

Arguments

• path - A path to an image with a valid extension

use pineapple_core::im::PineappleImage;
let image = PineappleImage::open("image.png").unwrap();
image.save("image.npy").unwrap();

pub fn save_as_default<P: AsRef<Path>>( self, path: P, ) -> Result<(), PineappleError>

Save image as a default image format

Arguments

• path - Path to output image

Examples

use image::{GrayImage, DynamicImage};
use pineapple_core::im::PineappleImage;

let gray = GrayImage::new(10, 10);
let dynamic = DynamicImage::ImageLuma8(gray);
let image = PineappleImage::new_from_default(dynamic).unwrap();
image.save_as_default("new_image.png").unwrap();

pub fn save_as_numpy<P: AsRef<Path>>( self, path: P, ) -> Result<(), PineappleError>

Save image as a numpy format

Arguments

• path - Path to output image

Examples

use image::{GrayImage, DynamicImage};
use pineapple_core::im::PineappleImage;

let gray = GrayImage::new(10, 10);
let dynamic = DynamicImage::ImageLuma8(gray);
let image = PineappleImage::new_from_default(dynamic).unwrap();
image.save_as_numpy("new_image.npy").unwrap();

impl PineappleImage

pub fn width(&self) -> u32

impl PineappleImage

pub fn height(&self) -> u32

impl PineappleImage

pub fn channels(&self) -> u32

impl PineappleImage

pub fn shape(&self) -> (u32, u32, u32)

impl PineappleImage

pub fn len(&self) -> usize

impl PineappleImage

pub fn is_empty(&self) -> bool

impl PineappleImage

pub fn dtype_min(&self) -> f64

Get the minimum value for the image data type

pub fn dtype_max(&self) -> f64

Get the maximum value for the image data type

impl PineappleImage

pub fn to_u8(&self) -> Vec<u8>

impl PineappleImage

pub fn to_u16(&self) -> Vec<u16>

impl PineappleImage

pub fn to_u32(&self) -> Vec<u32>

impl PineappleImage

pub fn to_f32(&self) -> Vec<f32>

impl PineappleImage

pub fn to_f64(&self) -> Vec<f64>

impl PineappleImage

pub fn crop_view(&self, x: u32, y: u32, w: u32, h: u32) -> PineappleView<'_>

Generate a zero-copy crop of an image subregion

Arguments

• x - Minimum x-coordinate (left)
• y - Minimum y-coordinate (bottom)
• w - Width of crop
• h - Height of crop

pub fn crop( &self, x: u32, y: u32, w: u32, h: u32, ) -> Result<PineappleImage, PineappleError>

Create a new image with copied cropped contents

Arguments

• x - Minimum x-coordinate (left)
• y - Minimum y-coordinate (bottom)
• w - Width of crop
• h - Height of crop

pub fn crop_masked( &self, x: u32, y: u32, w: u32, h: u32, mask: &PineappleMaskView<'_>, mask_style: MaskingStyle, ) -> Result<PineappleImage, PineappleError>

Crops the image while applying a mask to either foreground or background pixels

Arguments

• x - Minimum x-coordinate (left)
• y - Minimum y-coordinate (bottom)
• w - Width of crop
• h - Height of crop
• mask - A cropped mask view
• mask_style - Foreground or background masking style

pub fn resize( &self, width: u32, height: u32, ) -> Result<PineappleImage, PineappleError>

Resize the image

Arguments

• width - Width of resized image
• height - Height of resized image

Trait Implementations

impl Clone for PineappleImage

fn clone(&self) -> PineappleImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PineappleImage

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

Formats the value using the given formatter.