faster_poisson 1.3.0

Fast Poisson disk sampling
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

[![Crates.io](https://img.shields.io/crates/v/faster_poisson.svg)](https://crates.io/crates/faster_poisson)
[![Docs](https://docs.rs/faster_poisson/badge.svg)](https://docs.rs/faster_poisson/)
[![CI](https://github.com/nubDotDev/faster-poisson-disk-sampling/actions/workflows/rust.yml/badge.svg)](https://github.com/nubDotDev/faster-poisson-disk-sampling/actions/workflows/rust.yml)

# faster_poisson

This is a library that implements various methods of Poisson disk sampling.

Each method returns a set of points where no two are less than a fixed distance from each other.

## Usage

The easiest way to use this library is with the [`Poisson2D`], [`Poisson3D`], and [`PoissonND`] types.
You can generate points all at once with the `run` method, or lazily with the `iter` method.
To change parameters like the grid dimensions or minimum distance, [`Poisson`] uses a fluent interface pattern.

```rust
use faster_poisson::{Poisson2D, Poisson3D, PoissonND};

// Sample points from a 6 x 4 grid with minimum distance 0.5.
let poisson_2d = Poisson2D::new().dims([6.0, 4.0]).radius(0.5);
let samples_2d = poisson_2d.run();

// The default side length of the grid is 1.0 and the default radius is 0.1.
let poisson_3d = Poisson3D::new();
let samples_3d = poisson_3d.run();

// For dimensions higher than 3, use PoissonND.
let poisson_4d = PoissonND::<4>::new();
// Points are generated lazily, so this is fast.
let samples_4d_100: Vec<[f64; 4]> = poisson_4d.iter().take(100).collect();
```

For smaller 2D grids (< 1,000,000 points) it is probably faster to use [`PoissonDart2D`].

## Features

- `gpu`

  Use the [wgpu](https://docs.rs/wgpu/latest/wgpu/) crate to perform Poisson disk sampling on the GPU with [`pixelpie::PoissonPixelPie`].

- `plotly`

  Use the [plotly](https://docs.rs/plotly/latest/plotly/) crate to plot distributions with [`plot::plot_2d`] and [`plot::plot_3d`].

- `fourier`

  Use the [rustfft](https://docs.rs/rustfft/latest/rustfft/) crate to generate 2D periodograms of distributions with [`fourier::fourier`].

    <img src="https://raw.githubusercontent.com/nubDotDev/faster-poisson-disk-sampling/refs/heads/main/assets/parental_fourier.png" width=250 style="border: 2px solid white;"/>

- `stipple`

  Stipple images with [`stipple::stipple_image_luma`] and [`stipple::stipple_image_rgb`].

    <img src="https://raw.githubusercontent.com/nubDotDev/faster-poisson-disk-sampling/refs/heads/main/assets/cat.png" width=300 style="border: 2px solid white;"/>
    <img src="https://raw.githubusercontent.com/nubDotDev/faster-poisson-disk-sampling/refs/heads/main/assets/cat_stipple_luma.png" width=300 style="border: 2px solid white;"/>
    <img src="https://raw.githubusercontent.com/nubDotDev/faster-poisson-disk-sampling/refs/heads/main/assets/cat_stipple_rgb.png" width=300 style="border: 2px solid white;"/>