Struct BandSetView 

pub struct BandSetView<'a, T>
where
    T: Sample,
{ /* private fields */ }

Borrowed, dimension-checked view of a multi-band raster.

Implementations

impl<'a, T> BandSetView<'a, T>

where T: Sample,

pub fn new( width: u32, height: u32, depth: u32, band_count: usize, layout: BandLayout, data: &'a [T], ) -> Result<BandSetView<'a, T>, Error>

Creates a band-set view over interleaved or band-sequential samples.

Errors

Returns an error for zero bands or depth, overflowing dimensions, or a sample slice whose length does not match the declared shape.

pub fn width(self) -> u32

Returns the raster width in pixels.

pub fn height(self) -> u32

Returns the raster height in pixels.

pub fn depth(self) -> u32

Returns the number of samples per pixel in each band.

pub fn band_count(self) -> usize

Returns the number of bands.

pub fn layout(self) -> BandLayout

Returns the memory layout of the supplied samples.

pub fn data(self) -> &'a [T]

Returns the underlying sample slice.

pub fn data_type(self) -> DataType

Returns the encoded sample type.

pub fn pixel_count(self) -> Result<usize, Error>

Returns the checked pixel count cached at construction.

pub fn band_sample_count(self) -> Result<usize, Error>

Returns the sample count of one band.

pub fn value_count(self) -> Result<usize, Error>

Returns the total number of samples across every band.

pub fn sample(self, band: usize, pixel: usize, dim: usize) -> T

Returns one sample by band, flat pixel, and depth index.

Panics

Panics if any supplied index is outside this view.

Trait Implementations

impl<'a, T> Clone for BandSetView<'a, T>

where T: Clone + Sample,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T> Copy for BandSetView<'a, T>

where T: Copy + Sample,

impl<'a, T> Debug for BandSetView<'a, T>

where T: Debug + Sample,

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

Formats the value using the given formatter.

impl<'a, T> PartialEq for BandSetView<'a, T>

where T: PartialEq + Sample,

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

Equality operator ==.

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

Inequality operator !=.

impl<'a, T> StructuralPartialEq for BandSetView<'a, T>

where T: PartialEq + Sample,