Struct PineappleBuffer 

pub struct PineappleBuffer<T, Container> {
    pub buffer: Container,
    /* private fields */
}

A row-major container storing an image buffer or grid of pixels.

The struct is generic over the data type T and over the container that holds raw pixel/subpixel data as a slice ([T]) or vector (Vec<T>). The container holding the pixel data must implement Deref<Target = [T]> to allow for slice-like access to the data. The length of the container must also be equal to the product of w * h * c.

Examples

use pineapple_core::im::PineappleBuffer;

let width = 10;
let height = 10;
let channels = 3; // RGB
let data = vec![0u8; (width * height * channels) as usize];

let buffer = PineappleBuffer::new(width, height, channels, data);

assert_eq!(buffer.unwrap().len(), (width * height * channels) as usize);

use pineapple_core::im::PineappleBuffer;

let width = 10;
let height = 10;
let channels = 3; // RGB
let data = vec![0u8; (width * height * 3 * channels) as usize];

let buffer = PineappleBuffer::new(width, height, channels, data);

assert!(buffer.is_err()); // Buffer size does not match dimensions

Fields

buffer: Container

Implementations

impl<T, Container> PineappleBuffer<T, Container>

where T: ToPrimitive + FromPrimitive, Container: Deref<Target = [T]>,

pub fn new( width: u32, height: u32, channels: u32, buffer: Container, ) -> Result<PineappleBuffer<T, Container>, PineappleError>

Initializes a buffer from a generic data container

Arguments

• width - Image width
• height - Image height
• channels - Number of image channels (e.g. 1 for grayscale)
• buffer - A generic container (e.g. Vec or slice)

Examples

use pineapple_core::im::PineappleBuffer;
let buffer = [0, 1, 2, 3, 4];
let buffer = PineappleBuffer::new(2, 2, 1, buffer.as_slice());

impl<T, Container> PineappleBuffer<T, Container>

where T: ToPrimitive + FromPrimitive, Container: Deref<Target = [T]>,

pub fn width(&self) -> u32

Width of the image

pub fn height(&self) -> u32

Height of the image

pub fn channels(&self) -> u32

Number of channels in the image

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

Shape/dimensions of the image

pub fn len(&self) -> usize

Length of the raw image

pub fn is_empty(&self) -> bool

Check if buffer is empty

impl<T, Container> PineappleBuffer<T, Container>

where T: ToPrimitive + FromPrimitive, Container: Deref<Target = [T]>,

pub fn into_raw(self) -> Container

Returns the raw image

pub fn as_raw(&self) -> &Container

Returns a reference to the raw image

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

Cast subpixels to u8 and return the buffer

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

Cast subpixels to u16 and return the buffer

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

Cast subpixels to u16 and return the buffer

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

Cast subpixels to f32 and return the buffer

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

Cast subpixels to f64 and return the buffer

pub fn iter(&self) -> impl Iterator<Item = &T>

pub fn iter_channel( &self, channel: u32, ) -> Result<impl Iterator<Item = &T>, PineappleError>

where Container: Deref<Target = [T]>,

pub fn iter_pixels(&self) -> ChunksExact<'_, T>

impl<T, Container> PineappleBuffer<T, Container>

where Container: Deref<Target = [T]> + FromIterator<T>, T: Clone + ToPrimitive + FromPrimitive,

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

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<PineappleBuffer<T, Container>, PineappleError>

Create a new buffer 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<PineappleBuffer<T, Container>, PineappleError>

Crops the buffer 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

impl PineappleBuffer<u32, Vec<u32>>

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

Open a new mask from a provided path

Arguments

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

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

pub fn new_from_dynamic( mask: DynamicImage, ) -> Result<PineappleMask, PineappleError>

Initialize a new mask from a DynamicImage

Arguments

• image - An 8 or 16-bit grayscale DynamicImage

Examples

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

let gray = GrayImage::new(10, 10);
let dynamic = DynamicImage::ImageLuma8(gray);
let image = PineappleMask::new_from_dynamic(dynamic);

pub fn new_from_numpy( npy: NpyFile<&[u8]>, ) -> Result<PineappleMask, 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::PineappleMask;

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

impl PineappleBuffer<u32, Vec<u32>>

pub fn label(&mut self) -> Vec<u32>

Re-label the mask using connected components and return unique labels

Notes

Re-labelling is guaranteed to assign the correct number of labels when assuming 8-connectivity. However, the labels are not guaranteed to be incremental (e.g. 1, 2, 3, ..). This should be taken into account when iterating over objects.

pub fn polygons(&mut self) -> Result<(Vec<u32>, Polygons), PineappleError>

Extract polygons from a segmentation mask

pub fn crop_binary( &self, x: u32, y: u32, w: u32, h: u32, label: u32, ) -> Result<PineappleMask, PineappleError>

Crops image while only including pixels with a specified label

Arguments

• x - Minimum x-coordinate (left)
• y - Minimum y-coordinate (bottom)
• w - Width of crop
• h - Height of crop
• label - Only include mask pixels equal to this label

Trait Implementations

impl<T: Clone, Container: Clone> Clone for PineappleBuffer<T, Container>

fn clone(&self) -> PineappleBuffer<T, Container>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Container: Debug> Debug for PineappleBuffer<T, Container>

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

Formats the value using the given formatter.