locan.simulation.simulate_locdata.make_uniform#

locan.simulation.simulate_locdata.make_uniform(n_samples, region=(0, 1), seed=None)[source]#

Provide points that are distributed by a uniform (complete spatial randomness) point process within the boundaries given by region.

Parameters:

  • n_samples (int) – The total number of localizations of the point process

  • region (Union[Region, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[bool, int, float, complex, str, bytes]]]) – The region (or support) for all features. If array-like it must provide upper and lower bounds for each feature.

  • seed (Union[None, int, Sequence[int], SeedSequence, BitGenerator, Generator]) – Random number generation seed

Returns:

The generated samples of shape (n_samples, n_features).

Return type:

npt.NDArray[np.float64]