PineappleViewBuffer

Struct PineappleViewBuffer 

Source
pub struct PineappleViewBuffer<'a, T, Container> { /* private fields */ }
Expand description

A row-major buffer that defines an image view/crop/subregion

The cropped object represents a zero-copy reference to a larger PineappleBuffer. To enable zero-copy, the full image has to share the same lifetime as the cropped object. This should generally always be the case since we perform operations on cropped objects iteratively across all segmented objects from the same image.

§Examples

use pineapple_core::im::{PineappleBuffer, PineappleViewBuffer};

let width = 3;
let height = 3;
let channels = 1;
let data = vec![0, 1, 2, 3, 4, 5, 6, 7, 8];

let buffer = PineappleBuffer::<u8, Vec<u8>>::new(width, height, channels, data).unwrap();
let crop = PineappleViewBuffer::new(1, 1, 2, 2, &buffer);

for subpixel in crop.iter() {
    let _ = subpixel;
}

Implementations§

Source§

impl<'a> PineappleViewBuffer<'a, u32, Vec<u32>>

Source

pub fn save<P: AsRef<Path>>( &'a self, path: P, label: &u32, ) -> Result<(), PineappleError>

Save an object

§Arguments
  • path - A path to an image with a valid extension
use pineapple_core::im::PineappleImage;
let image = PineappleImage::open("image.png");
Source§

impl<'a, T, Container> PineappleViewBuffer<'a, T, Container>
where T: ToPrimitive + FromPrimitive, Container: Deref<Target = [T]>,

Source

pub fn new( x: u32, y: u32, w: u32, h: u32, buffer: &'a PineappleBuffer<T, Container>, ) -> Self

Initialize a copy-free object specifying a cropped/subregion of an image

§Examples
use pineapple_core::im::{PineappleBuffer, PineappleViewBuffer};

let width = 3;
let height = 3;
let channels = 1;
let data: Vec<u8> = vec![0, 1, 2, 3, 4, 5, 6, 7, 8];

let buffer = PineappleBuffer::<u8, Vec<u8>>::new(width, height, channels, data).unwrap();
let crop = PineappleViewBuffer::new(1, 1, 2, 2, &buffer);
Source§

impl<T, Container> PineappleViewBuffer<'_, T, Container>
where T: ToPrimitive + FromPrimitive, Container: Deref<Target = [T]>,

Source

pub fn len(&self) -> usize

Length of cropped buffer

Source

pub fn is_empty(&self) -> bool

Check if buffer is empty

Source

pub fn width(&self) -> usize

Width of object

Source

pub fn height(&self) -> usize

Height of object

Source

pub fn channels(&self) -> usize

Number of channels

Source§

impl<'a, T, Container> PineappleViewBuffer<'a, T, Container>
where T: ToPrimitive + FromPrimitive, Container: Deref<Target = [T]>,

Source

pub fn intensity(&'a self) -> [f32; 7]

Compute the intensity descriptors for the object

Source

pub fn moments(&'a self) -> [f32; 24]

Compute the image moments for the object

Source

pub fn texture(&'a self) -> [f32; 13]

Compute the texture descriptors for the object

Source

pub fn zernike(&'a self) -> [f32; 30]

Compute the zernike moments for the object

Source

pub fn descriptors(&'a self) -> Vec<f32>

Compute all view descriptors

Source§

impl<'a, T, Container> PineappleViewBuffer<'a, T, Container>
where T: ToPrimitive + FromPrimitive, Container: Deref<Target = [T]>,

Source

pub fn iter(&'a self) -> SubpixelIterator<'a, T, Container>

Return an iterator over pixels containing all channels

Source

pub fn iter_pixels(&'a self) -> PixelIterator<'a, T, Container>

Return an iterator over pixels containing all channels

Trait Implementations§

Source§

impl<'a, T: Clone, Container: Clone> Clone for PineappleViewBuffer<'a, T, Container>

Source§

fn clone(&self) -> PineappleViewBuffer<'a, T, Container>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<'a, T, Container> Freeze for PineappleViewBuffer<'a, T, Container>

§

impl<'a, T, Container> RefUnwindSafe for PineappleViewBuffer<'a, T, Container>
where Container: RefUnwindSafe, T: RefUnwindSafe,

§

impl<'a, T, Container> Send for PineappleViewBuffer<'a, T, Container>
where Container: Sync, T: Sync,

§

impl<'a, T, Container> Sync for PineappleViewBuffer<'a, T, Container>
where Container: Sync, T: Sync,

§

impl<'a, T, Container> Unpin for PineappleViewBuffer<'a, T, Container>

§

impl<'a, T, Container> UnwindSafe for PineappleViewBuffer<'a, T, Container>
where Container: RefUnwindSafe, T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V