Skip to main content

NaturalNeighborInterpolator

Struct NaturalNeighborInterpolator 

Source
pub struct NaturalNeighborInterpolator { /* private fields */ }
Expand description

Natural Neighbor interpolator for scattered data

This interpolator uses the Sibson method to compute natural neighbor coordinates based on Voronoi diagrams and Delaunay triangulation.

§Examples

use scirs2_spatial::interpolate::NaturalNeighborInterpolator;
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
let interp = NaturalNeighborInterpolator::new(&points.view(), &values.view()).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 (average of the 4 corners)
assert!((result - 1.5).abs() < 1e-10);
// Note: This test is currently ignored due to implementation issues

Implementations§

Source§

impl NaturalNeighborInterpolator

Source

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

Create a new natural neighbor interpolator

§Arguments
  • points - Input points with shape (n_samples, n_dims)
  • values - Input values with shape (n_samples,)
§Returns

A new NaturalNeighborInterpolator

§Errors
  • If points and values have different lengths
  • If points are not 2D
  • If fewer than 3 points are provided
  • If the Delaunay triangulation fails
Source

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
  • If the point is outside the convex hull of the input points
Source

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

Trait Implementations§

Source§

impl Clone for NaturalNeighborInterpolator

Source§

fn clone(&self) -> NaturalNeighborInterpolator

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 NaturalNeighborInterpolator

Source§

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

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V