[DOC] Improving reference documentation: pytta.ImpulsiveResponse

Author: mtslazarin

pytta/classes.py

@@ -661,10 +661,7 @@ def _calc_spectrogram( self, timeData = None,  overlap=0.5, winType='hann', winS
 
 ##%% ImpulsiveResponse class
 class ImpulsiveResponse(PyTTaObj):
-    """
-    ImpulsiveResponse
-    =================
-    
+    """    
         This class is a container of SignalObj, intended to provide a system's
         impulsive response along with the excitation signal and the recorded 
         signal used to compute the response.
@@ -687,6 +684,7 @@ class ImpulsiveResponse(PyTTaObj):
             
         Creation parameters:
         --------------------    
+        
             * excitation (SignalObj):
                 The signal-like object used as excitation signal on the
                 measurement-like object;
@@ -766,6 +764,7 @@ class ImpulsiveResponse(PyTTaObj):
 
         Attributes:
         -----------
+        
             * excitation | inputSignal:
                 Both names are valid, returns the excitation signal given as 
                 parameter at the object instantiation;

pytta/generate.py

@@ -31,7 +31,7 @@
     For further information see the specific function documentation
 """
 
-#%% Import modules
+##%% Import modules
 from .classes import SignalObj, RecMeasure, FRFMeasure, PlayRecMeasure
 from pytta import default
 from scipy import signal
@@ -69,7 +69,7 @@ def sin(Arms = 0.5,
             
         * samplingRate (int) (optional):
             Nothing to say;
-        
+            
     """
     if fftDegree != None:
         timeLength = 2**(fftDegree)/samplingRate
@@ -364,15 +364,15 @@ def measurement(kind = 'playrec',
 
 			Same as for (kind='playrec')
     """
-#%% Default Parameters
+##%% Default Parameters
     if freqMin is None: freqMin = default.freqMin
     if freqMax is None: freqMax = default.freqMax
     if samplingRate is None: samplingRate = default.samplingRate
     if device is None: device = default.device
     if inChannel is None: inChannel = default.inChannel
     if outChannel is None: outChannel = default.outChannel
 
-#%% Kind REC
+##%% Kind REC
     if kind in ['rec','record','recording','r']:
         recordObj = RecMeasure(samplingRate = samplingRate,
                             freqMin = freqMin,
@@ -399,7 +399,7 @@ def measurement(kind = 'playrec',
             recordObj.fftDegree = default.fftDegree
         return recordObj
 
-#%% Kind PLAYREC    
+##%% Kind PLAYREC    
     elif kind in ['playrec','playbackrecord','pr']:
         if ('excitation' in kwargs) or args:
             signalIn = kwargs.get('excitation') or args[0]
@@ -417,7 +417,7 @@ def measurement(kind = 'playrec',
                                     **kwargs)
         return playRecObj
 
-#%% Kind FRF    
+##%% Kind FRF    
     elif kind in ['tf','frf','transferfunction','freqresponse']:
         if ('excitation' in kwargs) or args:
             signalIn = kwargs.get('excitation') or args[0]
@@ -434,5 +434,4 @@ def measurement(kind = 'playrec',
                             outChannel = outChannel,
                             **kwargs
                             )
-        return frfObj
-
+        return frfObj