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 zarrBaseImaging— delegates tospikeinterface.core.loading.loadBaseRois— from binary folder (BinaryFolderRois)or zarr (
ZarrRois)
Functions
|
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) — forRoiAnalyzerformat(str) — forRoiAnalyzerbackend_options(dict) — forRoiAnalyzer/ zarrstorage_options(dict) — for zarr ROIsbase_folder— for SI extractor json/pkl files
- Returns:
A
RoiAnalyzer,BinaryFolderRois,ZarrRois, or a spikeinterfaceBaseExtractor(Recording/Sorting).- Return type:
object