Switch to 0.1.88

raphaelvallat · Nov 1, 2019 · 2006598 · 2006598
1 parent db6a9eb
commit 2006598
Show file tree

Hide file tree

Showing 59 changed files with 1,103 additions and 1,353 deletions.
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.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: 913909f8d36e9cf6e88bd087e9f5c83a
+config: fee99d3c00004ec8065ee37dd502c3b5
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_images/yasa-plot_spectrogram-1.png b/docs/build/html/_images/yasa-plot_spectrogram-1.png
diff --git a/docs/build/html/_images/yasa-plot_spectrogram-2.png b/docs/build/html/_images/yasa-plot_spectrogram-2.png
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>Overview: module code &#8212; yasa 0.1.7 documentation</title>
+    <title>Overview: module code &#8212; yasa 0.1.8 documentation</title>
     <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
@@ -38,7 +38,7 @@
         </button>
         <a class="navbar-brand" href="../index.html"><span><img src="../_static/yasa_128x128.png"></span>
           yasa</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -89,6 +89,7 @@ <h1>All modules for which code is available</h1>
 <ul><li><a href="yasa/hypno.html">yasa.hypno</a></li>
 <li><a href="yasa/main.html">yasa.main</a></li>
 <li><a href="yasa/others.html">yasa.others</a></li>
+<li><a href="yasa/plotting.html">yasa.plotting</a></li>
 <li><a href="yasa/spectral.html">yasa.spectral</a></li>
 </ul>
 

diff --git a/docs/build/html/_modules/yasa/hypno.html b/docs/build/html/_modules/yasa/hypno.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>yasa.hypno &#8212; yasa 0.1.7 documentation</title>
+    <title>yasa.hypno &#8212; yasa 0.1.8 documentation</title>
     <link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -38,7 +38,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html"><span><img src="../../_static/yasa_128x128.png"></span>
           yasa</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/build/html/_modules/yasa/main.html b/docs/build/html/_modules/yasa/main.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>yasa.main &#8212; yasa 0.1.7 documentation</title>
+    <title>yasa.main &#8212; yasa 0.1.8 documentation</title>
     <link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -38,7 +38,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html"><span><img src="../../_static/yasa_128x128.png"></span>
           yasa</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -352,7 +352,7 @@ <h1>Source code for yasa.main</h1><div class="highlight"><pre>
 <span class="sd">            you need to multiply the data by 1e6 to convert to micro-Volts</span>
 <span class="sd">            (1 V = 1,000,000 uV), e.g.:</span>
 
-<span class="sd">            .. code-block:: ruby</span>
+<span class="sd">            .. code-block:: python</span>
 
 <span class="sd">                data = raw.get_data() * 1e6  # Make sure that data is in uV</span>
 <span class="sd">    sf : float</span>
@@ -433,6 +433,9 @@ <h1>Source code for yasa.main</h1><div class="highlight"><pre>
 <span class="sd">    Notes</span>
 <span class="sd">    -----</span>
 <span class="sd">    For better results, apply this detection only on artefact-free NREM sleep.</span>
+
+<span class="sd">    For an example on how to run the detection, please refer to</span>
+<span class="sd">    https://github.com/raphaelvallat/yasa/blob/master/notebooks/01_spindles_detection.ipynb</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># Safety check</span>
     <span class="n">data</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
@@ -736,6 +739,11 @@ <h1>Source code for yasa.main</h1><div class="highlight"><pre>
 <span class="sd">            &#39;Channel&#39; : Channel name</span>
 <span class="sd">            &#39;IdxChannel&#39; : Integer index of channel in data</span>
 <span class="sd">            &#39;Stage&#39; : Sleep stage (only if hypno was provided)</span>
+
+<span class="sd">    Notes</span>
+<span class="sd">    -----</span>
+<span class="sd">    For an example of how to run the detection, please refer to</span>
+<span class="sd">    https://github.com/raphaelvallat/yasa/blob/master/notebooks/02_spindles_detection_multi.ipynb</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># Check if input data is a MNE Raw object</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">mne</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">BaseRaw</span><span class="p">):</span>
@@ -891,6 +899,9 @@ <h1>Source code for yasa.main</h1><div class="highlight"><pre>
 
 <span class="sd">    Note that the ``PTP``, ``Slope``, ``ValNegPeak`` and ``ValPosPeak`` are</span>
 <span class="sd">    all computed on the filtered signal.</span>
+
+<span class="sd">    For an example of how to run the detection, please refer to</span>
+<span class="sd">    https://github.com/raphaelvallat/yasa/blob/master/notebooks/06_sw_detection.ipynb</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># Safety check</span>
     <span class="n">data</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">)</span>
@@ -1149,6 +1160,9 @@ <h1>Source code for yasa.main</h1><div class="highlight"><pre>
 
 <span class="sd">    Note that the ``PTP``, ``Slope``, ``ValNegPeak`` and ``ValPosPeak`` are</span>
 <span class="sd">    computed on the filtered signal.</span>
+
+<span class="sd">    For an example of how to run the detection, please refer to</span>
+<span class="sd">    https://github.com/raphaelvallat/yasa/blob/master/notebooks/07_sw_detection_multi.ipynb</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># Check if input data is a MNE Raw object</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">mne</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">BaseRaw</span><span class="p">):</span>
@@ -1288,6 +1302,9 @@ <h1>Source code for yasa.main</h1><div class="highlight"><pre>
 
 <span class="sd">    Note that all the output parameters are computed on the filtered LOC and</span>
 <span class="sd">    ROC signals.</span>
+
+<span class="sd">    For an example of how to run the detection, please refer to</span>
+<span class="sd">    https://github.com/raphaelvallat/yasa/blob/master/notebooks/09_REMs_detection.ipynb</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># Safety checks</span>
     <span class="n">loc</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">loc</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float64</span><span class="p">))</span>

diff --git a/docs/build/html/_modules/yasa/others.html b/docs/build/html/_modules/yasa/others.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>yasa.others &#8212; yasa 0.1.7 documentation</title>
+    <title>yasa.others &#8212; yasa 0.1.8 documentation</title>
     <link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -38,7 +38,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html"><span><img src="../../_static/yasa_128x128.png"></span>
           yasa</a>
-        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">