From 419438a2a143c0b22247d2f52ddf2712507e0d72 Mon Sep 17 00:00:00 2001 From: Siddhardha Nanda <99672439+SID-6921@users.noreply.github.com> Date: Sat, 14 Nov 2026 14:29:40 -0500 Subject: [PATCH] Fix compute_amplitude_cutoffs() default num_histogram_bins left at 500 #4415 fixed amplitude_cutoff()'s and AmplitudeCutoff.metric_params's num_histogram_bins default back to 100 after a regression, but didn't touch compute_amplitude_cutoffs()'s own signature default, which stayed at 500 even though its own docstring still said 100. With amplitudes_bins_min_ratio=5, that mismatch silently raises the spike count a unit needs before its amplitude_cutoff stops being NaN from 500 to 2500 whenever compute_amplitude_cutoffs() is called directly without an explicit num_histogram_bins override. Confirmed with a 2317-spike unit: num_histogram_bins=500 returns NaN, num_histogram_bins=100 returns a real value (0.23). Set compute_amplitude_cutoffs()'s default to 100, matching its own docstring, AmplitudeCutoff.metric_params, and the amplitude_cutoff() helper it wraps. Also fixed amplitude_cutoff()'s docstring, which still claimed "default: 500" after #4415 changed the actual default to 100. --- src/spikeinterface/metrics/quality/misc_metrics.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/spikeinterface/metrics/quality/misc_metrics.py b/src/spikeinterface/metrics/quality/misc_metrics.py index 016a2d24f9..9da3db160b 100644 --- a/src/spikeinterface/metrics/quality/misc_metrics.py +++ b/src/spikeinterface/metrics/quality/misc_metrics.py @@ -922,7 +922,7 @@ def compute_amplitude_cutoffs( sorting_analyzer, unit_ids=None, periods=None, - num_histogram_bins=500, + num_histogram_bins=100, histogram_smoothing_value=3, amplitudes_bins_min_ratio=5, ): @@ -1639,7 +1639,7 @@ def amplitude_cutoff( ---------- amplitudes : ndarray_like The amplitudes (in µV) of the spikes for one unit. - num_histogram_bins : int, default: 500 + num_histogram_bins : int, default: 100 The number of bins to use to compute the amplitude histogram. histogram_smoothing_value : int, default: 3 Controls the smoothing applied to the amplitude histogram.