From a5c5dc8cc0101568aa9576e72f7263002207c1e7 Mon Sep 17 00:00:00 2001 From: Thomas Fillon Date: Tue, 21 Oct 2014 14:38:09 +0200 Subject: [PATCH] Doc: reorganize doc for analyzers --- doc/source/api/analyzer/analyzers.rst | 85 +--------------------- doc/source/api/analyzer/core_analyzers.rst | 35 +++++++++ doc/source/api/analyzer/ext_analyzers.rst | 58 +++++++++++++++ timeside/analyzer/spectrogram.py | 10 ++- timeside/analyzer/waveform.py | 5 +- 5 files changed, 107 insertions(+), 86 deletions(-) create mode 100644 doc/source/api/analyzer/core_analyzers.rst create mode 100644 doc/source/api/analyzer/ext_analyzers.rst diff --git a/doc/source/api/analyzer/analyzers.rst b/doc/source/api/analyzer/analyzers.rst index 3061c55..6ea8d34 100644 --- 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 + Analyzers from external librairies + diff --git a/doc/source/api/analyzer/core_analyzers.rst b/doc/source/api/analyzer/core_analyzers.rst new file mode 100644 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 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 33a3459..993c92f 100644 --- a/timeside/analyzer/spectrogram.py +++ b/timeside/analyzer/spectrogram.py @@ -1,6 +1,7 @@ # -*- coding: utf-8 -*- # -# Copyright (c) 2013 Paul Brossier +# 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 . -# Author: Paul Brossier +# Author: Thomas Fillon 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 eb465c9..8ec647a 100644 --- a/timeside/analyzer/waveform.py +++ b/timeside/analyzer/waveform.py @@ -1,6 +1,7 @@ # -*- coding: utf-8 -*- # -# Copyright (c) 2013 Paul Brossier +# 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 . -# Author: Paul Brossier +# Author: Thomas Fillon from timeside.core import implements, interfacedoc from timeside.analyzer.core import Analyzer -- 2.39.5