Skip to content

Commit 2faed13

Browse files
committed
Remove the need of template_similarity extension for autocorrelogram plot
1 parent 7c953c2 commit 2faed13

File tree

4 files changed

+13
-6
lines changed

4 files changed

+13
-6
lines changed

src/spikeinterface/exporters/report.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ def export_report(
2222
"""
2323
Exports a SI spike sorting report. The report includes summary figures of the spike sorting output.
2424
What is plotted depends on what has been calculated. Unit locations and unit waveforms are always included.
25-
Unit waveform densities, correlograms and spike amplitudes are plotted if `waveforms`, `correlograms`
26-
and 'template_similarity', and `spike_amplitudes` have been computed for the given `sorting_analyzer`.
25+
Unit waveform densities, correlograms and spike amplitudes are plotted if `waveforms`, `correlograms`,
26+
and `spike_amplitudes` have been computed for the given `sorting_analyzer`.
2727
2828
Parameters
2929
----------

src/spikeinterface/widgets/autocorrelograms.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ class AutoCorrelogramsWidget(CrossCorrelogramsWidget):
99
# the doc is copied form CrossCorrelogramsWidget
1010

1111
def __init__(self, *args, **kargs):
12-
CrossCorrelogramsWidget.__init__(self, *args, **kargs)
12+
_ = kargs.pop("min_similarity_for_correlograms", 0.0)
13+
CrossCorrelogramsWidget.__init__(
14+
self,
15+
*args,
16+
**kargs,
17+
min_similarity_for_correlograms=None,
18+
)
1319

1420
def plot_matplotlib(self, data_plot, **backend_kwargs):
1521
import matplotlib.pyplot as plt

src/spikeinterface/widgets/crosscorrelograms.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ class CrossCorrelogramsWidget(BaseWidget):
2121
List of unit ids
2222
min_similarity_for_correlograms : float, default: 0.2
2323
For sortingview backend. Threshold for computing pair-wise cross-correlograms.
24-
If template similarity between two units is below this threshold, the cross-correlogram is not displayed
24+
If template similarity between two units is below this threshold, the cross-correlogram is not displayed.
25+
For auto-correlograms plot, this is automatically set to None.
2526
window_ms : float, default: 100.0
2627
Window for CCGs in ms. If correlograms are already computed (e.g. with SortingAnalyzer),
2728
this argument is ignored

src/spikeinterface/widgets/unit_summary.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ def plot_matplotlib(self, data_plot, **backend_kwargs):
108108
fig = self.figure
109109
nrows = 2
110110
ncols = 2
111-
if sorting_analyzer.has_extension("correlograms") and sorting_analyzer.has_extension("template_similarity"):
111+
if sorting_analyzer.has_extension("correlograms"):
112112
ncols += 1
113113
if sorting_analyzer.has_extension("waveforms"):
114114
ncols += 1
@@ -172,7 +172,7 @@ def plot_matplotlib(self, data_plot, **backend_kwargs):
172172
col_counter += 1
173173
ax_waveform_density.set_ylabel(None)
174174

175-
if sorting_analyzer.has_extension("correlograms") and sorting_analyzer.has_extension("template_similarity"):
175+
if sorting_analyzer.has_extension("correlograms"):
176176
ax_correlograms = fig.add_subplot(gs[:2, col_counter])
177177
AutoCorrelogramsWidget(
178178
sorting_analyzer,

0 commit comments

Comments
 (0)