From: Thomas Fillon Date: Mon, 27 Jan 2014 15:27:21 +0000 (+0000) Subject: Add docstring to analyzers X-Git-Tag: 0.5.3~6^2~1 X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=8eaeff49c7a9b9c9d72be60ed175b8fb3d9cdaf8;p=timeside.git Add docstring to analyzers --- diff --git a/timeside/analyzer/aubio_melenergy.py b/timeside/analyzer/aubio_melenergy.py index 23f277d..9941fca 100644 --- 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 1d43c3d..6579c3a 100644 --- 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 9f893d2..cec7291 100644 --- 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 2b9cf82..94fbbe7 100644 --- 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 b1e3746..4ada859 100644 --- 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 446d23e..6cf662f 100644 --- 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 9f5eadb..a8d12c3 100644 --- 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 fe3e1eb..d8eb045 100644 --- 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 9619392..fc50745 100644 --- 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 91cd1ae..3f157fc 100644 --- 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 7457cf7..237b2ac 100644 --- 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 7f5f65b..88f3ef0 100644 --- 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 0a14c76..e5eb478 100644 --- 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 12fac5d..54b5088 100644 --- 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):