From b88ddcb9969e01c019452e1a0d1832b092390ea8 Mon Sep 17 00:00:00 2001 From: chrishalcrow <57948917+chrishalcrow@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:17:09 +0100 Subject: [PATCH] Respond to review --- src/spikeinterface/extractors/neoextractors/intan.py | 4 ++-- src/spikeinterface/extractors/toy_example.py | 6 +++--- src/spikeinterface/preprocessing/filter.py | 4 +++- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/spikeinterface/extractors/neoextractors/intan.py b/src/spikeinterface/extractors/neoextractors/intan.py index 9d4db3103c..50fda79123 100644 --- a/src/spikeinterface/extractors/neoextractors/intan.py +++ b/src/spikeinterface/extractors/neoextractors/intan.py @@ -27,8 +27,8 @@ class IntanRecordingExtractor(NeoBaseRecordingExtractor): If True, data that violates integrity assumptions will be loaded. At the moment the only integrity check we perform is that timestamps are continuous. Setting this to True will ignore this check and set the attribute `discontinuous_timestamps` to True in the underlying neo object. - use_names_as_ids : bool or None, default: None - If True, use channel names as IDs. If None, use default IDs. + use_names_as_ids : bool, default: False + If True, use channel names as IDs. If False, use default IDs inherited from neo. """ mode = "file" diff --git a/src/spikeinterface/extractors/toy_example.py b/src/spikeinterface/extractors/toy_example.py index 2f007cca88..55b787f3ed 100644 --- a/src/spikeinterface/extractors/toy_example.py +++ b/src/spikeinterface/extractors/toy_example.py @@ -62,13 +62,13 @@ def toy_example( seed : int or None, default: None Seed for random initialization. upsample_factor : None or int, default: None - A upsampling factor used only when templates are not provided. + An upsampling factor, used only when templates are not provided. num_columns : int, default: 1 Number of columns in probe. average_peak_amplitude : float, default: -100 - Average peak amplitude of generated templates + Average peak amplitude of generated templates. contact_spacing_um : float, default: 40.0 - Spacing between probe contacts. + Spacing between probe contacts in micrometers. Returns ------- diff --git a/src/spikeinterface/preprocessing/filter.py b/src/spikeinterface/preprocessing/filter.py index d18227ca83..93462ac5d8 100644 --- a/src/spikeinterface/preprocessing/filter.py +++ b/src/spikeinterface/preprocessing/filter.py @@ -11,7 +11,9 @@ _common_filter_docs = """**filter_kwargs : dict Certain keyword arguments for `scipy.signal` filters: filter_order : order - The order of the filter + The order of the filter. Note as filtering is applied with scipy's + `filtfilt` functions (i.e. acausal, zero-phase) the effective + order will be double the `filter_order`. filter_mode : "sos" | "ba", default: "sos" Filter form of the filter coefficients: - second-order sections ("sos")