neuralib.rastermap.run.run_rastermap

neuralib.rastermap.run.run_rastermap(neural_activity, bin_size, dtype, *, options=None, svd_components=128, svd_cache=None, invalid_svd_cache=False, filename=None, save_path=None, **kwargs)[source]

Run rastermap

Parameters:

  • neural_activity (ndarray) – neural activity. Array[float, [N, T]] | Array[Any, [T, H, W]]

  • bin_size (int) – number of neurons to bin over

  • dtype (Literal['cellular', 'wfield']) – DATA_TYPE

  • options (RasterOptions | None) – RasterOptions

  • svd_components (int) – number of SVD components to use (for widefield dtype)

  • svd_cache (str | Path | PathLike[str] | None) – path to cache SVD file (for widefield dtype)

  • invalid_svd_cache (bool) – invalid (recompute) SVD cached file (for widefield dtype)

  • filename (str | None) – optional specify if GUI re-launch

  • save_path (str | None) – optional specify if GUI re-launch

Return type:

RasterMapResult