doc updates [skip ci]

mne-tools · Aug 23, 2024 · 6398e46 · 6398e46
1 parent 61fb020
commit 6398e46
Show file tree

Hide file tree

Showing 92 changed files with 452 additions and 348 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: e23d56b587a1ee1fc0b114670128f976
+config: 0b0b7b95720a924c3268f16ffab790cc
 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/268d987293d4ee80f1e0d3ca84cf1bd4/read_bids_datasets.zip b/dev/_downloads/268d987293d4ee80f1e0d3ca84cf1bd4/read_bids_datasets.zip
diff --git a/dev/_downloads/2d16cae3d55264a4b7d58ed70766e580/mark_bad_channels.zip b/dev/_downloads/2d16cae3d55264a4b7d58ed70766e580/mark_bad_channels.zip
diff --git a/dev/_downloads/4643fc773d02dab3aa626f7f7d767950/convert_mne_sample.zip b/dev/_downloads/4643fc773d02dab3aa626f7f7d767950/convert_mne_sample.zip
diff --git a/dev/_downloads/4c4fb656ad2ed5296dbabd0c14fa2b02/convert_nirs_to_bids.zip b/dev/_downloads/4c4fb656ad2ed5296dbabd0c14fa2b02/convert_nirs_to_bids.zip
diff --git a/dev/_downloads/5d54d38fa89e77a34bdfd9413b4fbe4f/convert_group_studies.zip b/dev/_downloads/5d54d38fa89e77a34bdfd9413b4fbe4f/convert_group_studies.zip
diff --git a/dev/_downloads/6a5f0c10c42d095fdc0217cd0f22c214/rename_brainvision_files.zip b/dev/_downloads/6a5f0c10c42d095fdc0217cd0f22c214/rename_brainvision_files.zip
diff --git a/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/dev/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/dev/_downloads/701f5b32d08455f1c1e98b7ab1715881/bidspath.zip b/dev/_downloads/701f5b32d08455f1c1e98b7ab1715881/bidspath.zip
diff --git a/dev/_downloads/7d2e2f052d27d212228870d603a1aca7/convert_ieeg_to_bids.zip b/dev/_downloads/7d2e2f052d27d212228870d603a1aca7/convert_ieeg_to_bids.zip
diff --git a/dev/_downloads/96ed94148ab6ae1fb5c5140a74461a04/update_bids_datasets.zip b/dev/_downloads/96ed94148ab6ae1fb5c5140a74461a04/update_bids_datasets.zip
diff --git a/dev/_downloads/b5991261ea1afda327daaddd3f69dfac/create_bids_folder.zip b/dev/_downloads/b5991261ea1afda327daaddd3f69dfac/create_bids_folder.zip
diff --git a/dev/_downloads/bdc50d7de6c227351cc05fc714c0362c/anonymize_dataset.zip b/dev/_downloads/bdc50d7de6c227351cc05fc714c0362c/anonymize_dataset.zip
diff --git a/dev/_downloads/c3986e0cfd29a19505f36bab33dcf723/convert_eeg_to_bids.zip b/dev/_downloads/c3986e0cfd29a19505f36bab33dcf723/convert_eeg_to_bids.zip
diff --git a/dev/_downloads/d90b2c92d1a1159e30b2143cd51843b4/convert_mri_and_trans.zip b/dev/_downloads/d90b2c92d1a1159e30b2143cd51843b4/convert_mri_and_trans.zip
diff --git a/dev/_downloads/f6baa7da9ece655f45f704c75843a8ff/convert_empty_room.zip b/dev/_downloads/f6baa7da9ece655f45f704c75843a8ff/convert_empty_room.zip
diff --git a/dev/_modules/index.html b/dev/_modules/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>Overview: module code &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../_static/documentation_options.js?v=4a854790"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/copyfiles.html b/dev/_modules/mne_bids/copyfiles.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.copyfiles &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/dig.html b/dev/_modules/mne_bids/dig.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.dig &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/inspect.html b/dev/_modules/mne_bids/inspect.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.inspect &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/path.html b/dev/_modules/mne_bids/path.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.path &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/read.html b/dev/_modules/mne_bids/read.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.read &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 
@@ -679,7 +679,7 @@ <h1>Source code for mne_bids.read</h1><div class="highlight"><pre>
 
     <span class="c1"># If we have events, convert them to Annotations so they can be easily</span>
     <span class="c1"># merged with existing Annotations.</span>
-    <span class="k">if</span> <span class="n">events</span><span class="o">.</span><span class="n">size</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
+    <span class="k">if</span> <span class="n">events</span><span class="o">.</span><span class="n">size</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">event_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
         <span class="n">ids_without_desc</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">events</span><span class="p">[:,</span> <span class="mi">2</span><span class="p">])</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="n">event_id</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
         <span class="k">if</span> <span class="n">ids_without_desc</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
@@ -710,6 +710,22 @@ <h1>Source code for mne_bids.read</h1><div class="highlight"><pre>
         <span class="n">raw</span><span class="o">.</span><span class="n">set_annotations</span><span class="p">(</span><span class="n">annotations</span><span class="p">)</span>
         <span class="k">del</span> <span class="n">id_to_desc_map</span><span class="p">,</span> <span class="n">annotations</span><span class="p">,</span> <span class="n">new_annotations</span>
 
+    <span class="k">if</span> <span class="n">events</span><span class="o">.</span><span class="n">size</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">event_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+        <span class="n">new_annotations</span> <span class="o">=</span> <span class="n">mne</span><span class="o">.</span><span class="n">annotations_from_events</span><span class="p">(</span>
+            <span class="n">events</span><span class="o">=</span><span class="n">events</span><span class="p">,</span>
+            <span class="n">sfreq</span><span class="o">=</span><span class="n">raw</span><span class="o">.</span><span class="n">info</span><span class="p">[</span><span class="s2">&quot;sfreq&quot;</span><span class="p">],</span>
+            <span class="n">orig_time</span><span class="o">=</span><span class="n">raw</span><span class="o">.</span><span class="n">annotations</span><span class="o">.</span><span class="n">orig_time</span><span class="p">,</span>
+        <span class="p">)</span>
+
+        <span class="n">raw</span> <span class="o">=</span> <span class="n">raw</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>  <span class="c1"># Don&#39;t alter the original.</span>
+        <span class="n">annotations</span> <span class="o">=</span> <span class="n">raw</span><span class="o">.</span><span class="n">annotations</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
+
+        <span class="c1"># We use `+=` here because `Annotations.__iadd__()` does the right</span>
+        <span class="c1"># thing and also performs a sanity check on `Annotations.orig_time`.</span>
+        <span class="n">annotations</span> <span class="o">+=</span> <span class="n">new_annotations</span>
+        <span class="n">raw</span><span class="o">.</span><span class="n">set_annotations</span><span class="p">(</span><span class="n">annotations</span><span class="p">)</span>
+        <span class="k">del</span> <span class="n">annotations</span><span class="p">,</span> <span class="n">new_annotations</span>
+
     <span class="c1"># Now convert the Annotations to events.</span>
     <span class="n">all_events</span><span class="p">,</span> <span class="n">all_desc</span> <span class="o">=</span> <span class="n">events_from_annotations</span><span class="p">(</span>
         <span class="n">raw</span><span class="p">,</span>

diff --git a/dev/_modules/mne_bids/report/_report.html b/dev/_modules/mne_bids/report/_report.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.report._report &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/sidecar_updates.html b/dev/_modules/mne_bids/sidecar_updates.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.sidecar_updates &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/stats.html b/dev/_modules/mne_bids/stats.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.stats &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.stats &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>
 

diff --git a/dev/_modules/mne_bids/utils.html b/dev/_modules/mne_bids/utils.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mne_bids.utils &#8212; MNE-BIDS 0.16.0.dev28+gf9199621 documentation</title>
+    <title>mne_bids.utils &#8212; MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=62292a13"></script>
+    <script src="../../_static/documentation_options.js?v=4a854790"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -147,7 +147,7 @@
 
 
 
-    <p class="title logo__title">MNE-BIDS 0.16.0.dev28+gf9199621 documentation</p>
+    <p class="title logo__title">MNE-BIDS 0.16.0.dev29+g471bd0cd documentation</p>
 
 </a></div>