Merge branch 'add_time_vector_case_to_get_duration' of https://github.com/JoeZiminski/spikeinterface into add_time_vector_case_to_get_duration

Author: JoeZiminski

doc/api.rst

@@ -338,59 +338,58 @@ spikeinterface.curation
 spikeinterface.generation
 -------------------------
 
+.. currentmodule:: spikeinterface.generation
+
 Core
 ~~~~
-.. automodule:: spikeinterface.generation
-
-    .. autofunction:: generate_recording
-    .. autofunction:: generate_sorting
-    .. autofunction:: generate_snippets
-    .. autofunction:: generate_templates
-    .. autofunction:: generate_recording_by_size
-    .. autofunction:: generate_ground_truth_recording
-    .. autofunction:: add_synchrony_to_sorting
-    .. autofunction:: synthesize_random_firings
-    .. autofunction:: inject_some_duplicate_units
-    .. autofunction:: inject_some_split_units
-    .. autofunction:: synthetize_spike_train_bad_isi
-    .. autofunction:: inject_templates
-    .. autofunction:: noise_generator_recording
-    .. autoclass:: InjectTemplatesRecording
-    .. autoclass:: NoiseGeneratorRecording
+
+
+.. autofunction:: generate_recording
+.. autofunction:: generate_sorting
+.. autofunction:: generate_snippets
+.. autofunction:: generate_templates
+.. autofunction:: generate_recording_by_size
+.. autofunction:: generate_ground_truth_recording
+.. autofunction:: add_synchrony_to_sorting
+.. autofunction:: synthesize_random_firings
+.. autofunction:: inject_some_duplicate_units
+.. autofunction:: inject_some_split_units
+.. autofunction:: synthetize_spike_train_bad_isi
+.. autofunction:: inject_templates
+.. autofunction:: noise_generator_recording
+.. autoclass:: InjectTemplatesRecording
+.. autoclass:: NoiseGeneratorRecording
 
 Drift
 ~~~~~
-.. automodule:: spikeinterface.generation
 
-    .. autofunction:: generate_drifting_recording
-    .. autofunction:: generate_displacement_vector
-    .. autofunction:: make_one_displacement_vector
-    .. autofunction:: make_linear_displacement
-    .. autofunction:: move_dense_templates
-    .. autofunction:: interpolate_templates
-    .. autoclass:: DriftingTemplates
-    .. autoclass:: InjectDriftingTemplatesRecording
+.. autofunction:: generate_drifting_recording
+.. autofunction:: generate_displacement_vector
+.. autofunction:: make_one_displacement_vector
+.. autofunction:: make_linear_displacement
+.. autofunction:: move_dense_templates
+.. autofunction:: interpolate_templates
+.. autoclass:: DriftingTemplates
+.. autoclass:: InjectDriftingTemplatesRecording
 
 Hybrid
 ~~~~~~
-.. automodule:: spikeinterface.generation
 
-    .. autofunction:: generate_hybrid_recording
-    .. autofunction:: estimate_templates_from_recording
-    .. autofunction:: select_templates
-    .. autofunction:: scale_template_to_range
-    .. autofunction:: relocate_templates
-    .. autofunction:: fetch_template_object_from_database
-    .. autofunction:: fetch_templates_database_info
-    .. autofunction:: list_available_datasets_in_template_database
-    .. autofunction:: query_templates_from_database
+.. autofunction:: generate_hybrid_recording
+.. autofunction:: estimate_templates_from_recording
+.. autofunction:: select_templates
+.. autofunction:: scale_template_to_range
+.. autofunction:: relocate_templates
+.. autofunction:: fetch_template_object_from_database
+.. autofunction:: fetch_templates_database_info
+.. autofunction:: list_available_datasets_in_template_database
+.. autofunction:: query_templates_from_database
 
 
 Noise
 ~~~~~
-.. automodule:: spikeinterface.generation
 
-    .. autofunction:: generate_noise
+.. autofunction:: generate_noise
 
 
 spikeinterface.sortingcomponents
@@ -408,12 +407,6 @@ Peak Detection
 
     .. autofunction:: detect_peaks
 
-Motion Correction
-~~~~~~~~~~~~~~~~~
-.. automodule:: spikeinterface.sortingcomponents.motion_interpolation
-
-    .. autoclass:: InterpolateMotionRecording
-
 Clustering
 ~~~~~~~~~~
 .. automodule:: spikeinterface.sortingcomponents.clustering
@@ -425,3 +418,15 @@ Template Matching
 .. automodule:: spikeinterface.sortingcomponents.matching
 
     .. autofunction:: find_spikes_from_templates
+
+Motion Correction
+~~~~~~~~~~~~~~~~~
+.. automodule:: spikeinterface.sortingcomponents.motion
+
+    .. autoclass:: Motion
+    .. autofunction:: estimate_motion
+    .. autofunction:: interpolate_motion
+    .. autofunction:: correct_motion_on_peaks
+    .. autofunction:: interpolate_motion_on_traces
+    .. autofunction:: clean_motion_vector
+    .. autoclass:: InterpolateMotionRecording

doc/conf.py

@@ -74,6 +74,8 @@
     "IPython.sphinxext.ipython_console_highlighting"
 ]
 
+autosectionlabel_prefix_document = True
+
 numpydoc_show_class_members = False
 
 
@@ -128,7 +130,7 @@
                                        '../examples/tutorials/widgets',
                                        ]),
     'within_subsection_order': FileNameSortKey,
-    'ignore_pattern': '/generate_',
+    'ignore_pattern': '/generate_*',
     'nested_sections': False,
     'copyfile_regex': r'.*\.rst|.*\.png|.*\.svg'
 }

doc/get_started/install_sorters.rst

@@ -27,7 +27,7 @@ sorters to retrieve installation instructions for other operating systems.
 We use **pip** to install packages, but **conda** should also work in many cases.
 
 Some novel spike sorting algorithms are implemented directly in SpikeInterface using the
-:py:mod:`spikeinterface.sortingcomponents` module. Checkout the :ref:`SpikeInterface-based spike sorters` section of this page
+:py:mod:`spikeinterface.sortingcomponents` module. Checkout the :ref:`get_started/install_sorters:SpikeInterface-based spike sorters` section of this page
 for more information!
 
 If you experience installation problems please directly contact the authors of these tools or write on the

doc/get_started/installation.rst

@@ -102,4 +102,4 @@ Sub-modules have more dependencies, so you should also install:
 
 
 All external spike sorters can be either run inside containers (Docker or Singularity - see :ref:`containerizedsorters`)
-or must be installed independently (see :ref:`Installing Spike Sorters`).
+or must be installed independently (see :ref:`get_started/install_sorters:Installing Spike Sorters`).

doc/how_to/benchmark_with_hybrid_recordings.rst

@@ -24,7 +24,7 @@ order to smoothly inject spikes into the recording.
     import spikeinterface.generation as sgen
     import spikeinterface.widgets as sw
 
-    from spikeinterface.sortingcomponents.motion_estimation import estimate_motion
+    from spikeinterface.sortingcomponents.motion import estimate_motion
 
     import numpy as np
     import matplotlib.pyplot as plt
@@ -1202,63 +1202,63 @@ drifts when injecting hybrid spikes.
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     1.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     2.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     3.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     4.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     5.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     6.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     7.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     8.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     9.         0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     10.        0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     11.        0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     12.        0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     13.        0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     14.        0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385
-     0.         0.         0.07692308 0.07692308 0.15384615 0.15384615
+     15.        0.         0.07692308 0.07692308 0.15384615 0.15384615
      0.23076923 0.23076923 0.30769231 0.30769231 0.38461538 0.38461538
      0.46153846 0.46153846 0.53846154 0.53846154 0.61538462 0.61538462
      0.69230769 0.69230769 0.76923077 0.76923077 0.84615385 0.84615385]</details></ul></details>