Skip to content

Commit a38116d

Browse files
committed
Some final docs/api/sphinx fixes
1 parent 71af00e commit a38116d

8 files changed

Lines changed: 17 additions & 15 deletions

File tree

doc/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,7 @@ spikeinterface.curation
336336
Deprecated
337337
~~~~~~~~~~
338338
.. automodule:: spikeinterface.curation
339+
:noindex:
339340

340341
.. autofunction:: apply_sortingview_curation
341342
.. autoclass:: CurationSorting

doc/how_to/drift_with_lfp.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Preprocessing
6464
Contrary to the **dredge_ap** approach, which needs detected peaks and peak locations, the **dredge_lfp**
6565
method is estimating the motion directly on traces.
6666
Importantly, the method requires some additional pre-processing steps:
67+
6768
* ``bandpass_filter``: to "focus" the signal on a particular band
6869
* ``phase_shift``: to compensate for the sampling misalignement
6970
* ``resample``: to further reduce the sampling fequency of the signal and speed up the computation. The sampling frequency of the estimated motion will be the same as the resampling frequency. Here we choose 250Hz, which corresponds to a sampling interval of 4ms.

doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ state-of-the-art spike sorters, post-process and curate the output, compute qual
1414

1515
.. warning::
1616

17-
Version 0.101.0 introduces a major API improvement: the :code:`SortingAnalyzer`.`
17+
Version 0.101.0 introduces a major API improvement: the :code:`SortingAnalyzer`.
1818
To read more about the motivations, checkout the
1919
`enhancement proposal <https://github.com/SpikeInterface/spikeinterface/issues/2282>`_.
2020
Learn how to :ref:`update your code here <tutorials/waveform_extractor_to_sorting_analyzer:From WaveformExtractor to SortingAnalyzer>`
2121
and read more about the :code:`SortingAnalyzer`, please refer to the
22-
:ref:`core <modules/core:SortingAnalyzer>` and :ref:`postprocessing <modules/postprocessing>` module
22+
:ref:`core <modules/core:SortingAnalyzer>` and :ref:`postprocessing <modules/postprocessing:Postprocessing module>` module
2323
documentation.
2424

2525

doc/modules/postprocessing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ Extensions as AnalyzerExtensions
1313
--------------------------------
1414

1515
There are several postprocessing tools available, and all of them are implemented as a
16-
:py:class:`~spikeinterface.core.ResultExtension`. If the :code:`SortingAnalyzer` is saved to disk, all computations on
16+
:py:class:`~spikeinterface.core.AnalyzerExtension`. If the :code:`SortingAnalyzer` is saved to disk, all computations on
1717
top of it will be saved alongside the :code:`SortingAnalyzer` itself (sub folder, zarr path or sub dict).
1818
This workflow is convenient for retrieval of time-consuming computations (such as pca or spike amplitudes) when reloading a
1919
:code:`SortingAnalyzer`.
2020

21-
:py:class:`~spikeinterface.core.ResultExtension` objects are tightly connected to the
21+
:py:class:`~spikeinterface.core.AnalyzerExtension` objects are tightly connected to the
2222
parent :code:`SortingAnalyzer` object, so that operations done on the :code:`SortingAnalyzer`, such as saving,
2323
loading, or selecting units, will be automatically applied to all extensions.
2424

src/spikeinterface/core/generate.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1079,8 +1079,8 @@ class NoiseGeneratorRecording(BaseRecording):
10791079
noise_block_size: int
10801080
Size in sample of noise block.
10811081
1082-
Note
1083-
----
1082+
Notes
1083+
-----
10841084
If modifying this function, ensure that only one call to malloc is made per call get_traces to
10851085
maintain the optimized memory profile.
10861086
"""

src/spikeinterface/curation/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@
1212
from .splitunitsorting import SplitUnitSorting, split_unit_sorting
1313

1414
# curation format
15-
from .curation_format import validate_curation_dict, curation_label_to_dataframe
15+
from .curation_format import validate_curation_dict, curation_label_to_dataframe, apply_curation
1616

1717
from .sortingview_curation import apply_sortingview_curation

src/spikeinterface/sortingcomponents/motion/dredge.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ def dredge_ap(
182182
matrix (or several, one for each nonrigid window). This matrix is used to solve for a
183183
motion estimate.
184184
185-
Arguments
186-
---------
185+
Parameters
186+
----------
187187
recording: BaseRecording
188188
The recording extractor
189189
peaks: numpy array
@@ -518,8 +518,8 @@ def dredge_online_lfp(
518518
):
519519
"""Online registration of a preprocessed LFP recording
520520
521-
Arguments
522-
---------
521+
Parameters
522+
----------
523523
{}
524524
525525
Returns
@@ -1065,8 +1065,8 @@ def calc_corr_decent_pair(
10651065
the normxcorrs at the best displacement, and the matrix of the best
10661066
displacements.
10671067
1068-
Arguments
1069-
---------
1068+
Parameters
1069+
----------
10701070
raster : DxT array
10711071
batch_size : int
10721072
How many raster rows to xcorr against the whole raster

src/spikeinterface/sortingcomponents/motion/motion_cleaner.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ def clean_motion_vector(motion, temporal_bins, bin_duration_s, speed_threshold=3
99
Also can apply a smoothing.
1010
1111
12-
Arguments
13-
---------
12+
Parameters
13+
----------
1414
motion: numpy array 2d
1515
Motion estimate in um.
1616
temporal_bins: numpy.array 1d

0 commit comments

Comments
 (0)