Deprecate get_number_of_channels

CHANGELOG.md

@@ -7,6 +7,7 @@
 
 ### Deprecations
 * The 'channel' parameter in get_frames() and get_video() methods is deprecated and will be removed in August 2025.  [#388](https://github.com/catalystneuro/roiextractors/pull/388)
+* Removed get_num_channels from the ImagingExtractor abstract class. Implementations remain in concrete classes. [#392](https://github.com/catalystneuro/roiextractors/pull/392)
 
 ### Improvements
 * Use `pyproject.toml` for project metadata and installation requirements [#382](https://github.com/catalystneuro/roiextractors/pull/382)

src/roiextractors/extractors/memmapextractors/memmapextractors.py

@@ -110,6 +110,22 @@ def get_channel_names(self):
         pass
 
     def get_num_channels(self) -> int:
+        """Get the total number of active channels in the recording.
+
+        Returns
+        -------
+        num_channels: int
+            Integer count of number of channels.
+
+        Deprecated
+        ----------
+        This method will be removed in or after August 2025.
+        """
+        warn(
+            "get_num_channels() is deprecated and will be removed in or after August 2025.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return self._num_channels
 
     def get_dtype(self) -> DtypeType:

src/roiextractors/extractors/tiffimagingextractors/tiffimagingextractor.py

@@ -144,6 +144,22 @@ def get_sampling_frequency(self):
         return self._sampling_frequency
 
     def get_num_channels(self):
+        """Get the total number of active channels in the recording.
+
+        Returns
+        -------
+        num_channels: int
+            Integer count of number of channels.
+
+        Deprecated
+        ----------
+        This method will be removed in or after August 2025.
+        """
+        warn(
+            "get_num_channels() is deprecated and will be removed in or after August 2025.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return self._num_channels
 
     def get_channel_names(self):

src/roiextractors/imagingextractor.py

@@ -71,17 +71,6 @@ def get_channel_names(self) -> list:
         """
         pass
 
-    @abstractmethod
-    def get_num_channels(self) -> int:
-        """Get the total number of active channels in the recording.
-
-        Returns
-        -------
-        num_channels: int
-            Integer count of number of channels.
-        """
-        pass
-
     def get_dtype(self) -> DtypeType:
         """Get the data type of the video.
 
@@ -357,4 +346,20 @@ def get_channel_names(self) -> list:
         return self._parent_imaging.get_channel_names()
 
     def get_num_channels(self) -> int:
+        """Get the total number of active channels in the recording.
+
+        Returns
+        -------
+        num_channels: int
+            Integer count of number of channels.
+
+        Deprecated
+        ----------
+        This method will be removed in or after August 2025.
+        """
+        warnings.warn(
+            "get_num_channels() is deprecated and will be removed in or after August 2025.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return self._parent_imaging.get_num_channels()

src/roiextractors/multiimagingextractor.py

@@ -255,4 +255,20 @@ def get_channel_names(self) -> list:
         return self._imaging_extractors[0].get_channel_names()
 
     def get_num_channels(self) -> int:
+        """Get the total number of active channels in the recording.
+
+        Returns
+        -------
+        num_channels: int
+            Integer count of number of channels.
+
+        Deprecated
+        ----------
+        This method will be removed in or after August 2025.
+        """
+        warnings.warn(
+            "get_num_channels() is deprecated and will be removed in or after August 2025.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return self._imaging_extractors[0].get_num_channels()

src/roiextractors/volumetricimagingextractor.py

@@ -1,6 +1,7 @@
 """Base class definition for volumetric imaging extractors."""
 
 from typing import Tuple, List, Iterable, Optional
+import warnings
 import numpy as np
 
 from .extraction_tools import ArrayType, DtypeType
@@ -164,6 +165,22 @@ def get_channel_names(self) -> list:
         return self._imaging_extractors[0].get_channel_names()
 
     def get_num_channels(self) -> int:
+        """Get the total number of active channels in the recording.
+
+        Returns
+        -------
+        num_channels: int
+            Integer count of number of channels.
+
+        Deprecated
+        ----------
+        This method will be removed in or after August 2025.
+        """
+        warnings.warn(
+            "get_num_channels() is deprecated and will be removed in or after August 2025.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return self._imaging_extractors[0].get_num_channels()
 
     def get_dtype(self) -> DtypeType: