Struct RasterBuffer 

pub struct RasterBuffer { /* private fields */ }

A typed buffer for raster data

Implementations

impl RasterBuffer

pub fn new( data: Vec<u8>, width: u64, height: u64, data_type: RasterDataType, nodata: NoDataValue, ) -> Result<Self>

Creates a new raster buffer

Errors

Returns an error if the data size doesn’t match the dimensions and type

pub fn zeros(width: u64, height: u64, data_type: RasterDataType) -> Self

Creates a zero-filled buffer

pub fn nodata_filled( width: u64, height: u64, data_type: RasterDataType, nodata: NoDataValue, ) -> Self

Creates a buffer filled with the nodata value

pub fn fill_value(&mut self, value: f64)

Fills the buffer with a constant value

pub const fn width(&self) -> u64

Returns the width in pixels

pub const fn height(&self) -> u64

Returns the height in pixels

pub const fn data_type(&self) -> RasterDataType

Returns the data type

pub const fn nodata(&self) -> NoDataValue

Returns the nodata value

pub const fn pixel_count(&self) -> u64

Returns the total number of pixels

pub fn as_bytes(&self) -> &[u8]

Returns the raw bytes

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Returns mutable raw bytes

pub fn into_bytes(self) -> Vec<u8>

Consumes the buffer and returns the raw bytes

pub fn from_typed_vec<T: Copy + 'static>( width: usize, height: usize, data: Vec<T>, data_type: RasterDataType, ) -> Result<Self>

Creates a buffer from typed vector data

Arguments

• width - Width in pixels
• height - Height in pixels
• data - Typed data (e.g., Vec<f32>, Vec<u8>)
• data_type - The raster data type

Errors

Returns an error if the data size doesn’t match dimensions and type

pub fn as_slice<T: Copy + 'static>(&self) -> Result<&[T]>

Returns the buffer data as a typed slice

Type Parameters

• T - The target type (must match the buffer’s data type size)

Errors

Returns an error if the type size doesn’t match the data type

pub fn as_slice_mut<T: Copy + 'static>(&mut self) -> Result<&mut [T]>

Returns the buffer data as a mutable typed slice

Type Parameters

• T - The target type (must match the buffer’s data type size)

Errors

Returns an error if the type size doesn’t match the data type

pub fn get_pixel(&self, x: u64, y: u64) -> Result<f64>

Gets a pixel value as f64

Errors

Returns an error if coordinates are out of bounds

pub fn set_pixel(&mut self, x: u64, y: u64, value: f64) -> Result<()>

Sets a pixel value

Errors

Returns an error if coordinates are out of bounds

pub fn get_u8(&self, x: u64, y: u64) -> Result<u8>

Gets a pixel value as u8.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not UInt8.

pub fn get_i8(&self, x: u64, y: u64) -> Result<i8>

Gets a pixel value as i8.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Int8.

pub fn get_u16(&self, x: u64, y: u64) -> Result<u16>

Gets a pixel value as u16.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not UInt16.

pub fn get_i16(&self, x: u64, y: u64) -> Result<i16>

Gets a pixel value as i16.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Int16.

pub fn get_u32(&self, x: u64, y: u64) -> Result<u32>

Gets a pixel value as u32.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not UInt32.

pub fn get_i32(&self, x: u64, y: u64) -> Result<i32>

Gets a pixel value as i32.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Int32.

pub fn get_u64(&self, x: u64, y: u64) -> Result<u64>

Gets a pixel value as u64.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not UInt64.

pub fn get_i64(&self, x: u64, y: u64) -> Result<i64>

Gets a pixel value as i64.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Int64.

pub fn get_f32(&self, x: u64, y: u64) -> Result<f32>

Gets a pixel value as f32.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Float32.

pub fn get_f64(&self, x: u64, y: u64) -> Result<f64>

Gets a pixel value as f64.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Float64.

pub fn set_u8(&mut self, x: u64, y: u64, value: u8) -> Result<()>

Sets a pixel value from u8.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not UInt8.

pub fn set_f32(&mut self, x: u64, y: u64, value: f32) -> Result<()>

Sets a pixel value from f32.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Float32.

pub fn set_f64(&mut self, x: u64, y: u64, value: f64) -> Result<()>

Sets a pixel value from f64.

Errors

Returns an error if coordinates are out of bounds or the buffer type is not Float64.

pub fn row_slice<T: Copy + 'static>(&self, y: u64) -> Result<&[T]>

Returns a row of pixel data as a typed slice.

Errors

Returns an error if y is out of bounds or type size mismatches.

pub fn window(&self, x: u64, y: u64, width: u64, height: u64) -> Result<Self>

Returns a rectangular window of pixel data as a new RasterBuffer.

Errors

Returns an error if the window extends outside buffer bounds.

pub fn is_nodata(&self, value: f64) -> bool

Returns true if the given value equals the nodata value

pub fn convert_to(&self, target_type: RasterDataType) -> Result<Self>

Converts the buffer to a different data type

Errors

Returns an error if conversion fails

pub fn compute_statistics(&self) -> Result<BufferStatistics>

Computes basic statistics

pub fn compute_statistics_with_histogram( &self, bin_count: usize, ) -> Result<BufferStatistics>

Computes statistics and an optional histogram in one pass.

The returned BufferStatistics contains a histogram of bin_count bins with uniform spacing covering the range [min, max]. Each bin holds the count of valid pixels whose value falls within that bin’s interval.

Arguments

• bin_count — Number of histogram bins. Must be ≥ 1.

Errors

Returns crate::error::OxiGdalError::InvalidParameter if bin_count is 0. Returns errors from pixel access on corrupt buffers.

Notes

• NaN and infinite values are excluded (same as RasterBuffer::compute_statistics).
• When all valid values are identical (min == max), all counts go into bin 0.
• When no valid pixels exist, histogram is Some(vec![0; bin_count]).

Trait Implementations

impl Clone for RasterBuffer

fn clone(&self) -> RasterBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RasterBuffer

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

Formats the value using the given formatter.