locan.simulation.simulate_locdata.randomize#

locan.simulation.simulate_locdata.randomize(locdata, hull_region='bb', seed=None)[source]#

Transform locdata coordinates into randomized coordinates that follow complete spatial randomness on the same region as the input locdata.

Parameters:

locdata (LocData) – Localization data to be randomized
hull_region (Union[Region, Literal['bb', 'ch', 'as', 'obb']]) – Region of interest. String identifier can refer to the corresponding hull.
seed (Union[None, int, Sequence[int], SeedSequence, BitGenerator, Generator]) – random number generation seed

Returns:

New localization data with randomized coordinates.

Return type:

LocData