Skip to main content

RasterCalculator

Struct RasterCalculator 

Source
pub struct RasterCalculator;
Expand description

Raster calculator for map algebra with expression parsing

Implementations§

Source§

impl RasterCalculator

Source

pub fn evaluate_bytecode( expr_str: &str, bands: &[RasterBuffer], ) -> Result<RasterBuffer>

Evaluate a band-math expression using the bytecode VM.

Parsing and compilation happen once; the resulting CompiledProgram is then executed for every pixel with a pair of pre-allocated scratch buffers (cache and stack) so no heap allocations occur inside the pixel loop.

This method is functionally equivalent to RasterCalculator::evaluate but can be 2–5× faster on large rasters because it avoids AST tree traversal per pixel.

§Arguments
  • expr_str – The expression string (e.g. "(B1 - B2) / (B1 + B2)").
  • bands – Input RasterBuffer slices; B1 = bands[0], B2 = bands[1], …
§Errors

Returns an AlgorithmError if:

Source§

impl RasterCalculator

Source

pub fn evaluate( expression: &str, bands: &[RasterBuffer], ) -> Result<RasterBuffer>

Evaluates a raster expression on one or more bands

§Arguments
  • expression - The expression to evaluate (e.g., “(B1 - B2) / (B1 + B2)”)
  • bands - Input bands (B1, B2, etc.)
§Examples

NDVI: "(B1 - B2) / (B1 + B2)" Conditional: "if B1 > 100 then B1 * 2 else B1" Math: "sqrt(B1 ^ 2 + B2 ^ 2)"

§Errors

Returns an error if the expression is invalid or evaluation fails

Source

pub fn evaluate_parallel( expression: &str, bands: &[RasterBuffer], ) -> Result<RasterBuffer>

Evaluates a raster expression in parallel using rayon

This method processes rows in parallel for improved performance on multi-core systems. Falls back to sequential evaluation if the parallel feature is not enabled.

§Arguments
  • expression - The expression to evaluate (e.g., “(B1 - B2) / (B1 + B2)”)
  • bands - Input bands (B1, B2, etc.)
§Examples

NDVI: "(B1 - B2) / (B1 + B2)" Conditional: "if B1 > 100 then B1 * 2 else B1" Math: "sqrt(B1 ^ 2 + B2 ^ 2)"

§Errors

Returns an error if the expression is invalid or evaluation fails

Source

pub fn apply_binary( a: &RasterBuffer, b: &RasterBuffer, op: RasterExpression, ) -> Result<RasterBuffer>

Applies a binary operation to two rasters (legacy API)

Source

pub fn apply_unary<F>(src: &RasterBuffer, func: F) -> Result<RasterBuffer>
where F: Fn(f64) -> f64,

Applies a unary function to a raster (legacy API)

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more