Skip to main content
`Ctrl`+`K`

# scipy.stats.qmc.PoissonDisk

class scipy.stats.qmc.PoissonDisk(d, *, radius=0.05, hypersphere='volume', ncandidates=30, optimization=None, seed=None)

  Poisson disk sampling.

  Parameters:
    d int

      Dimension of the parameter space.

    radius float

      Minimal distance to keep between points when sampling new candidates.

    hypersphere{“volume”, “surface”}, optional

      Sampling strategy to generate potential candidates to be added in the final sample. Default is “volume”.

      - `volume`: original Bridson algorithm as described in [1]. New candidates are sampled within the hypersphere.

      - `surface`: only sample the surface of the hypersphere.

    ncandidates int

      Number of candidates to sample per iteration. More candidates result in a denser sampling as more candidates can be accepted per iteration.

    optimization{None, “random-cd”, “lloyd”}, optional

      Whether to use an optimization scheme to improve the quality after sampling. Note that this is a post-processing step that does not guarantee that all properties of the sample will be conserved. Default is None.

      - `random-cd`: random permutations of coordinates to lower the centered discrepancy. The best sample based on the centered discrepancy is constantly updated. Centered discrepancy-based sampling shows better space-filling robustness toward 2D and 3D subprojections compared to using other discrepancy measures.

      - `lloyd`: Perturb samples using a modified Lloyd-Max algorithm. The process converges to equally spaced samples.

      New in version 1.10.0.

    seed{None, int, `numpy.random.Generator`}, optional

      If seed is an int or None, a new `numpy.random.Generator` is created using `np.random.default_rng(seed)`. If seed is already a `Generator` instance, then the provided instance is used.

  Notes

  Poisson disk sampling is an iterative sampling strategy. Starting from a seed sample, ncandidates are sampled in the hypersphere surrounding the seed. Candidates below a certain radius or outside the domain are rejected. New samples are added in a pool of sample seed. The process stops when the pool is empty or when the number of required samples is reached.

  The maximum number of point that a sample can contain is directly linked to the radius. As the dimension of the space increases, a higher radius spreads the points further and help overcome the curse of dimensionality. See the quasi monte carlo tutorial for more details.

  Warning

  The algorithm is more suitable for low dimensions and sampling size due to its iterative nature and memory requirements. Selecting a small radius with a high dimension would mean that the space could contain more samples than using lower dimension or a bigger radius.

  Some code taken from [2], written consent given on 31.03.2021 by the original author, Shamis, for free use in SciPy under the 3-clause BSD.

  References

  [1]

  Robert Bridson, “Fast Poisson Disk Sampling in Arbitrary Dimensions.” SIGGRAPH, 2007.

  [2]

  StackOverflow.

  Examples

  Generate a 2D sample using a radius of 0.2.

      >>> import numpy as np
      >>> import matplotlib.pyplot as plt
      >>> from matplotlib.collections import PatchCollection
      >>> from scipy.stats import qmc
      >>>
      >>> rng = np.random.default_rng()
      >>> radius = 0.2
      >>> engine = qmc.PoissonDisk(d=2, radius=radius, seed=rng)
      >>> sample = engine.random(20)

  Visualizing the 2D sample and showing that no points are closer than radius. `radius/2` is used to visualize non-intersecting circles. If two samples are exactly at radius from each other, then their circle of radius `radius/2` will touch.

      >>> fig, ax = plt.subplots()
      >>> _ = ax.scatter(sample[:, 0], sample[:, 1])
      >>> circles = [plt.Circle((xi, yi), radius=radius/2, fill=False)
      ...            for xi, yi in sample]
      >>> collection = PatchCollection(circles, match_original=True)
      >>> ax.add_collection(collection)
      >>> _ = ax.set(aspect='equal', xlabel=r'$x_1$', ylabel=r'$x_2$',
      ...            xlim=[0, 1], ylim=[0, 1])
      >>> plt.show()

  Such visualization can be seen as circle packing: how many circle can we put in the space. It is a np-hard problem. The method `fill_space` can be used to add samples until no more samples can be added. This is a hard problem and parameters may need to be adjusted manually. Beware of the dimension: as the dimensionality increases, the number of samples required to fill the space increases exponentially (curse-of-dimensionality).

  Methods

  `fast_forward`(n) | Fast-forward the sequence by n positions.
  `fill_space`() | Draw `n` samples in the interval `[0, 1]`.
  `integers`(l_bounds, *[, u_bounds, n, ...]) | Draw n integers from l_bounds (inclusive) to u_bounds (exclusive), or if endpoint=True, l_bounds (inclusive) to u_bounds (inclusive).
  `random`([n, workers]) | Draw n in the half-open interval `[0, 1)`.
  `reset`() | Reset the engine to base state.