Switch to 0.1.7

raphaelvallat · Aug 30, 2019 · ac57657 · ac57657
1 parent 759b66c
commit ac57657
Show file tree

Hide file tree

Showing 38 changed files with 1,157 additions and 401 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: 105c21b613064f8802f7edf354e2edcd
+config: 913909f8d36e9cf6e88bd087e9f5c83a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
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.6 documentation</title>
+    <title>Overview: module code &#8212; yasa 0.1.7 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>
@@ -12,6 +12,7 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <script type="text/javascript" src="../_static/language_data.js"></script>
     <script type="text/javascript" src="../_static/copybutton.js"></script>
+    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -37,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.6</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -87,6 +88,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/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.6 documentation</title>
+    <title>yasa.hypno &#8212; yasa 0.1.7 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>
@@ -12,6 +12,7 @@
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <script type="text/javascript" src="../../_static/language_data.js"></script>
     <script type="text/javascript" src="../../_static/copybutton.js"></script>
+    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
@@ -37,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.6</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.7</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
diff --git a/docs/build/html/_modules/yasa/others.html b/docs/build/html/_modules/yasa/others.html
diff --git a/docs/build/html/_modules/yasa/spectral.html b/docs/build/html/_modules/yasa/spectral.html
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.1.6',
+    VERSION: '0.1.7',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

diff --git a/docs/build/html/api.html b/docs/build/html/api.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>API reference &#8212; yasa 0.1.6 documentation</title>
+    <title>API reference &#8212; yasa 0.1.7 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>
@@ -12,6 +12,7 @@
     <script type="text/javascript" src="_static/doctools.js"></script>
     <script type="text/javascript" src="_static/language_data.js"></script>
     <script type="text/javascript" src="_static/copybutton.js"></script>
+    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="shortcut icon" href="_static/favicon.ico"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -37,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.6</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -118,26 +119,6 @@ <h2>Detection</h2>
 </tbody>
 </table>
 </div>
-<div class="section" id="bandpower">
-<h2>Bandpower</h2>
-<table class="longtable docutils align-default">
-<colgroup>
-<col style="width: 10%" />
-<col style="width: 90%" />
-</colgroup>
-<tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/yasa.bandpower.html#yasa.bandpower" title="yasa.bandpower"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bandpower</span></code></a>(data[, sf, ch_names, hypno, …])</p></td>
-<td><p>Calculate the Welch bandpower for each channel and, if specified, for each sleep stage.</p></td>
-</tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/yasa.bandpower_from_psd.html#yasa.bandpower_from_psd" title="yasa.bandpower_from_psd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bandpower_from_psd</span></code></a>(psd, freqs[, ch_names, …])</p></td>
-<td><p>Compute the average power of the EEG in specified frequency band(s) given a pre-computed PSD.</p></td>
-</tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/yasa.stft_power.html#yasa.stft_power" title="yasa.stft_power"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stft_power</span></code></a>(data, sf[, window, step, band, …])</p></td>
-<td><p>Compute the pointwise power via STFT and interpolation.</p></td>
-</tr>
-</tbody>
-</table>
-</div>
 <div class="section" id="hypnogram">
 <h2>Hypnogram</h2>
 <table class="longtable docutils align-default">
@@ -161,8 +142,8 @@ <h2>Hypnogram</h2>
 </tbody>
 </table>
 </div>
-<div class="section" id="others">
-<h2>Others</h2>
+<div class="section" id="signal-processing">
+<h2>Signal processing</h2>
 <table class="longtable docutils align-default">
 <colgroup>
 <col style="width: 10%" />
@@ -172,12 +153,38 @@ <h2>Others</h2>
 <tr class="row-odd"><td><p><a class="reference internal" href="generated/yasa.moving_transform.html#yasa.moving_transform" title="yasa.moving_transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">moving_transform</span></code></a>(x[, y, sf, window, step, …])</p></td>
 <td><p>Moving transformation of one or two time-series.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="generated/yasa.trimbothstd.html#yasa.trimbothstd" title="yasa.trimbothstd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trimbothstd</span></code></a>(x[, cut])</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/yasa.sliding_window.html#yasa.sliding_window" title="yasa.sliding_window"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sliding_window</span></code></a>(data, sf, window[, step, axis])</p></td>
+<td><p>Calculate a sliding window of a 1D or 2D EEG signal.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/yasa.trimbothstd.html#yasa.trimbothstd" title="yasa.trimbothstd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trimbothstd</span></code></a>(x[, cut])</p></td>
 <td><p>Slices off a proportion of items from both ends of an array and then compute the sample standard deviation.</p></td>
 </tr>
 </tbody>
 </table>
 </div>
+<div class="section" id="spectral-analyses">
+<h2>Spectral analyses</h2>
+<table class="longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/yasa.bandpower.html#yasa.bandpower" title="yasa.bandpower"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bandpower</span></code></a>(data[, sf, ch_names, hypno, …])</p></td>
+<td><p>Calculate the Welch bandpower for each channel and, if specified, for each sleep stage.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/yasa.bandpower_from_psd.html#yasa.bandpower_from_psd" title="yasa.bandpower_from_psd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bandpower_from_psd</span></code></a>(psd, freqs[, ch_names, …])</p></td>
+<td><p>Compute the average power of the EEG in specified frequency band(s) given a pre-computed PSD.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/yasa.irasa.html#yasa.irasa" title="yasa.irasa"><code class="xref py py-obj docutils literal notranslate"><span class="pre">irasa</span></code></a>(data[, sf, ch_names, band, hset, …])</p></td>
+<td><p>Separate the aperiodic (= fractal, or 1/f) and oscillatory component of the power spectra of EEG data using the IRASA method.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="generated/yasa.stft_power.html#yasa.stft_power" title="yasa.stft_power"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stft_power</span></code></a>(data, sf[, window, step, band, …])</p></td>
+<td><p>Compute the pointwise power via STFT and interpolation.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
 </div>
 
 

diff --git a/docs/build/html/changelog.html b/docs/build/html/changelog.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>What’s new &#8212; yasa 0.1.6 documentation</title>
+    <title>What’s new &#8212; yasa 0.1.7 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>
@@ -12,6 +12,7 @@
     <script type="text/javascript" src="_static/doctools.js"></script>
     <script type="text/javascript" src="_static/language_data.js"></script>
     <script type="text/javascript" src="_static/copybutton.js"></script>
+    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="shortcut icon" href="_static/favicon.ico"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -37,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.6</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -86,6 +87,14 @@
 
   <div class="section" id="what-s-new">
 <span id="changelog"></span><h1>What’s new</h1>
+<div class="section" id="v0-1-7-august-2019">
+<h2>v0.1.7 (August 2019)</h2>
+<ol class="loweralpha simple">
+<li><p>Added <a class="reference internal" href="generated/yasa.sliding_window.html#yasa.sliding_window" title="yasa.sliding_window"><code class="xref py py-func docutils literal notranslate"><span class="pre">yasa.sliding_window()</span></code></a> function.</p></li>
+<li><p>Added <a class="reference internal" href="generated/yasa.irasa.html#yasa.irasa" title="yasa.irasa"><code class="xref py py-func docutils literal notranslate"><span class="pre">yasa.irasa()</span></code></a> function.</p></li>
+<li><p>Reorganized code into several sub-files for readability (internal changes with no effect on user experience).</p></li>
+</ol>
+</div>
 <div class="section" id="v0-1-6-august-2019">
 <h2>v0.1.6 (August 2019)</h2>
 <ol class="loweralpha simple">

diff --git a/docs/build/html/contributing.html b/docs/build/html/contributing.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>Contribute to YASA &#8212; yasa 0.1.6 documentation</title>
+    <title>Contribute to YASA &#8212; yasa 0.1.7 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>
@@ -12,6 +12,7 @@
     <script type="text/javascript" src="_static/doctools.js"></script>
     <script type="text/javascript" src="_static/language_data.js"></script>
     <script type="text/javascript" src="_static/copybutton.js"></script>
+    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="shortcut icon" href="_static/favicon.ico"/>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -37,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.6</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/docs/build/html/generated/yasa.bandpower.html b/docs/build/html/generated/yasa.bandpower.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>yasa.bandpower &#8212; yasa 0.1.6 documentation</title>
+    <title>yasa.bandpower &#8212; yasa 0.1.7 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>
@@ -12,6 +12,7 @@
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <script type="text/javascript" src="../_static/language_data.js"></script>
     <script type="text/javascript" src="../_static/copybutton.js"></script>
+    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -37,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.6</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -133,6 +134,12 @@ <h1>yasa.bandpower</h1>
 (2, 3), meaning that the bandpower are sequentially calculated
 for N2 and N3 sleep. This has no effect when <code class="docutils literal notranslate"><span class="pre">hypno</span></code> is None.</p>
 </dd>
+<dt><strong>win_sec</strong><span class="classifier">int or float</span></dt><dd><p>The length of the sliding window, in seconds, used for the Welch PSD
+calculation. Ideally, this should be at least two times the inverse of
+the lower frequency of interest (e.g. for a lower frequency of interest
+of 0.5 Hz, the window length should be at least 2 * 1 / 0.5 =
+4 seconds).</p>
+</dd>
 <dt><strong>relative</strong><span class="classifier">boolean</span></dt><dd><p>If True, bandpower is divided by the total power between the min and
 max frequencies defined in <code class="docutils literal notranslate"><span class="pre">band</span></code>.</p>
 </dd>
@@ -147,7 +154,7 @@ <h1>yasa.bandpower</h1>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><dl>
-<dt><strong>bandpowers</strong><span class="classifier"><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v0.25.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a></span></dt><dd><p>Bandpower dataframe, in which each row is a channel and each column
+<dt><strong>bandpowers</strong><span class="classifier"><a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v0.25.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a></span></dt><dd><p>Bandpower dataframe, in which each row is a channel and each column
 a spectral band.</p>
 </dd>
 </dl>