SphericalVoronoi

Struct SphericalVoronoi 

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

SphericalVoronoi calculates a Voronoi diagram on the surface of a sphere.

§Examples

// Create points on a sphere (these should be normalized)
// Using points that avoid degenerate simplices
let angles = [(0.5_f64, 0.0_f64), (0.5_f64, 1.0_f64), (1.0_f64, 0.5_f64),
             (1.5_f64, 1.0_f64), (0.8_f64, 1.5_f64)];
let mut points = Vec::new();
for &(phi, theta) in angles.iter() {
    let x = phi.sin() * theta.cos();
    let y = phi.sin() * theta.sin();
    let z = phi.cos();
    points.push([x, y, z]);
}
let points = ndarray::arr2(&points);

// Create a SphericalVoronoi diagram
let radius = 1.0;
let center = array![0.0, 0.0, 0.0];
let sv = SphericalVoronoi::new(&points.view(), radius, Some(&center), None)?;

// Access the Voronoi regions
let regions = sv.regions();
println!("Number of regions: {}", regions.len());

// Access the Voronoi vertices
let vertices = sv.vertices();
println!("Number of vertices: {}", vertices.nrows());

Implementations§

Source§

impl SphericalVoronoi

Source

pub fn new( points: &ArrayView2<'_, f64>, radius: f64, center: Option<&Array1<f64>>, threshold: Option<f64>, ) -> SpatialResult<Self>

Creates a new SphericalVoronoi diagram from points on a sphere.

§Arguments
  • points - Coordinates of points from which to construct the diagram. These points should be on the surface of the sphere.
  • radius - Radius of the sphere.
  • center - Center of the sphere. If None, the origin will be used.
  • threshold - Threshold for detecting duplicate points and mismatches between points and sphere parameters. If None, 1e-6 is used.
§Returns

Returns a Result containing the SphericalVoronoi object if successful, or an error if the input is invalid.

Source

pub fn points(&self) -> &Array2<f64>

Returns the input points.

Source

pub fn vertices(&self) -> &Array2<f64>

Returns the Voronoi vertices.

Source

pub fn regions(&self) -> &Vec<Vec<usize>>

Returns the Voronoi regions as lists of vertex indices.

Source

pub fn radius(&self) -> f64

Returns the radius of the sphere.

Source

pub fn center(&self) -> &Array1<f64>

Returns the center of the sphere.

Source

pub fn simplices(&self) -> &[Vec<usize>]

Returns the Delaunay simplices (triangulations on the sphere).

Source

pub fn circumcenters(&self) -> &Array2<f64>

Returns the circumcenters of the Delaunay triangulations.

Source

pub fn sort_vertices_of_regions(&mut self) -> SpatialResult<()>

Sorts the vertices of each Voronoi region in a counterclockwise order. This is useful for visualization purposes.

Source

pub fn calculate_areas(&mut self) -> SpatialResult<&[f64]>

Calculates the areas of the Voronoi regions.

For 3D point sets, the sum of all areas will be 4π * radius².

Source

pub fn areas(&mut self) -> SpatialResult<&[f64]>

Returns pre-calculated areas of Voronoi regions, or calculates them if not already available.

Source

pub fn geodesic_distance( &self, point1: &ArrayView1<'_, f64>, point2: &ArrayView1<'_, f64>, ) -> SpatialResult<f64>

Calculate the geodesic distance between two points on the sphere.

§Arguments
  • point1 - First point on the sphere
  • point2 - Second point on the sphere
§Returns

The geodesic distance (great-circle distance) between the two points

Source

pub fn geodesic_distances_to_generators( &self, point: &ArrayView1<'_, f64>, ) -> SpatialResult<Vec<f64>>

Calculate geodesic distances from a point to all generators.

§Arguments
  • point - Query point on the sphere
§Returns

A vector of distances from the query point to all generator points

Source

pub fn nearest_generator( &self, point: &ArrayView1<'_, f64>, ) -> SpatialResult<(usize, f64)>

Find the nearest generator point to a query point.

§Arguments
  • point - Query point on the sphere
§Returns

The index of the nearest generator point and its geodesic distance

Trait Implementations§

Source§

impl Debug for SphericalVoronoi

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<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> 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, 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