photon_mosaic.core.loading#

General-purpose load function for photon-mosaic objects.

Inspired by spikeinterface.core.loading.load, this module provides a single load entry-point that auto-detects the object type and format.

Loadable objects#

  • RoiAnalyzer — from binary folder or zarr

  • BaseImaging — delegates to spikeinterface.core.loading.load

  • BaseRois — from binary folder (BinaryFolderRois)

    or zarr (ZarrRois)

Functions

load(file_or_folder, **kwargs)

Load a photon-mosaic (or spikeinterface) object from disk.

photon_mosaic.core.loading.load(file_or_folder, **kwargs)[source]#

Load a photon-mosaic (or spikeinterface) object from disk.

Parameters:
  • file_or_folder (str or Path) – Path to a folder or file.

  • **kwargs –

    Forwarded to the specific loader. Recognised keys include:

    • load_extensions (bool) — for RoiAnalyzer

    • format (str) — for RoiAnalyzer

    • backend_options (dict) — for RoiAnalyzer / zarr

    • storage_options (dict) — for zarr ROIs

    • base_folder — for SI extractor json/pkl files

Returns:

A RoiAnalyzer, BinaryFolderRois, ZarrRois, or a spikeinterface BaseExtractor (Recording/Sorting).

Return type:

object