insitupy.InSituExperiment.read

insitupy.InSituExperiment.read#

classmethod InSituExperiment.read(path, mode='insitupy', filter_key=None)#

Read an InSituExperiment object from a specified folder.

Parameters:
  • path (Union[str, PathLike, Path]) – Path to the experiment directory or SpatialData zarr store

  • mode (Literal['insitupy', 'spatialdata'] (default: 'insitupy')) – Read mode - either “insitupy” (default) or “spatialdata” Note: “spatialdata” mode is currently disabled and will be enabled in a future release.

Return type:

InSituExperiment

Returns:

InSituExperiment object in the specified mode