Doc: reorganize doc for analyzers

diff --git a/doc/source/api/analyzer/analyzers.rst b/doc/source/api/analyzer/analyzers.rst
index 3061c55a01162ff803845a65b45db9c56f5e1679..6ea8d34b54bc2c604f712331eb93b3940d5c33cd 100644 (file)
--- a/doc/source/api/analyzer/analyzers.rst
+++ b/doc/source/api/analyzer/analyzers.rst
@@ -3,86 +3,9 @@
 ===========
 
 .. toctree::
+   :maxdepth: 3
 
-Global analyzers
-================
-
-Mean DC Shift
--------------
-.. automodule:: timeside.analyzer.dc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Level
------
-.. automodule:: timeside.analyzer.level
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Other Analyzers
-===============
-
-Spectrogram
------------
-.. automodule:: timeside.analyzer.spectrogram
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-
-External librairies
-===================
-
-Aubio
------
-**aubio** is a tool designed for the extraction of annotations from audio signals. Its features include segmenting a sound file before each of its attacks, performing pitch detection, tapping the beat and producing midi streams from live audio.
-See http://aubio.org/
-
-
-Aubio Melenergy
-~~~~~~~~~~~~~~~
-.. automodule:: timeside.analyzer.externals.aubio_melenergy
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-aubio_mfcc
-~~~~~~~~~~
-.. automodule:: timeside.analyzer.externals.aubio_mfcc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-aubio_pitch
-~~~~~~~~~~~
-.. automodule:: timeside.analyzer.externals.aubio_pitch
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-aubio_specdesc
-~~~~~~~~~~~~~~
-.. automodule:: timeside.analyzer.externals.aubio_specdesc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-aubio_temporal
-~~~~~~~~~~~~~~
-.. automodule:: timeside.analyzer.externals.aubio_temporal  
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-Yaafe
------
-.. automodule:: timeside.analyzer.externals.yaafe
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   Timeside Core Analyzers <core_analyzers>
+   Analyzers from external librairies <ext_analyzers>
+  
 

diff --git a/doc/source/api/analyzer/core_analyzers.rst b/doc/source/api/analyzer/core_analyzers.rst
new file mode 100644 (file)
index 0000000..14805a0
--- /dev/null
+++ b/doc/source/api/analyzer/core_analyzers.rst
@@ -0,0 +1,35 @@
+=========================
+ Timeside Core Analyzers
+=========================
+
+.. toctree::
+   :maxdepth: 2
+
+
+Global analyzers
+================
+
+Mean DC Shift
+-------------
+.. automodule:: timeside.analyzer.dc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Level
+-----
+.. automodule:: timeside.analyzer.level
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Value Analyzers
+===============
+
+Spectrogram
+-----------
+.. automodule:: timeside.analyzer.spectrogram
+   :members:
+   :undoc-members:
+   :show-inheritance:

diff --git a/doc/source/api/analyzer/ext_analyzers.rst b/doc/source/api/analyzer/ext_analyzers.rst
new file mode 100644 (file)
index 0000000..064dee2
--- /dev/null
+++ b/doc/source/api/analyzer/ext_analyzers.rst
@@ -0,0 +1,58 @@
+===================================
+ Analyzer from External librairies
+===================================
+
+.. toctree::
+   :maxdepth: 2
+
+
+Aubio
+=====
+**aubio** is a tool designed for the extraction of annotations from audio signals. Its features include segmenting a sound file before each of its attacks, performing pitch detection, tapping the beat and producing midi streams from live audio.
+See http://aubio.org/
+
+
+Aubio Melenergy
+---------------
+.. automodule:: timeside.analyzer.externals.aubio_melenergy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Aubio MFCC
+----------
+.. automodule:: timeside.analyzer.externals.aubio_mfcc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Aubio Pitch
+-----------
+.. automodule:: timeside.analyzer.externals.aubio_pitch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Aubio Spectral Descriptors collection
+-------------------------------------
+.. automodule:: timeside.analyzer.externals.aubio_specdesc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Aubio Temporal
+--------------
+.. automodule:: timeside.analyzer.externals.aubio_temporal  
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Yaafe
+=====
+.. automodule:: timeside.analyzer.externals.yaafe
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

diff --git a/timeside/analyzer/spectrogram.py b/timeside/analyzer/spectrogram.py
index 33a34599902abf1eb5caaa28caf25081a1ce18a7..993c92f61ab9457d5d181cd255dac703198944d1 100644 (file)
--- a/timeside/analyzer/spectrogram.py
+++ b/timeside/analyzer/spectrogram.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2013 Paul Brossier <piem@piem.org>
+# Copyright (c) 2013-2014 Parisson SARL
+# Copyright (c) 2013-2014 Thomas Fillon
 
 # This file is part of TimeSide.
 
@@ -17,7 +18,7 @@
 # You should have received a copy of the GNU General Public License
 # along with TimeSide.  If not, see <http://www.gnu.org/licenses/>.
 
-# Author: Paul Brossier <piem@piem.org>
+# Author: Thomas Fillon <thomas@parisson.com>
 
 from __future__ import division
 from timeside.core import implements, interfacedoc
@@ -53,7 +54,10 @@ class Spectrogram(Analyzer):
     >>> spectrogram = get_processor('spectrogram_analyzer')(input_blocksize=2048, input_stepsize=1024)
     >>> pipe = (decoder | spectrogram)
     >>> pipe.run()
-
+    >>> spectrogram.results.keys()
+    ['spectrogram_analyzer']
+    >>> result = spectrogram.results['spectrogram_analyzer']
+    >>> result.data.shape
 
      .. plot::
 

diff --git a/timeside/analyzer/waveform.py b/timeside/analyzer/waveform.py
index eb465c9aa97db20228767ff591b0cd3b8575ac5c..8ec647a31ca32c6ca7768013e2398b49f2544df3 100644 (file)
--- a/timeside/analyzer/waveform.py
+++ b/timeside/analyzer/waveform.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2013 Paul Brossier <piem@piem.org>
+# Copyright (c) 20013-2014 Parisson SARL
+# Copyright (c) 2013-2014 Thomas Fillon
 
 # This file is part of TimeSide.
 
@@ -17,7 +18,7 @@
 # You should have received a copy of the GNU General Public License
 # along with TimeSide.  If not, see <http://www.gnu.org/licenses/>.
 
-# Author: Paul Brossier <piem@piem.org>
+# Author: Thomas Fillon <thomas@parisson.com>
 
 from timeside.core import implements, interfacedoc
 from timeside.analyzer.core import Analyzer