From daf62dc54681d5a09017b72638bfcdb5cc38b9f1 Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Wed, 9 Oct 2024 16:37:06 -0600 Subject: [PATCH] rename legacy extractor --- .../miniscopeimagingextractor/__init__.py | 2 +- .../miniscopeimagingextractor.py | 24 +++++++++++-------- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py b/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py index 9cf2517c..2e72250a 100644 --- a/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py +++ b/src/roiextractors/extractors/miniscopeimagingextractor/__init__.py @@ -11,4 +11,4 @@ An ImagingExtractor for the Miniscope video (.avi) format. """ -from .miniscopeimagingextractor import MiniscopeImagingExtractor +from .miniscopeimagingextractor import MiniscopeImagingExtractor, MiniscopeMultiSegmentExtractor diff --git a/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py b/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py index e619f8b2..9e482dc0 100644 --- a/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py +++ b/src/roiextractors/extractors/miniscopeimagingextractor/miniscopeimagingextractor.py @@ -18,14 +18,14 @@ from ...extraction_tools import PathType, DtypeType, get_package -class MiniscopeImagingExtractor(MultiImagingExtractor): # TODO: rename to MiniscopeMultiImagingExtractor +class MiniscopeMultiSegmentExtractor(MultiImagingExtractor): """An ImagingExtractor for the Miniscope video (.avi) format. This format consists of video (.avi) file(s) and configuration files (.json). - One _MiniscopeImagingExtractor is created for each video file and then combined into the MiniscopeImagingExtractor. + One _MiniscopeSingleVideoExtractor is created for each video file and then combined into the MiniscopeImagingExtractor. """ - extractor_name = "MiniscopeImaging" + extractor_name = "MiniscopeMultiImaging" is_writable = True mode = "folder" @@ -58,24 +58,28 @@ def __init__(self, folder_path: PathType): imaging_extractors = [] for file_path in miniscope_avi_file_paths: - extractor = _MiniscopeImagingExtractor(file_path=file_path) + extractor = _MiniscopeSingleVideoExtractor(file_path=file_path) extractor._sampling_frequency = self._sampling_frequency imaging_extractors.append(extractor) super().__init__(imaging_extractors=imaging_extractors) -class _MiniscopeImagingExtractor(ImagingExtractor): - """An ImagingExtractor for the Miniscope video (.avi) format. +# Temporal renaming to keep backwards compatibility +MiniscopeImagingExtractor = MiniscopeMultiSegmentExtractor + + +class _MiniscopeSingleVideoExtractor(ImagingExtractor): + """An auxiliar extractor to get data from a single Miniscope video (.avi) file. - This format consists of a single video (.avi) file and configuration file (.json). - Multiple _MiniscopeImagingExtractor are combined into the MiniscopeImagingExtractor for public access. + This format consists of a single video (.avi) + Multiple _MiniscopeSingleVideoExtractor are combined into the MiniscopeImagingExtractor for public access. """ - extractor_name = "_MiniscopeImaging" + extractor_name = "_MiniscopeSingleVideo" def __init__(self, file_path: PathType): - """Create a _MiniscopeImagingExtractor instance from a file path. + """Create a _MiniscopeSingleVideoExtractor instance from a file path. Parameters ----------