Add docstring to analyzers

diff --git a/timeside/analyzer/aubio_melenergy.py b/timeside/analyzer/aubio_melenergy.py
index 23f277db590f5f8759a9d86a3e361214c239a354..9941fca76e2eefffce5835d0082d426d94dea43e 100644 (file)
--- a/timeside/analyzer/aubio_melenergy.py
+++ b/timeside/analyzer/aubio_melenergy.py
@@ -29,6 +29,7 @@ from aubio import filterbank, pvoc
 
 
 class AubioMelEnergy(Analyzer):
+    """Aubio Mel Energy analyzer"""
     implements(IAnalyzer)
 
     def __init__(self):

diff --git a/timeside/analyzer/aubio_mfcc.py b/timeside/analyzer/aubio_mfcc.py
index 1d43c3d7210e096dd00003eb124765300b5528d9..6579c3a9ff2d0d9bb90aeb660e13d0bcfd25e87d 100644 (file)
--- a/timeside/analyzer/aubio_mfcc.py
+++ b/timeside/analyzer/aubio_mfcc.py
@@ -29,6 +29,7 @@ from aubio import mfcc, pvoc
 
 
 class AubioMfcc(Analyzer):
+    """Aubio MFCC analyzer"""
     implements(IAnalyzer)
 
     def __init__(self):

diff --git a/timeside/analyzer/aubio_pitch.py b/timeside/analyzer/aubio_pitch.py
index 9f893d26c1035ec3c2dc503e149c0108488aa1b6..cec72917cdee6ac4837f693d2e1b845ef574ae99 100644 (file)
--- a/timeside/analyzer/aubio_pitch.py
+++ b/timeside/analyzer/aubio_pitch.py
@@ -27,6 +27,7 @@ from aubio import pitch
 
 
 class AubioPitch(Analyzer):
+    """Aubio Pitch estimation analyzer"""
     implements(IAnalyzer)  # TODO check if needed with inheritance
 
     def __init__(self):

diff --git a/timeside/analyzer/aubio_specdesc.py b/timeside/analyzer/aubio_specdesc.py
index 2b9cf8214eac608341fd363e5ef26fd230bbd699..94fbbe722559b2f4faf339addb67aca1e8a7ea4d 100644 (file)
--- a/timeside/analyzer/aubio_specdesc.py
+++ b/timeside/analyzer/aubio_specdesc.py
@@ -28,6 +28,7 @@ from aubio import specdesc, pvoc
 
 
 class AubioSpecdesc(Analyzer):
+    """Aubio Spectral Descriptors collection analyzer"""
     implements(IAnalyzer)
 
     def __init__(self):

diff --git a/timeside/analyzer/aubio_temporal.py b/timeside/analyzer/aubio_temporal.py
index b1e3746a5a51e136fae5787940a83ca4e866365f..4ada85929008ac04348e62a2d48b862c307dbec0 100644 (file)
--- a/timeside/analyzer/aubio_temporal.py
+++ b/timeside/analyzer/aubio_temporal.py
@@ -29,6 +29,7 @@ import numpy
 
 
 class AubioTemporal(Analyzer):
+    """Aubio Temporal analyzer"""
     implements(IAnalyzer)
 
     def __init__(self):

diff --git a/timeside/analyzer/dc.py b/timeside/analyzer/dc.py
index 446d23ed57e7b48ff8026439d8a03e3e8db1ae96..6cf662fd57aaece6988c1a5bb6c49d75bc88b028 100644 (file)
--- a/timeside/analyzer/dc.py
+++ b/timeside/analyzer/dc.py
@@ -26,6 +26,7 @@ import numpy
 
 
 class MeanDCShift(Analyzer):
+    """Mean DC shift analyzer"""
     implements(IValueAnalyzer)
 
     @interfacedoc

diff --git a/timeside/analyzer/irit_speech_4hz.py b/timeside/analyzer/irit_speech_4hz.py
index 9f5eadb3ab1706011930c8ce83f704dcaec3f213..a8d12c33cd473a7be581431653d1eb1d64486d51 100644 (file)
--- a/timeside/analyzer/irit_speech_4hz.py
+++ b/timeside/analyzer/irit_speech_4hz.py
@@ -30,9 +30,7 @@ from scipy.signal import firwin, lfilter
 
 
 class IRITSpeech4Hz(Analyzer):
-    implements(IAnalyzer)
-    '''
-    Segmentor based on the analysis of the 4Hz energy modulation.
+    '''Speech Segmentor based on the 4Hz energy modulation analysis.
 
     Properties:
         - energy4hz            (list)          : List of the 4Hz energy by frame for the modulation computation
@@ -47,6 +45,8 @@ class IRITSpeech4Hz(Analyzer):
         - modulLen                     (float)         : Length (in second) of the modulation computation window
     '''
 
+    implements(IAnalyzer)
+
     @interfacedoc
     def setup(self, channels=None, samplerate=None, blocksize=None,
               totalframes=None):

diff --git a/timeside/analyzer/irit_speech_entropy.py b/timeside/analyzer/irit_speech_entropy.py
index fe3e1ebcdf804ec977e02abc057445099143eda4..d8eb0453092552b27a55f8e1c8262b3658662f5f 100644 (file)
--- a/timeside/analyzer/irit_speech_entropy.py
+++ b/timeside/analyzer/irit_speech_entropy.py
@@ -29,6 +29,8 @@ from scipy.ndimage.morphology import binary_opening
 
 
 class IRITSpeechEntropy(Analyzer):
+    """Speech Segmentor based on Entropy analysis."""
+
     implements(IAnalyzer)
 
     @interfacedoc

diff --git a/timeside/analyzer/level.py b/timeside/analyzer/level.py
index 96193922e86cf5712431bb133bb0d546717a9da4..fc50745b12eba5c8737def739ee88fc70c1dc46d 100644 (file)
--- a/timeside/analyzer/level.py
+++ b/timeside/analyzer/level.py
@@ -27,6 +27,7 @@ import numpy as np
 
 
 class Level(Analyzer):
+    """RMS level analyzer"""
     implements(IValueAnalyzer)
 
     @interfacedoc

diff --git a/timeside/analyzer/odf.py b/timeside/analyzer/odf.py
index 91cd1aeaa9f8e0e6a61d57a67c252e6de0c464ec..3f157fcaae9fccd9cb562714d646b112a5f8a840 100644 (file)
--- a/timeside/analyzer/odf.py
+++ b/timeside/analyzer/odf.py
@@ -29,6 +29,7 @@ from scipy import signal
 
 
 class OnsetDetectionFunction(Analyzer):
+    """Onset Detection Function analyzer"""
     implements(IAnalyzer)
 
     def __init__(self, blocksize=1024, stepsize=None):

diff --git a/timeside/analyzer/spectrogram.py b/timeside/analyzer/spectrogram.py
index 7457cf78a0660f4a47872848dc154dc60af23f63..237b2ac4c71d4b69d86f84058c3d8823aa3ca05a 100644 (file)
--- a/timeside/analyzer/spectrogram.py
+++ b/timeside/analyzer/spectrogram.py
@@ -27,6 +27,7 @@ import numpy as np
 
 
 class Spectrogram(Analyzer):
+    """Spectrogram analyzer"""
     implements(IAnalyzer)
 
     def __init__(self, blocksize=2048, stepsize=None, fft_size=None):
@@ -50,7 +51,7 @@ class Spectrogram(Analyzer):
               blocksize=None, totalframes=None):
         super(Spectrogram, self).setup(channels, samplerate,
               blocksize, totalframes)
-        
+
     @staticmethod
     @interfacedoc
     def id():

diff --git a/timeside/analyzer/vamp_plugin.py b/timeside/analyzer/vamp_plugin.py
index 7f5f65b84894e76dc988bfc64023c434f4053f01..88f3ef0793dc25e2a373c0e072ccdae15e80fd7a 100644 (file)
--- a/timeside/analyzer/vamp_plugin.py
+++ b/timeside/analyzer/vamp_plugin.py
@@ -28,6 +28,8 @@ import numpy as np
 
 
 class VampSimpleHost(Analyzer):
+    """Vamp plugins library interface analyzer"""
+
     implements(IAnalyzer)
 
     def __init__(self, plugin_list=None):

diff --git a/timeside/analyzer/waveform.py b/timeside/analyzer/waveform.py
index 0a14c76b0f35a5f237eca0a1989b0e6649077267..e5eb47822420a02a182682f58ffb0583fa01984c 100644 (file)
--- a/timeside/analyzer/waveform.py
+++ b/timeside/analyzer/waveform.py
@@ -27,6 +27,7 @@ import numpy as np
 from preprocessors import downmix_to_mono, frames_adapter
 
 class Waveform(Analyzer):
+    """Waveform analyzer"""
     implements(IAnalyzer)  # TODO check if needed with inheritance
 
     def __init__(self):

diff --git a/timeside/analyzer/yaafe.py b/timeside/analyzer/yaafe.py
index 12fac5dbd6213161fe9da87f9e3169fa0c33d1c8..54b50887a93136e843aeff824904086be61a1039 100644 (file)
--- a/timeside/analyzer/yaafe.py
+++ b/timeside/analyzer/yaafe.py
@@ -32,6 +32,7 @@ import numpy
 
 
 class Yaafe(Analyzer):
+    """Yaafe feature extraction library interface analyzer"""
     implements(IAnalyzer)
 
     def __init__(self, yaafeSpecification=None):