locan.simulation.simulate_drift.add_drift

locan.simulation.simulate_drift.add_drift(locdata, diffusion_constant=None, velocity=None, seed=None)[source]

Compute position deltas as function of frame number.

Parameters:

  • locdata (LocData) – Original localization data

  • diffusion_constant (tuple[float, ...] | None) – Diffusion constant for each dimension specifying the drift velocity with shape (point_dimension,). The diffusion constant has the unit of square of localization coordinate unit per frame unit.

  • velocity (tuple[float, ...] | None) – Drift velocity in units of localization coordinate unit per frame unit with shape (point_dimension,)

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

Returns:

A new LocData instance with localization data.

Return type:

LocData