From c194d02126f34fc12356e40bdc1ca3a76af774fb Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Tue, 22 Oct 2024 16:06:07 -0600 Subject: [PATCH] changelog --- CHANGELOG.md | 1 + .../miniscopeimagingextractor.py | 13 +++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 45395e4a..e53e78c5 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py b/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py index a06091bc..a8b4f459 100644 --- a/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py +++ b/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):