bugs in documentation fixed

dokato · Aug 22, 2015 · 81ade57 · 81ade57
1 parent 90f9e84
commit 81ade57
Show file tree

Hide file tree

Showing 23 changed files with 143 additions and 83 deletions.
diff --git a/connectivipy/__init__.py b/connectivipy/__init__.py
@@ -7,4 +7,4 @@
 from mvar.fitting import mvar_gen, mvar_gen_inst, fitting_algorithms
 from plot import plot_conn
 
-__version__ = '0.34'
+__version__ = '0.36'
diff --git a/doc/conf.py b/doc/conf.py
@@ -60,9 +60,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.34'
+version = '0.36'
 # The full version, including alpha/beta/rc tags.
-release = '0.34a'
+release = '0.36a'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/html/.buildinfo b/doc/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: e70d74eaa1b3c4d692d123a52fe40021
+config: 55e66fb85a7e79569c7fc344b8d72edd
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/html/_modules/conn.html b/doc/html/_modules/conn.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>conn &mdash; ConnectiviPy 0.34a documentation</title>
+    <title>conn &mdash; ConnectiviPy 0.36a documentation</title>
 
     <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.34a',
+        VERSION:     '0.36a',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <link rel="top" title="ConnectiviPy 0.34a documentation" href="../index.html" />
+    <link rel="top" title="ConnectiviPy 0.36a documentation" href="../index.html" />
     <link rel="up" title="Module code" href="index.html" /> 
   </head>
   <body role="document">
@@ -34,7 +34,7 @@
             <img class="logo" src="../_static/connpy.png" alt="Logo"/>
           </a></p>
         <div class="headertitle"><a
-          href="../index.html">ConnectiviPy 0.34a documentation</a></div>
+          href="../index.html">ConnectiviPy 0.36a documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |

diff --git a/doc/html/_modules/data.html b/doc/html/_modules/data.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>data &mdash; ConnectiviPy 0.34a documentation</title>
+    <title>data &mdash; ConnectiviPy 0.36a documentation</title>
 
     <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.34a',
+        VERSION:     '0.36a',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <link rel="top" title="ConnectiviPy 0.34a documentation" href="../index.html" />
+    <link rel="top" title="ConnectiviPy 0.36a documentation" href="../index.html" />
     <link rel="up" title="Module code" href="index.html" /> 
   </head>
   <body role="document">
@@ -34,7 +34,7 @@
             <img class="logo" src="../_static/connpy.png" alt="Logo"/>
           </a></p>
         <div class="headertitle"><a
-          href="../index.html">ConnectiviPy 0.34a documentation</a></div>
+          href="../index.html">ConnectiviPy 0.36a documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |
@@ -84,10 +84,12 @@ <h1>Source code for data</h1><div class="highlight"><pre>
 <span class="sd">          other information about the data</span>
 <span class="sd">    &#39;&#39;&#39;</span>
     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">fs</span><span class="o">=</span><span class="mf">1.</span><span class="p">,</span> <span class="n">chan_names</span><span class="o">=</span><span class="p">[],</span> <span class="n">data_info</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">):</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">__data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_file</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">data_info</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">__fs</span> <span class="o">=</span> <span class="n">fs</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">__data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_load_file</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">data_info</span><span class="p">)</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">__data</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="nb">len</span><span class="p">(</span><span class="n">chan_names</span><span class="p">):</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">__channames</span> <span class="o">=</span> <span class="n">chan_names</span>
+        <span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="s">&#39;_Data__fs&#39;</span><span class="p">):</span>
+            <span class="k">pass</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">__channames</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;x&quot;</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__chans</span><span class="p">)]</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">data_info</span> <span class="o">=</span> <span class="n">data_info</span>
@@ -101,9 +103,7 @@ <h1>Source code for data</h1><div class="highlight"><pre>
 <span class="sd">        Args:</span>
 <span class="sd">          *data_what* : str/numpy.array</span>
 <span class="sd">              path to file with appropieate format or numpy data array</span>
-<span class="sd">          *dt_type* : str</span>
-<span class="sd">              file extension (mat,)</span>
-<span class="sd">          *dt_type* = &#39;&#39; : str</span>
+<span class="sd">          *data_info* = &#39;&#39; : str</span>
 <span class="sd">              additional file with data settings if needed</span>
 <span class="sd">        Returns:</span>
 <span class="sd">          *data* : np.array</span>
@@ -112,15 +112,18 @@ <h1>Source code for data</h1><div class="highlight"><pre>
         <span class="k">if</span> <span class="n">dt_type</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
             <span class="n">data</span> <span class="o">=</span> <span class="n">data_what</span>
         <span class="k">elif</span> <span class="n">dt_type</span> <span class="o">==</span> <span class="nb">str</span><span class="p">:</span>
+            <span class="n">dt_type</span> <span class="o">=</span> <span class="n">data_what</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="c"># catch extension of file</span>
             <span class="k">if</span> <span class="n">dt_type</span> <span class="o">==</span> <span class="s">&#39;mat&#39;</span><span class="p">:</span>
                 <span class="n">mat_dict</span> <span class="o">=</span> <span class="n">si</span><span class="o">.</span><span class="n">loadmat</span><span class="p">(</span><span class="n">data_what</span><span class="p">)</span>
                 <span class="k">if</span> <span class="n">data_info</span><span class="p">:</span>
                     <span class="n">key</span> <span class="o">=</span> <span class="n">data_info</span>
                 <span class="k">else</span><span class="p">:</span>
-                    <span class="n">key</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+                    <span class="n">key</span> <span class="o">=</span> <span class="n">data_what</span><span class="p">[:</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;/&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
                 <span class="n">data</span> <span class="o">=</span> <span class="n">mat_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
-            <span class="k">if</span> <span class="n">data_info</span><span class="o">==</span><span class="s">&#39;sml&#39;</span><span class="p">:</span>
-                <span class="n">data</span><span class="p">,</span> <span class="n">sml</span> <span class="o">=</span> <span class="n">signalml_loader</span><span class="p">(</span><span class="n">data_what</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;.&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span>
+            <span class="k">if</span> <span class="n">dt_type</span><span class="o">==</span><span class="s">&#39;raw&#39;</span> <span class="ow">and</span> <span class="n">data_info</span><span class="o">==</span><span class="s">&#39;sml&#39;</span><span class="p">:</span>
+                <span class="n">data</span><span class="p">,</span> <span class="n">sml</span> <span class="o">=</span> <span class="n">signalml_loader</span><span class="p">(</span><span class="n">data_what</span><span class="p">[:</span><span class="o">-</span><span class="mi">4</span><span class="p">])</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">__fs</span> <span class="o">=</span> <span class="n">sml</span><span class="p">[</span><span class="s">&#39;samplingFrequency&#39;</span><span class="p">]</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">__channames</span> <span class="o">=</span> <span class="n">sml</span><span class="p">[</span><span class="s">&#39;channelNames&#39;</span><span class="p">]</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">smldict</span> <span class="o">=</span> <span class="n">sml</span> <span class="c"># here SignalML data is stored</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="k">return</span> <span class="bp">False</span>

diff --git a/doc/html/_modules/index.html b/doc/html/_modules/index.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>Overview: module code &mdash; ConnectiviPy 0.34a documentation</title>
+    <title>Overview: module code &mdash; ConnectiviPy 0.36a documentation</title>
 
     <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.34a',
+        VERSION:     '0.36a',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
     <script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <link rel="top" title="ConnectiviPy 0.34a documentation" href="../index.html" /> 
+    <link rel="top" title="ConnectiviPy 0.36a documentation" href="../index.html" /> 
   </head>
   <body role="document">
     <div class="header-wrapper" role="banner">
@@ -33,7 +33,7 @@
             <img class="logo" src="../_static/connpy.png" alt="Logo"/>
           </a></p>
         <div class="headertitle"><a
-          href="../index.html">ConnectiviPy 0.34a documentation</a></div>
+          href="../index.html">ConnectiviPy 0.36a documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |

diff --git a/doc/html/_modules/load/loaders.html b/doc/html/_modules/load/loaders.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>load.loaders &mdash; ConnectiviPy 0.34a documentation</title>
+    <title>load.loaders &mdash; ConnectiviPy 0.36a documentation</title>
 
     <link rel="stylesheet" href="../../_static/agogo.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.34a',
+        VERSION:     '0.36a',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <link rel="top" title="ConnectiviPy 0.34a documentation" href="../../index.html" />
+    <link rel="top" title="ConnectiviPy 0.36a documentation" href="../../index.html" />
     <link rel="up" title="Module code" href="../index.html" /> 
   </head>
   <body role="document">
@@ -34,7 +34,7 @@
             <img class="logo" src="../../_static/connpy.png" alt="Logo"/>
           </a></p>
         <div class="headertitle"><a
-          href="../../index.html">ConnectiviPy 0.34a documentation</a></div>
+          href="../../index.html">ConnectiviPy 0.36a documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |
@@ -112,7 +112,6 @@ <h1>Source code for load.loaders</h1><div class="highlight"><pre>
         <span class="n">calibr_coef</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">calibr_gain</span><span class="o">.</span><span class="n">getElementsByTagName</span><span class="p">(</span><span class="s">&#39;rs:&#39;</span><span class="o">+</span><span class="s">&#39;calibrationParam&#39;</span><span class="p">)[</span><span class="n">j</span><span class="p">]</span><span class="o">.</span><span class="n">childNodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">data</span><span class="p">))</span>
     <span class="n">xml_data</span><span class="p">[</span><span class="s">&#39;channelNames&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">chann_names</span> 
     <span class="n">xml_data</span><span class="p">[</span><span class="s">&#39;calibrationCoef&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">calibr_coef</span> 
-
     <span class="k">return</span> <span class="n">xml_data</span></div>
 </pre></div>
 

diff --git a/doc/html/_modules/mvar/comp.html b/doc/html/_modules/mvar/comp.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>mvar.comp &mdash; ConnectiviPy 0.34a documentation</title>
+    <title>mvar.comp &mdash; ConnectiviPy 0.36a documentation</title>
 
     <link rel="stylesheet" href="../../_static/agogo.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.34a',
+        VERSION:     '0.36a',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <link rel="top" title="ConnectiviPy 0.34a documentation" href="../../index.html" />
+    <link rel="top" title="ConnectiviPy 0.36a documentation" href="../../index.html" />
     <link rel="up" title="Module code" href="../index.html" /> 
   </head>
   <body role="document">
@@ -34,7 +34,7 @@
             <img class="logo" src="../../_static/connpy.png" alt="Logo"/>
           </a></p>
         <div class="headertitle"><a
-          href="../../index.html">ConnectiviPy 0.34a documentation</a></div>
+          href="../../index.html">ConnectiviPy 0.36a documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |