Rerun quickstart again!

SpikeInterface · May 3, 2024 · 5b63af4 · 5b63af4
1 parent 98c1dd4
commit 5b63af4
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 0 deletions.
diff --git a/doc/get_started/quickstart.rst b/doc/get_started/quickstart.rst
@@ -518,7 +518,35 @@ Many of the extensions have parameters you can tune
 
     <spikeinterface.postprocessing.template_similarity.ComputeTemplateSimilarity at 0x7fb4f546d640>
 
+As you can see, it becomes a bit overwhelming if you’re computing lots of extensions. 
+Luckily, there’s some nice syntax for this very situation. We can redo the last
+nine compute statements in one command as follows
 
+.. code:: ipython3
+
+    extensions_to_compute = [
+        "random_spikes",
+        "waveforms",
+        "noise_levels",
+        "templates",
+        "spike_amplitudes",
+        "unit_locations",
+        "spike_locations",
+        "correlograms",
+        "template_similarity"
+    ]
+
+    extension_params = {
+        "unit_locations": {"method": "center_of_mass"},
+        "spike_locations": {"ms_before": 0.1},
+        "correlograms": {"bin_ms": 0.1},
+        "template_similarity": {"method": "cosine_similarity"}
+    }
+
+    analyzer_TDC.compute(extensions_to_compute, extension_params=extension_params)
+
+Which you might find easier. Note that if we pass no extension parameters, the 
+computation simply uses the default parameters.
 
 Find out more about the available parameters and extensions
 `here <https://spikeinterface.readthedocs.io/en/latest/modules/postprocessing.html>`__.

diff --git a/examples/get_started/quickstart.py b/examples/get_started/quickstart.py
@@ -254,6 +254,36 @@
 analyzer_TDC.compute("template_similarity", method="cosine_similarity")
 # -
 
+# As you can see, it becomes a bit overwhelming if you’re computing lots of extensions. 
+# Luckily, there’s some nice syntax for this very situation. We can redo the last
+# nine compute statements in one command as follows
+
+# +
+extensions_to_compute = [
+    "random_spikes",
+    "waveforms",
+    "noise_levels",
+    "templates",
+    "spike_amplitudes",
+    "unit_locations",
+    "spike_locations",
+    "correlograms",
+    "template_similarity"
+]
+
+extension_params = {
+    "unit_locations": {"method": "center_of_mass"},
+    "spike_locations": {"ms_before": 0.1},
+    "correlograms": {"bin_ms": 0.1},
+    "template_similarity": {"method": "cosine_similarity"}
+}
+
+analyzer_TDC.compute(extensions_to_compute, extension_params=extension_params)
+# -
+
+# Which you might find easier. Note that if we pass no extension parameters, the 
+# computation simply uses the default parameters.
+
 # Find out more about the available parameters and extensions [here](https://spikeinterface.readthedocs.io/en/latest/modules/postprocessing.html).
 
 # The calculations are saved in the `extensions` subfolder of the `SortingAnalyzer` folder.