Skip to main content

BandExpression

Enum BandExpression 

Source
pub enum BandExpression {
Show 15 variants Band(usize), Constant(f32), Add(Box<BandExpression>, Box<BandExpression>), Sub(Box<BandExpression>, Box<BandExpression>), Mul(Box<BandExpression>, Box<BandExpression>), Div(Box<BandExpression>, Box<BandExpression>), Sqrt(Box<BandExpression>), Abs(Box<BandExpression>), Neg(Box<BandExpression>), Min(Box<BandExpression>, Box<BandExpression>), Max(Box<BandExpression>, Box<BandExpression>), Pow(Box<BandExpression>, Box<BandExpression>), Log(Box<BandExpression>), Exp(Box<BandExpression>), Clamp { value: Box<BandExpression>, lo: Box<BandExpression>, hi: Box<BandExpression>, },
}
Expand description

A composable expression tree for multi-band raster math.

Leaf nodes are either a Band index or a scalar Constant. Interior nodes are arithmetic operators.

Variants§

§

Band(usize)

Reference to band at the given index.

§

Constant(f32)

Scalar constant.

§

Add(Box<BandExpression>, Box<BandExpression>)

Addition: A + B

§

Sub(Box<BandExpression>, Box<BandExpression>)

Subtraction: A - B

§

Mul(Box<BandExpression>, Box<BandExpression>)

Multiplication: A * B

§

Div(Box<BandExpression>, Box<BandExpression>)

Division: A / B (errors on divide-by-zero)

§

Sqrt(Box<BandExpression>)

Square root: sqrt(max(0, A))

§

Abs(Box<BandExpression>)

Absolute value: |A|

§

Neg(Box<BandExpression>)

Negation: -A

§

Min(Box<BandExpression>, Box<BandExpression>)

Element-wise minimum: min(A, B)

§

Max(Box<BandExpression>, Box<BandExpression>)

Element-wise maximum: max(A, B)

§

Pow(Box<BandExpression>, Box<BandExpression>)

Power: A ^ B (uses pow(A, B) in WGSL).

§

Log(Box<BandExpression>)

Natural logarithm: ln(A).

§

Exp(Box<BandExpression>)

Exponential: exp(A).

§

Clamp

Clamp: clamp(A, lo, hi) — equivalent to min(max(A, lo), hi).

Implementations§

Source§

impl BandExpression

Source

pub fn evaluate(&self, bands: &[f32]) -> Result<f32, GpuError>

Evaluate the expression for one pixel given per-band values.

§Errors

Returns GpuError::InvalidKernelParams when a Band index is out of range or a Div node encounters a zero denominator.

Trait Implementations§

Source§

impl Clone for BandExpression

Source§

fn clone(&self) -> BandExpression

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BandExpression

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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