Struct IDWInterpolator 

pub struct IDWInterpolator { /* private fields */ }

Inverse Distance Weighting interpolator for scattered data

Examples

use scirs2_spatial::interpolate::IDWInterpolator;
use scirs2_core::ndarray::array;

// Create sample points and values
let points = array![
    [0.0, 0.0],
    [1.0, 0.0],
    [0.0, 1.0],
    [1.0, 1.0],
];
let values = array![0.0, 1.0, 2.0, 3.0];

// Create interpolator with power=2
let interp = IDWInterpolator::new(&points.view(), &values.view(), 2.0, None).expect("Operation failed");

// Interpolate at a point
let query_point = array![0.5, 0.5];
let result = interp.interpolate(&query_point.view()).expect("Operation failed");

// Should be close to 1.5
assert!((result - 1.5).abs() < 0.1);

Implementations

impl IDWInterpolator

pub fn new( points: &ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, values: &ArrayBase<ViewRepr<&f64>, Dim<[usize; 1]>>, power: f64, n_neighbors: Option<usize>, ) -> Result<IDWInterpolator, SpatialError>

Create a new IDW interpolator

Arguments

• points - Input points with shape (n_samples, n_dims)
• values - Input values with shape (n_samples,)
• power - Power parameter (p), controls the importance of nearby points
• n_neighbors - Number of neighbors to use (None = use all points)

Returns

A new IDWInterpolator

Errors

• If points and values have different lengths
• If power is negative
• If n_neighbors is 0 or greater than n_points

pub fn interpolate( &self, point: &ArrayBase<ViewRepr<&f64>, Dim<[usize; 1]>>, ) -> Result<f64, SpatialError>

Interpolate at a single point

Arguments

• point - Query point with shape (n_dims,)

Returns

Interpolated value at the query point

Errors

• If the point dimensions don’t match the interpolator

pub fn interpolate_many( &self, points: &ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ) -> Result<ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>, SpatialError>

Interpolate at multiple points

Arguments

• points - Query points with shape (n_queries, n_dims)

Returns

Interpolated values with shape (n_queries,)

Errors

• If the points dimensions don’t match the interpolator

pub fn power(&self) -> f64

Get the power parameter used by this interpolator

pub fn n_neighbors(&self) -> Option<usize>

Get the number of neighbors used by this interpolator

pub fn set_power(&mut self, power: f64) -> Result<(), SpatialError>

Set the power parameter

Arguments

• power - New power parameter

Errors

• If power is negative

pub fn set_n_neighbors( &mut self, _nneighbors: Option<usize>, ) -> Result<(), SpatialError>

Set the number of neighbors

Arguments

• n_neighbors - New number of neighbors (None = use all points)

Errors

• If n_neighbors is 0 or greater than n_points

Trait Implementations

impl Clone for IDWInterpolator

fn clone(&self) -> IDWInterpolator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IDWInterpolator

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

Formats the value using the given formatter.