Update documentation

int-brain-lab · Sep 23, 2024 · e2fa0b8 · e2fa0b8
1 parent 6ce69cd
commit e2fa0b8
Show file tree

Hide file tree

Showing 268 changed files with 4,552 additions and 6,820 deletions.
diff --git a/02_installation.html b/02_installation.html
@@ -27,7 +27,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="How to contribute" href="09_contribution.html" />
-    <link rel="prev" title="Loading Raw Mesoscope Imaging Data" href="notebooks_external/loading_raw_mesoscope_data.html" /> 
+    <link rel="prev" title="Loading Fiber Photometry Data" href="notebooks_external/loading_photometry_data.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -125,7 +125,7 @@ <h1>Unified Environment<a class="headerlink" href="#unified-environment" title="
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="notebooks_external/loading_raw_mesoscope_data.html" class="btn btn-neutral float-left" title="Loading Raw Mesoscope Imaging Data" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="notebooks_external/loading_photometry_data.html" class="btn btn-neutral float-left" title="Loading Fiber Photometry Data" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="09_contribution.html" class="btn btn-neutral float-right" title="How to contribute" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/_autosummary/brainbox.behavior.html b/_autosummary/brainbox.behavior.html
@@ -149,13 +149,13 @@
 <p>Behaviour analysis functions for the IBL task.</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.behavior.dlc.html#module-brainbox.behavior.dlc" title="brainbox.behavior.dlc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior.dlc</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.behavior.dlc.html#module-brainbox.behavior.dlc" title="brainbox.behavior.dlc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dlc</span></code></a></p></td>
 <td><p>Set of functions to deal with dlc data.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.behavior.training.html#module-brainbox.behavior.training" title="brainbox.behavior.training"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior.training</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.behavior.training.html#module-brainbox.behavior.training" title="brainbox.behavior.training"><code class="xref py py-obj docutils literal notranslate"><span class="pre">training</span></code></a></p></td>
 <td><p>Computing and testing IBL training status criteria.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.behavior.wheel.html#module-brainbox.behavior.wheel" title="brainbox.behavior.wheel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior.wheel</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.behavior.wheel.html#module-brainbox.behavior.wheel" title="brainbox.behavior.wheel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">wheel</span></code></a></p></td>
 <td><p>Set of functions to handle wheel data.</p></td>
 </tr>
 </tbody>

diff --git a/_autosummary/brainbox.behavior.wheel.html b/_autosummary/brainbox.behavior.wheel.html
@@ -166,27 +166,18 @@
 <tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.interpolate_position" title="brainbox.behavior.wheel.interpolate_position"><code class="xref py py-obj docutils literal notranslate"><span class="pre">interpolate_position</span></code></a></p></td>
 <td><p>Return linearly interpolated wheel position.</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">last_movement_onset</span></code></p></td>
-<td><p>(DEPRECATED) Find the time at which movement started, given an event timestamp that occurred during the movement.</p></td>
-</tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.movements" title="brainbox.behavior.wheel.movements"><code class="xref py py-obj docutils literal notranslate"><span class="pre">movements</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.movements" title="brainbox.behavior.wheel.movements"><code class="xref py py-obj docutils literal notranslate"><span class="pre">movements</span></code></a></p></td>
 <td><p>Detect wheel movements.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.samples_to_cm" title="brainbox.behavior.wheel.samples_to_cm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">samples_to_cm</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.samples_to_cm" title="brainbox.behavior.wheel.samples_to_cm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">samples_to_cm</span></code></a></p></td>
 <td><p>Convert wheel position samples to cm linear displacement.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.traces_by_trial" title="brainbox.behavior.wheel.traces_by_trial"><code class="xref py py-obj docutils literal notranslate"><span class="pre">traces_by_trial</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.traces_by_trial" title="brainbox.behavior.wheel.traces_by_trial"><code class="xref py py-obj docutils literal notranslate"><span class="pre">traces_by_trial</span></code></a></p></td>
 <td><p>Returns list of tuples of positions and velocity for samples between stimulus onset and feedback.</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">velocity</span></code></p></td>
-<td><p>(DEPRECATED) Compute wheel velocity from non-uniformly sampled wheel data.</p></td>
-</tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#brainbox.behavior.wheel.velocity_filtered" title="brainbox.behavior.wheel.velocity_filtered"><code class="xref py py-obj docutils literal notranslate"><span class="pre">velocity_filtered</span></code></a></p></td>
 <td><p>Compute wheel velocity from uniformly sampled wheel data.</p></td>
 </tr>
-<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">velocity_smoothed</span></code></p></td>
-<td><p>(DEPRECATED) Compute wheel velocity from uniformly sampled wheel data.</p></td>
-</tr>
 </tbody>
 </table>
 <dl class="py function">

diff --git a/_autosummary/brainbox.html b/_autosummary/brainbox.html
@@ -143,55 +143,55 @@
 <p>IBL shared data processing methods.</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.atlas.html#module-brainbox.atlas" title="brainbox.atlas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.atlas</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.atlas.html#module-brainbox.atlas" title="brainbox.atlas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">atlas</span></code></a></p></td>
 <td><p>Functions which map metrics to the Allen atlas.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.behavior.html#module-brainbox.behavior" title="brainbox.behavior"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.behavior</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.behavior.html#module-brainbox.behavior" title="brainbox.behavior"><code class="xref py py-obj docutils literal notranslate"><span class="pre">behavior</span></code></a></p></td>
 <td><p>Behaviour analysis functions for the IBL task.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.core.html#module-brainbox.core" title="brainbox.core"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.core</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.core.html#module-brainbox.core" title="brainbox.core"><code class="xref py py-obj docutils literal notranslate"><span class="pre">core</span></code></a></p></td>
 <td><p>Creates core data types and functions which support all of brainbox.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.ephys_plots.html#module-brainbox.ephys_plots" title="brainbox.ephys_plots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.ephys_plots</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.ephys_plots.html#module-brainbox.ephys_plots" title="brainbox.ephys_plots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ephys_plots</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.io.html#module-brainbox.io" title="brainbox.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.io</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.io.html#module-brainbox.io" title="brainbox.io"><code class="xref py py-obj docutils literal notranslate"><span class="pre">io</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.lfp.html#module-brainbox.lfp" title="brainbox.lfp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.lfp</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.lfp.html#module-brainbox.lfp" title="brainbox.lfp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lfp</span></code></a></p></td>
 <td><p>Functions to analyse LFP signals.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.metrics.html#module-brainbox.metrics" title="brainbox.metrics"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.metrics</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.metrics.html#module-brainbox.metrics" title="brainbox.metrics"><code class="xref py py-obj docutils literal notranslate"><span class="pre">metrics</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.plot.html#module-brainbox.plot" title="brainbox.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.plot</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.plot.html#module-brainbox.plot" title="brainbox.plot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot</span></code></a></p></td>
 <td><p>Plots metrics that assess quality of single units.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.plot_base.html#module-brainbox.plot_base" title="brainbox.plot_base"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.plot_base</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.plot_base.html#module-brainbox.plot_base" title="brainbox.plot_base"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_base</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.population.html#module-brainbox.population" title="brainbox.population"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.population</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.population.html#module-brainbox.population" title="brainbox.population"><code class="xref py py-obj docutils literal notranslate"><span class="pre">population</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.processing.html#module-brainbox.processing" title="brainbox.processing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.processing</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.processing.html#module-brainbox.processing" title="brainbox.processing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">processing</span></code></a></p></td>
 <td><p>Process data from one form into another.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.quality.html#module-brainbox.quality" title="brainbox.quality"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.quality</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.quality.html#module-brainbox.quality" title="brainbox.quality"><code class="xref py py-obj docutils literal notranslate"><span class="pre">quality</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.singlecell.html#module-brainbox.singlecell" title="brainbox.singlecell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.singlecell</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.singlecell.html#module-brainbox.singlecell" title="brainbox.singlecell"><code class="xref py py-obj docutils literal notranslate"><span class="pre">singlecell</span></code></a></p></td>
 <td><p>Computes properties of single-cells, e.g. the autocorrelation and firing rate.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.spike_features.html#module-brainbox.spike_features" title="brainbox.spike_features"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.spike_features</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.spike_features.html#module-brainbox.spike_features" title="brainbox.spike_features"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spike_features</span></code></a></p></td>
 <td><p>Functions that compute spike features from spike waveforms.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.task.html#module-brainbox.task" title="brainbox.task"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.task</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.task.html#module-brainbox.task" title="brainbox.task"><code class="xref py py-obj docutils literal notranslate"><span class="pre">task</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.tests.html#module-brainbox.tests" title="brainbox.tests"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.tests</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.tests.html#module-brainbox.tests" title="brainbox.tests"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tests</span></code></a></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.video.html#module-brainbox.video" title="brainbox.video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.video</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.video.html#module-brainbox.video" title="brainbox.video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">video</span></code></a></p></td>
 <td><p>Functions for analyzing video frame data</p></td>
 </tr>
 </tbody>

diff --git a/_autosummary/brainbox.io.html b/_autosummary/brainbox.io.html
@@ -147,10 +147,10 @@
 <span id="brainbox-io"></span><h1>brainbox.io<a class="headerlink" href="#module-brainbox.io" title="Link to this heading"></a></h1>
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.io.one.html#module-brainbox.io.one" title="brainbox.io.one"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.io.one</span></code></a></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="brainbox.io.one.html#module-brainbox.io.one" title="brainbox.io.one"><code class="xref py py-obj docutils literal notranslate"><span class="pre">one</span></code></a></p></td>
 <td><p>Functions for loading IBL ephys and trial data using the Open Neurophysiology Environment.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="brainbox.io.spikeglx.html#module-brainbox.io.spikeglx" title="brainbox.io.spikeglx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">brainbox.io.spikeglx</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="brainbox.io.spikeglx.html#module-brainbox.io.spikeglx" title="brainbox.io.spikeglx"><code class="xref py py-obj docutils literal notranslate"><span class="pre">spikeglx</span></code></a></p></td>
 <td><p></p></td>
 </tr>
 </tbody>