From: Thomas Fillon <thomas@parisson.com>
Date: Mon, 27 Jan 2014 15:27:21 +0000 (+0000)
Subject: Add docstring to analyzers
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=e6129b719d7fa38cc87c5addd332e2816d2f2925;p=timeside-diadems.git

Add docstring to analyzers
---

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