ibl-neuropixel 1.9.1__py3-none-any.whl → 1.9.2__py3-none-any.whl

{ibl_neuropixel-1.9.1.dist-info → ibl_neuropixel-1.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ibl-neuropixel
-Version: 1.9.1
+Version: 1.9.2
 Summary: Collection of tools for Neuropixel 1.0 and 2.0 probes data
 Home-page: https://github.com/int-brain-lab/ibl-neuropixel
 Author: The International Brain Laboratory

{ibl_neuropixel-1.9.1.dist-info → ibl_neuropixel-1.9.2.dist-info}/RECORD

@@ -1,8 +1,8 @@
 neuropixel.py,sha256=P7sIBAtGIqKReK7OqMBqdwPaTeHjhHMyfyBRL_AvuQY,37987
 spikeglx.py,sha256=4TPXnFGhJahClxr4fA9HwTeiiHBQS9ZEfkWl6t20q2s,41068
-ibl_neuropixel-1.9.1.dist-info/licenses/LICENSE,sha256=JJCjBeS78UPiX7TZpE-FnMjNNpCyrFb4s8VDGG2wD10,1087
+ibl_neuropixel-1.9.2.dist-info/licenses/LICENSE,sha256=JJCjBeS78UPiX7TZpE-FnMjNNpCyrFb4s8VDGG2wD10,1087
 ibldsp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ibldsp/cadzow.py,sha256=pAtxDxBwoNhoxFNc2R5WLwUrmKsq4rQuaglRNgW2Lj8,7251
+ibldsp/cadzow.py,sha256=YVQdF1HAZEhdanGKSBt3FWUSd66_VCxN8y2eQy8q9Fc,7307
 ibldsp/cuda_tools.py,sha256=6LpVhYOCuOXEEg8kJ3aOCE4hzA1Yq1dojsbbBQmQCF4,2387
 ibldsp/destripe_gpu.py,sha256=I5jzFocpsYw36kMMd533YThbrQaZix5e1sHqsUjHvO4,2824
 ibldsp/filter_gpu.py,sha256=DPrPBLRXeCh_6BcJWJnPFaxS9Q6kX4nPENZg-c2q5rc,5789
@@ -12,10 +12,10 @@ ibldsp/plots.py,sha256=XmYC4yca_seZYNEmC5hE5wBiJAl_fi_KU00DbNcM6jI,4577
 ibldsp/raw_metrics.py,sha256=Ie4b7unuFc-XiFc9-tpTsUkph29G-20NvM7iJ25jAPI,5198
 ibldsp/smooth.py,sha256=m_mByXHG_JyFErnYsZ27gXjcqpfwCEuWa6eOb9eFuyg,8033
 ibldsp/spiketrains.py,sha256=lYP1PD4l6T-4KhFu8ZXlbnUUnEQLOriGxN1szacolPY,6878
-ibldsp/utils.py,sha256=uvEPw1adkppiGXuYBkM_fuuX5owq7LRmA6vm438rrYc,17959
-ibldsp/voltage.py,sha256=Iias93xAvxfRDrzgZT-aw-w4xfWtykx2zWLhI2CxzVI,45408
+ibldsp/utils.py,sha256=Ku1pdymbiCyQU5iZX8Akfq47YXM4xegW6G3_aomh6WA,18580
+ibldsp/voltage.py,sha256=Pb1ZYlr8av2XDUspZaSUtF2wOoTy92fnrsxnW9sTIFA,47708
 ibldsp/waveform_extraction.py,sha256=yKrldgHqpwQ_Dq6xdoSCceKkfrL9FUXnpwKJUM3R41M,26570
-ibldsp/waveforms.py,sha256=5OBLYuM902WS_9WGDDmiTh4BpYWGe7-bQYTMxc2mYII,35166
+ibldsp/waveforms.py,sha256=XKWO0sSEhZR1mBsXCdGpVU3ga96HX3CViXIgpl3bml8,35280
 neurowaveforms/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 neurowaveforms/model.py,sha256=YOPWMMNNS_Op5TyK4Br1i9_Ni41jLSqHie5r1vb5VjY,6729
 tests/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -29,7 +29,7 @@ tests/unit/test_spikeglx.py,sha256=9PrSOPGrYAAQEeJPAOmqc3Rhgia6ftv-zihVWXglhqw,3
 tests/unit/test_utils.py,sha256=37XQDUqcABYrrsdX17kX54H4e5jld7GOn1ISxtgoa5U,21859
 tests/unit/test_voltage.py,sha256=Nr6KqNGn2yOGPJYnvVzxdM5IiEHvK2FicDR_7fzvTHQ,6228
 tests/unit/test_waveforms.py,sha256=VnFvUi1pteROwwbC5Ebp2lqSxF3a8a7eXHpD8OUeuTg,16237
-ibl_neuropixel-1.9.1.dist-info/METADATA,sha256=RaS1xeg11qze-sAmPqKVqdKOgUcSk-5l01HNrkX9kIw,3746
-ibl_neuropixel-1.9.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ibl_neuropixel-1.9.1.dist-info/top_level.txt,sha256=WtVcEUptnwU6BT72cgGmrWYFGM9d9qCEqe3LwR9FIw4,48
-ibl_neuropixel-1.9.1.dist-info/RECORD,,
+ibl_neuropixel-1.9.2.dist-info/METADATA,sha256=4RuLzmWxYJjEyYJKA_1Szi0T0Dn5-VRjD7o4BaY-mHQ,3746
+ibl_neuropixel-1.9.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ibl_neuropixel-1.9.2.dist-info/top_level.txt,sha256=WtVcEUptnwU6BT72cgGmrWYFGM9d9qCEqe3LwR9FIw4,48
+ibl_neuropixel-1.9.2.dist-info/RECORD,,

ibldsp/cadzow.py

@@ -17,6 +17,8 @@ for N-spatial dimensions.
 }
 """
 
+from functools import lru_cache
+
 import numpy as np
 import scipy.fft
 from iblutil.numerical import ismember2d
@@ -46,6 +48,7 @@ def traj_matrix_indices(n):
     return itraj
 
 
+@lru_cache(maxsize=24)
 def trajectory(x, y, dtype=np.complex128):
     """
     Computes the 2 spatial dimensions block-Toeplitz indices from x and y trace coordinates.

ibldsp/utils.py

@@ -383,21 +383,34 @@ class WindowGenerator(object):
             yield (first, last, amp)
 
     @property
-    def firstlast_valid(self, discard_edges=False):
+    def first_last_valid_noedge(self):
         """
         Generator that yields a tuple of first, last, first_valid, last_valid index of windows
-        The valid indices span up to half of the overlap
+        The valid indices span up to half of the overlap.
+        The first and last windows have respectively the beginning and end of the signal discarded.
         :return:
         """
+        return self._firstlast_valid(discard_edges=True)
+
+    @property
+    def firstlast_valid(self):
+        """
+        Generator that yields a tuple of first, last, first_valid, last_valid index of windows
+        The valid indices span up to half of the overlap.
+        The first and last windows have the full beginning and end of the signal respectively.
+        To discard the beginning and end edges, use firstlast_valid_noedge instead.
+        :return:
+        """
+        return self._firstlast_valid(self)
+
+    def _firstlast_valid(self, discard_edges=False):
         assert self.overlap % 2 == 0, "Overlap must be even"
         for first, last in self.firstlast:
             first_valid = (
-                0 if first == 0 and not discard_edges else first + self.overlap // 2
+                0 if first == 0 and discard_edges else first + self.overlap // 2
             )
             last_valid = (
-                last
-                if last == self.ns and not discard_edges
-                else last - self.overlap // 2
+                last if last == self.ns and discard_edges else last - self.overlap // 2
             )
             yield (first, last, first_valid, last_valid)
 

ibldsp/voltage.py

@@ -790,21 +790,59 @@ def decompress_destripe_cbin(
 
 
 def detect_bad_channels(
-    raw, fs, similarity_threshold=(-0.5, 1), psd_hf_threshold=None, display=False
+    raw,
+    fs,
+    similarity_threshold=(-0.5, 1),
+    psd_hf_threshold=None,
+    display=False,
+    outside_threshold=-0.75,
 ):
     """
-    Bad channels detection for Neuropixel probes
-    Labels channels
-     0: all clear
-     1: dead low coherence / amplitude
-     2: noisy
-     3: outside of the brain
-    :param raw: [nc, ns]
-    :param fs: sampling frequency
-    :param similarity_threshold:
-    :param psd_hf_threshold:
-    :param display: optinal (False) will show a plot of features alongside a raw data snippet
-    :return: labels (numpy vector [nc]), xfeats: dictionary of features [nc]
+    Detect bad channels in Neuropixel probe recordings based on signal quality metrics.
+
+    This function analyzes raw electrophysiology data to identify and label problematic channels
+    using multiple criteria including cross-correlation with neighboring channels, power spectral
+    density analysis, and spatial coherence patterns. Channels are classified into four categories:
+    good (0), dead (1), noisy (2), or outside the brain (3).
+
+    Parameters
+    ----------
+    raw : numpy.ndarray
+        Raw voltage traces array with shape (nc, ns), where nc is the number of channels
+        and ns is the number of samples.
+    fs : float
+        Sampling frequency in Hz.
+    similarity_threshold : tuple of float, optional
+        Two-element tuple (lower, upper) defining the acceptable range for high-frequency
+        cross-correlation values. Channels outside this range are flagged as dead (below lower)
+        or noisy (above upper). Defaults to (-0.5, 1).
+    psd_hf_threshold : float, optional
+        Threshold for high-frequency power spectral density to identify noisy channels.
+        If None, defaults to 0.02 for AP band (fs > 2600 Hz) or 1.4 for LF band (fs <= 2600 Hz).
+        Units are µV²/Hz.
+    display : bool, optional
+        If True, displays a diagnostic plot showing channel features and a raw data snippet.
+        Defaults to False.
+    outside_threshold : float or str, optional
+        Threshold for low-frequency cross-correlation to identify channels outside the brain.
+        Can be a float value (default -0.75) or 'adaptive' for automatic threshold detection
+        based on signal gradient analysis.
+
+    Returns
+    -------
+    ichannels : numpy.ndarray
+        Integer array of shape (nc,) containing channel labels:
+        - 0: good channel
+        - 1: dead channel (low coherence/amplitude)
+        - 2: noisy channel (high noise or excessive correlation)
+        - 3: outside of the brain
+    xfeats : dict
+        Dictionary containing computed features for each channel:
+        - 'ind': channel indices
+        - 'rms_raw': RMS amplitude of raw signal
+        - 'xcor_hf': detrended high-frequency cross-correlation
+        - 'xcor_lf': low-frequency cross-correlation component
+        - 'psd_hf': mean power spectral density in high-frequency band
     """
 
     def rneighbours(raw, n=1):  # noqa
@@ -897,21 +935,28 @@ def detect_bad_channels(
     )[0]
     # the channels outside of the brains are the contiguous channels below the threshold on the trend coherency
 
-    signal_noisy = xfeats["xcor_lf"]
-    # Filter signal
-    window_size = 25  # Choose based on desired smoothing (e.g., 25 samples)
-    kernel = np.ones(window_size) / window_size
-    # Apply convolution
-    signal_filtered = np.convolve(signal_noisy, kernel, mode="same")
-
-    diff_x = np.diff(signal_filtered)
-    indx = np.where(diff_x < -0.02)[0]  # hardcoded threshold
-    if indx.size > 0:
-        indx_threshold = np.floor(np.median(indx)).astype(int)
-        threshold = signal_noisy[indx_threshold]
-        ioutside = np.where(signal_noisy < threshold)[0]
+    # deal with channels outside of the brain
+    if outside_threshold == "adaptive":
+        signal_noisy = xfeats["xcor_lf"]
+        # Filter signal
+        window_size = 25  # Choose based on desired smoothing (e.g., 25 samples)
+        kernel = np.ones(window_size) / window_size
+        # Apply convolution
+        signal_filtered = np.convolve(signal_noisy, kernel, mode="same")
+
+        diff_x = np.diff(signal_filtered)
+        indx = np.where(diff_x < -0.02)[0]  # hardcoded threshold
+        if indx.size > 0:
+            indx_threshold = np.floor(np.median(indx)).astype(int)
+            threshold = signal_noisy[indx_threshold]
+            ioutside = np.where(signal_noisy < threshold)[0]
+        else:
+            ioutside = np.array([])
     else:
-        ioutside = np.array([])
+        assert np.isreal(outside_threshold) and np.isscalar(outside_threshold), (
+            "outside_threshold must be a real number or 'adaptive' for adaptive threshold"
+        )
+        ioutside = np.where(xfeats["xcor_lf"] < outside_threshold)[0]
 
     if ioutside.size > 0 and ioutside[-1] == (nc - 1):
         a = np.cumsum(np.r_[0, np.diff(ioutside) - 1])

ibldsp/waveforms.py

@@ -297,7 +297,7 @@ def plot_wiggle(
     return ax
 
 
-def double_wiggle(wav, fs=1, ax=None, colors=None, **kwargs):
+def double_wiggle(wav, fs=1, ax=None, colors=None, title=None, **kwargs):
     """
     Double trouble: this wiggle colours both the negative and the postive values
     :param wav: (nchannels, nsamples)
@@ -308,6 +308,7 @@ def double_wiggle(wav, fs=1, ax=None, colors=None, **kwargs):
     :param fill_sign: -1 for negative (default for spikes), 1 for positive
     :param plot_kwargs: kwargs for the line plot
     :param fill_kwargs: kwargs for the fill
+    :param title: title for the axis (optional)
     :return:
     """
     if colors is None:
@@ -334,6 +335,8 @@ def double_wiggle(wav, fs=1, ax=None, colors=None, **kwargs):
         fill_kwargs={"color": colors[1]},
         **kwargs,
     )
+    if title is not None:
+        ax.set(title=title)
     return ax