locan.simulation.simulate_locdata.simulate_tracks

locan.simulation.simulate_locdata.simulate_tracks(n_walks=1, n_steps=10, ranges=((0, 10000), (0, 10000)), diffusion_constant=1, time_step=10, seed=None)[source]

Provide a dataset of localizations representing random walks with starting points being spatially-distributed on a rectangular shape or cubic volume by complete spatial randomness.

Parameters:

  • n_walks (int) – Number of walks

  • n_steps (int) – Number of time steps (i.e. frames)

  • ranges (tuple[tuple[int, int], tuple[int, int]]) – the range for valid x[, y, z]-coordinates

  • diffusion_constant (int | float) – Diffusion constant with unit length per seconds^2

  • time_step (float) – Time per frame (or simulation step) in seconds.

  • seed (None | int | Sequence[int] | SeedSequence | BitGenerator | Generator) – random number generation seed

Returns:

A new LocData instance with localization data.

Return type:

LocData