changelog

CHANGELOG.md

@@ -11,6 +11,7 @@
 ### Improvements
 * Removed unnecessary import checks for scipy, h5py, and zarr [PR #364](https://github.com/catalystneuro/roiextractors/pull/364)
 * Improved the error message for the `set_timestamps` method in the `ImagingExtractor` class[PR #377](https://github.com/catalystneuro/roiextractors/pull/377)
+* Renamed `MiniscopeImagingExtractor` to`MiniscopeMultiRecordingImagingExtractor` class[PR #374](https://github.com/catalystneuro/roiextractors/pull/374)
 
 ### Testing
 

src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py

@@ -10,6 +10,7 @@
 import re
 from pathlib import Path
 from typing import Optional, Tuple, List
+import warnings
 
 import numpy as np
 
@@ -49,7 +50,7 @@ class MiniscopeMultiRecordingImagingExtractor(MultiImagingExtractor):
     as a unified, continuous dataset.
     """
 
-    extractor_name = "MiniscopeMultiImaging"
+    extractor_name = "MiniscopeMultiRecordingImagingExtractor"
     is_writable = True
     mode = "folder"
 
@@ -90,7 +91,15 @@ def __init__(self, folder_path: PathType):
 
 
 # Temporary renaming to keep backwards compatibility
-MiniscopeImagingExtractor = MiniscopeMultiRecordingImagingExtractor
+class MiniscopeImagingExtractor(MiniscopeMultiRecordingImagingExtractor):
+    def __init__(self, *args, **kwargs):
+        warnings.warn(
+            "MiniscopeImagingExtractor is unstable and might change its signature. "
+            "Please use MiniscopeMultiRecordingImagingExtractor instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)
 
 
 class _MiniscopeSingleVideoExtractor(ImagingExtractor):