doc updates [skip ci] (867)

mne-tools · Nov 28, 2023 · c55176d · c55176d
1 parent 22d861b
commit c55176d
Show file tree

Hide file tree

Showing 72 changed files with 434 additions and 535 deletions.
diff --git a/dev/.buildinfo b/dev/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9379a35689002df61f21f1ddeb4dbd4d
+config: 5ec02db491208e706eb61126ee255b85
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/dev/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_001.png b/dev/_images/sphx_glr_dpli_wpli_pli_001.png
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_002.png b/dev/_images/sphx_glr_dpli_wpli_pli_002.png
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_004.png b/dev/_images/sphx_glr_dpli_wpli_pli_004.png
diff --git a/dev/_images/sphx_glr_dpli_wpli_pli_thumb.png b/dev/_images/sphx_glr_dpli_wpli_pli_thumb.png
diff --git a/dev/_modules/index.html b/dev/_modules/index.html
@@ -454,7 +454,7 @@ <h1>All modules for which code is available</h1>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/base.html b/dev/_modules/mne_connectivity/base.html
@@ -1572,7 +1572,7 @@ <h1>Source code for mne_connectivity.base</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/effective.html b/dev/_modules/mne_connectivity/effective.html
@@ -663,7 +663,7 @@ <h1>Source code for mne_connectivity.effective</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/envelope.html b/dev/_modules/mne_connectivity/envelope.html
@@ -770,7 +770,7 @@ <h1>Source code for mne_connectivity.envelope</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/io.html b/dev/_modules/mne_connectivity/io.html
@@ -558,7 +558,7 @@ <h1>Source code for mne_connectivity.io</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/spectral/epochs.html b/dev/_modules/mne_connectivity/spectral/epochs.html
@@ -1543,7 +1543,7 @@ <h1>Source code for mne_connectivity.spectral.epochs</h1><div class="highlight">
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/spectral/time.html b/dev/_modules/mne_connectivity/spectral/time.html
@@ -1546,7 +1546,7 @@ <h1>Source code for mne_connectivity.spectral.time</h1><div class="highlight"><p
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/utils/utils.html b/dev/_modules/mne_connectivity/utils/utils.html
@@ -822,7 +822,7 @@ <h1>Source code for mne_connectivity.utils.utils</h1><div class="highlight"><pre
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/vector_ar/model_selection.html b/dev/_modules/mne_connectivity/vector_ar/model_selection.html
@@ -602,7 +602,7 @@ <h1>Source code for mne_connectivity.vector_ar.model_selection</h1><div class="h
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/vector_ar/var.html b/dev/_modules/mne_connectivity/vector_ar/var.html
@@ -1015,7 +1015,7 @@ <h1>Source code for mne_connectivity.vector_ar.var</h1><div class="highlight"><p
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/viz/_3d.html b/dev/_modules/mne_connectivity/viz/_3d.html
@@ -564,7 +564,7 @@ <h1>Source code for mne_connectivity.viz._3d</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/_modules/mne_connectivity/viz/circle.html b/dev/_modules/mne_connectivity/viz/circle.html
@@ -600,7 +600,7 @@ <h1>Source code for mne_connectivity.viz.circle</h1><div class="highlight"><pre>
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/api.html b/dev/api.html
@@ -675,7 +675,7 @@ <h2>Visualization functions<a class="headerlink" href="#visualization-functions"
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/auto_examples/compare_connectivity_over_time_over_trial.html b/dev/auto_examples/compare_connectivity_over_time_over_trial.html
@@ -546,7 +546,7 @@ <h2>Simulated examples<a class="headerlink" href="#simulated-examples" title="Pe
 0 projection items activated
 Using qt as 2D backend.
 
-&lt;mne_qt_browser._pg_figure.MNEQtBrowser object at 0x7fb07eb2d900&gt;
+&lt;mne_qt_browser._pg_figure.MNEQtBrowser object at 0x7fe338a6d900&gt;
 </pre></div>
 </div>
 <p>First we compute connectivity over trials.</p>
@@ -744,7 +744,7 @@ <h2>Simulated examples<a class="headerlink" href="#simulated-examples" title="Pe
 No baseline correction applied
 0 projection items activated
 
-&lt;mne_qt_browser._pg_figure.MNEQtBrowser object at 0x7fb096a0be20&gt;
+&lt;mne_qt_browser._pg_figure.MNEQtBrowser object at 0x7fe338b0be20&gt;
 </pre></div>
 </div>
 <p>First we compute connectivity over trials.</p>
@@ -1085,7 +1085,7 @@ <h2>Real data demonstration<a class="headerlink" href="#real-data-demonstration"
 <img src="../_images/sphx_glr_compare_connectivity_over_time_over_trial_006.png" srcset="../_images/sphx_glr_compare_connectivity_over_time_over_trial_006.png" alt="compare connectivity over time over trial" class = "sphx-glr-single-img"/><img src="../_images/sphx_glr_compare_connectivity_over_time_over_trial_007.png" srcset="../_images/sphx_glr_compare_connectivity_over_time_over_trial_007.png" alt="compare connectivity over time over trial" class = "sphx-glr-single-img"/><div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>Using pyvistaqt 3d backend.
 
 
-&lt;mne.viz.backends._pyvista.PyVistaFigure object at 0x7fb096757ca0&gt;
+&lt;mne.viz.backends._pyvista.PyVistaFigure object at 0x7fe319326110&gt;
 </pre></div>
 </div>
 </section>
@@ -1114,7 +1114,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
 </dd>
 </dl>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 19.062 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 20.825 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-compare-connectivity-over-time-over-trial-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/3d83fa7689135afb6024c7a2851594fa/compare_connectivity_over_time_over_trial.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">compare_connectivity_over_time_over_trial.ipynb</span></code></a></p>
@@ -1206,7 +1206,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/auto_examples/connectivity_classes.html b/dev/auto_examples/connectivity_classes.html
@@ -782,7 +782,7 @@
 [0.0, 0.006659840438612929, 0.013319680877225858, 0.019979521315838786, 0.026639361754451717, 0.03329920219306465, 0.03995904263167757, 0.0466188830702905, 0.05327872350890343, 0.05993856394751636, 0.0665984043861293, 0.07325824482474222, 0.07991808526335514, 0.08657792570196808, 0.093237766140581, 0.09989760657919393, 0.10655744701780687, 0.11321728745641979, 0.11987712789503271, 0.12653696833364564, 0.1331968087722586, 0.13985664921087151, 0.14651648964948444, 0.15317633008809736, 0.1598361705267103, 0.1664960109653232, 0.17315585140393616, 0.17981569184254909, 0.186475532281162, 0.19313537271977493, 0.19979521315838786, 0.20645505359700078, 0.21311489403561373, 0.21977473447422666, 0.22643457491283958, 0.2330944153514525, 0.23975425579006543, 0.24641409622867838, 0.2530739366672913, 0.25973377710590423, 0.2663936175445172, 0.2730534579831301, 0.27971329842174303, 0.2863731388603559, 0.2930329792989689, 0.2996928197375818, 0.3063526601761947, 0.3130125006148077, 0.3196723410534206, 0.3263321814920335, 0.3329920219306464, 0.33965186236925937, 0.3463117028078723, 0.3529715432464852, 0.35963138368509817, 0.36629122412371107, 0.372951064562324, 0.37961090500093697, 0.38627074543954987, 0.3929305858781628, 0.3995904263167757, 0.40625026675538867, 0.41291010719400156, 0.4195699476326145, 0.42622978807122747, 0.43288962850984036, 0.4395494689484533, 0.4462093093870662, 0.45286914982567916, 0.4595289902642921, 0.466188830702905, 0.47284867114151796, 0.47950851158013086, 0.4861683520187438, 0.49282819245735676, 0.49948803289596966, 0.5061478733345826, 0.5128077137731956, 0.5194675542118085, 0.5261273946504214, 0.5327872350890344, 0.5394470755276473, 0.5461069159662602, 0.552766756404873, 0.5594265968434861, 0.566086437282099, 0.5727462777207118, 0.5794061181593249, 0.5860659585979378, 0.5927257990365506, 0.5993856394751635, 0.6060454799137766, 0.6127053203523894, 0.6193651607910023, 0.6260250012296154, 0.6326848416682282, 0.6393446821068411, 0.6460045225454542, 0.652664362984067, 0.6593242034226799, 0.6659840438612928, 0.6726438842999058, 0.6793037247385187, 0.6859635651771316, 0.6926234056157446, 0.6992832460543575, 0.7059430864929704, 0.7126029269315833, 0.7192627673701963, 0.7259226078088092, 0.7325824482474221, 0.7392422886860351, 0.745902129124648, 0.7525619695632609, 0.7592218100018739, 0.7658816504404868, 0.7725414908790997, 0.7792013313177126, 0.7858611717563256, 0.7925210121949385, 0.7991808526335514, 0.8058406930721644, 0.8125005335107773, 0.8191603739493902, 0.8258202143880031, 0.8324800548266161, 0.839139895265229, 0.8457997357038419, 0.8524595761424549, 0.8591194165810678, 0.8657792570196807, 0.8724390974582937, 0.8790989378969066, 0.8857587783355195, 0.8924186187741324, 0.8990784592127454, 0.9057382996513583, 0.9123981400899712, 0.9190579805285842, 0.9257178209671971, 0.93237766140581, 0.939037501844423, 0.9456973422830359, 0.9523571827216488, 0.9590170231602617, 0.9656768635988747, 0.9723367040374876, 0.9789965444761005, 0.9856563849147135, 0.9923162253533264, 0.9989760657919393, 1.0056359062305522, 1.012295746669165, 1.0189555871077782, 1.0256154275463911, 1.032275267985004, 1.038935108423617, 1.0455949488622298, 1.0522547893008427, 1.0589146297394556, 1.0655744701780687, 1.0722343106166816, 1.0788941510552945, 1.0855539914939074, 1.0922138319325203, 1.0988736723711332, 1.105533512809746, 1.1121933532483592, 1.1188531936869721, 1.125513034125585, 1.132172874564198, 1.1388327150028108, 1.1454925554414237, 1.1521523958800366, 1.1588122363186497, 1.1654720767572626, 1.1721319171958755, 1.1787917576344884, 1.1854515980731013, 1.1921114385117142, 1.198771278950327, 1.2054311193889402, 1.212090959827553, 1.218750800266166, 1.225410640704779, 1.2320704811433918, 1.2387303215820047, 1.2453901620206178, 1.2520500024592307, 1.2587098428978436, 1.2653696833364565, 1.2720295237750694, 1.2786893642136823, 1.2853492046522952, 1.2920090450909083, 1.2986688855295212, 1.305328725968134, 1.311988566406747, 1.3186484068453599, 1.3253082472839728, 1.3319680877225857, 1.3386279281611988, 1.3452877685998117, 1.3519476090384246, 1.3586074494770375, 1.3652672899156504, 1.3719271303542633, 1.3785869707928762, 1.3852468112314893, 1.3919066516701022, 1.398566492108715, 1.405226332547328, 1.4118861729859409, 1.4185460134245538, 1.4252058538631667, 1.4318656943017798, 1.4385255347403927, 1.4451853751790056, 1.4518452156176185, 1.4585050560562314, 1.4651648964948443, 1.4718247369334574, 1.4784845773720703, 1.4851444178106832, 1.491804258249296, 1.498464098687909]
 </pre></div>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 20.813 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 19.945 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-connectivity-classes-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/e3e768dadc6db0b74fd182648f25579e/connectivity_classes.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">connectivity_classes.ipynb</span></code></a></p>
@@ -855,7 +855,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/auto_examples/cwt_sensor_connectivity.html b/dev/auto_examples/cwt_sensor_connectivity.html
@@ -634,7 +634,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
 </dd>
 </dl>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 4.236 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 4.358 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-cwt-sensor-connectivity-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/1960d40143c4548fb1518027d69b76f2/cwt_sensor_connectivity.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">cwt_sensor_connectivity.ipynb</span></code></a></p>
@@ -722,7 +722,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/auto_examples/dpli_wpli_pli.html b/dev/auto_examples/dpli_wpli_pli.html
@@ -2576,7 +2576,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
 </dd>
 </dl>
 </div>
-<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 14.631 seconds)</p>
+<p class="sphx-glr-timing"><strong>Total running time of the script:</strong> (0 minutes 14.372 seconds)</p>
 <div class="sphx-glr-footer sphx-glr-footer-example docutils container" id="sphx-glr-download-auto-examples-dpli-wpli-pli-py">
 <div class="sphx-glr-download sphx-glr-download-jupyter docutils container">
 <p><a class="reference download internal" download="" href="../_downloads/c0e8d2c9253a079b7687e8664830e542/dpli_wpli_pli.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">dpli_wpli_pli.ipynb</span></code></a></p>
@@ -2669,7 +2669,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>

diff --git a/dev/auto_examples/dynamic/index.html b/dev/auto_examples/dynamic/index.html
@@ -509,7 +509,7 @@
         <div class="footer-item">
   <p class="copyright">
 
-      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-27.
+      © Copyright 2021-2023, MNE Developers. Last updated on 2023-11-28.
       <br/>
 
   </p>