smlmlp.simulation module

smlmlp.simulation(**kwargs)

Simulate SMLM data.

Parameters:

**kwargs –

Simulation parameters including: - nframes : int

Number of frames to simulate.

• nlocalizationsint

  Number of unique localizations.

• photonsarray-like

  Photon counts per localization.

• x_nm, y_nmarray-like

  X/Y positions in nanometers.

• z_nmarray-like, optional

  Z positions in nanometers.

• frame_nmarray-like

  Frame numbers.

• channelsarray-like, optional

  Channel assignments.

Returns:

Simulated localization data.

Return type:

Locs

Raises:

SyntaxError – Always raised until the simulator is implemented.

Examples

>>> from smlmlp import simulation
>>> simulation()
Traceback (most recent call last):
    ...
SyntaxError: Not implemented yet.