locan.simulation.simulate_locdata.simulate_uniform¶

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

Provide points that are distributed by a uniform Poisson point process within the boundaries given by region.

Parameters:

n_samples (int) – The total number of localizations of the point process
region (Union[Region, _Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[bool | int | float | complex | str | bytes]]) – The region (or support) for each feature. If array-like it must provide upper and lower bounds for each feature.
seed (None | int | Sequence[int] | SeedSequence | BitGenerator | Generator) – random number generation seed

Returns:

The generated samples.

Return type:

LocData