locan.scripts.script_check.render_locs_per_frame_napari#

locan.scripts.script_check.render_locs_per_frame_napari(images, pixel_size, locdata, viewer=None, transpose=True, kwargs_image=None, kwargs_points=None)[source]#

Display original recording and overlay localization spots in napari.

Parameters:

  • images (Union[_SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[Union[bool, int, float, complex, str, bytes]]]) – Stack of raw data as recorded by camera.

  • pixel_size (float | tuple[float]) – Pixel size for images (in locdata units) with shape (2,).

  • transpose (bool) – If True transpose x and y axis of images.

  • locdata (LocData) – Localization data that corresponds to images raw data.

  • viewer (Viewer) – The viewer object on which to add the image

  • kwargs_image (Optional[dict[str, Any]]) – Other parameters passed to napari.Viewer().add_image().

  • kwargs_points (dict) – Other parameters passed to napari.Viewer().add_points().

Returns:

Viewer with the image.

Return type:

napari.Viewer