Merge pull request #4008 from h-mayorquin/allow_white_matter_gain

Allow white matter recording to pass gain_to_uV

Author: alejoe91

src/spikeinterface/extractors/matlabhelpers.py

@@ -19,7 +19,6 @@
 
 
 class MatlabHelper:
-    mode = "file"
     installation_mesg = (
         "To use the MATSortingExtractor install h5py and scipy: " "\n\n pip install h5py scipy\n\n"
     )  # error message when not installed

src/spikeinterface/extractors/neoextractors/alphaomega.py

@@ -77,7 +77,6 @@ class AlphaOmegaEventExtractor(NeoBaseEventExtractor):
         The folder path to the AlphaOmega events.
     """
 
-    mode = "folder"
     NeoRawIOClass = "AlphaOmegaRawIO"
     handle_event_frame_directly = True
 

src/spikeinterface/extractors/whitematterrecordingextractor.py

@@ -24,13 +24,31 @@ class WhiteMatterRecordingExtractor(BinaryRecordingExtractor):
         A list of channel ids. If None, channel_ids = list(range(num_channels)).
     is_filtered : bool or None, default: None
         If True, the recording is assumed to be filtered. If None, `is_filtered` is not set.
-    """
+    gain_to_uV : float | None, default: 0.190734863
+        Micro-volt conversion factor (ADC count → µV).
+
+        Where to look
+        -------------
+        • **Head-stage files** (64 neural chan.):
+            *settingsHeadstages.xml* →
+            `<CHANNEL … voltsperbit="1.907348633e-7" />`
+            → 0.190 734 863 µV per count.
+
+        • **Analog-panel files** (32 aux chan., ±10 V range in our example):
+            *settingsAnalogPanel.xml* →
+            `<CHANNEL … voltsperbit="3.0517578125e-4" />`
+            → 305.175 781 µV per count.
 
-    mode = "file"
+        Use the value from the corresponding XML file when loading data.
+        If *gain_to_uV* is left as *None* the extractor assumes the
+        head-stage constant (0.190734863 µV/bit).  Different hardware
+        ranges will have different *voltsperbit* numbers, so always double-check
+        for your specific setup.
+    """
 
     # Specific parameters for WhiteMatter format
     DTYPE = "int16"
-    GAIN_TO_UV = 6.25e3 / 32768
+    HEADSTAGE_GAIN_TO_UV = 0.190734863
     OFFSET_TO_UV = 0.0
     FILE_OFFSET = 8
     TIME_AXIS = 0
@@ -45,15 +63,19 @@ def __init__(
         num_channels: int,
         channel_ids: Optional[List] = None,
         is_filtered: Optional[bool] = None,
+        gain_to_uV: Optional[float] = None,
     ):
+
+        gain_to_uV = gain_to_uV if gain_to_uV is not None else self.HEADSTAGE_GAIN_TO_UV
+
         super().__init__(
             file_paths=[file_path],
             sampling_frequency=sampling_frequency,
             num_channels=num_channels,
             dtype=self.DTYPE,
             time_axis=self.TIME_AXIS,
             file_offset=self.FILE_OFFSET,
-            gain_to_uV=self.GAIN_TO_UV,
+            gain_to_uV=gain_to_uV,
             offset_to_uV=self.OFFSET_TO_UV,
             is_filtered=is_filtered,
             channel_ids=channel_ids,
@@ -65,6 +87,7 @@ def __init__(
             "num_channels": num_channels,
             "channel_ids": channel_ids,
             "is_filtered": is_filtered,
+            "gain_to_uV": gain_to_uV,
         }