Struct Image 

pub struct Image {
    pub width: u32,
    pub height: u32,
    pub depth: u32,
    pub bands: u32,
    pub data_type: DataType,
    pub valid_masks: Vec<BitMask>,
    pub data: SampleData,
    pub no_data_value: Option<f64>,
}

A decoded raster image with pixel data and validity masks.

Fields

width: u32

Image width in pixels.

height: u32

Image height in pixels.

depth: u32

Number of values per pixel (depth slices).

bands: u32

Number of bands in the image.

data_type: DataType

Pixel data type.

valid_masks: Vec<BitMask>

Per-band validity masks indicating which pixels are valid.

data: SampleData

Pixel sample data stored as a typed vector.

no_data_value: Option<f64>

The original NoData value, if any. When set during encoding with depth > 1, pixels matching this value in invalid depth slices are encoded with a sentinel. On decode, the sentinel is remapped back to this value.

Implementations

impl Image

pub fn as_typed<T: Sample>(&self) -> Option<&[T]>

Try to borrow the pixel data as &[T].

Returns None if the image’s data type does not match T.

pub fn mask(&self) -> Option<&BitMask>

Return the validity mask for the first band, or None if no masks are present.

pub fn pixel<T: Sample>(&self, row: u32, col: u32) -> Option<T>

Get the pixel value at (row, col) for single-band, single-depth images.

Returns None if the data type does not match T, if bands > 1 or depth > 1, or if the coordinates are out of bounds.

pub fn valid_pixels<'a, T: Sample + 'a>( &'a self, ) -> Option<impl Iterator<Item = (u32, u32, T)> + 'a>

Iterate over valid pixels as (row, col, value) tuples.

Only works for single-band, single-depth images. Returns None if the data type does not match T or if bands > 1 or depth > 1. The iterator respects the validity mask, skipping invalid pixels.

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

Get dimensions as (width, height).

pub fn num_pixels(&self) -> usize

Total number of pixels (width * height).

pub fn all_valid(&self) -> bool

Check if all pixels in the first band are valid.

Returns true if there is no mask (all pixels are implicitly valid), if the first band’s mask is BitMask::AllValid (O(1)), or if an explicit mask happens to have every bit set (O(n) popcount fallback).

pub fn from_pixels<T: Sample>( width: u32, height: u32, data: Vec<T>, ) -> Result<Self>

Create a single-band, all-valid Image from a typed pixel vector and dimensions.

Returns an error if data.len() != width * height.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for Image

fn default() -> Self

Returns the “default value” for a type.