Merge branch 'splweighting_sos' into slm_c_impl

lasp/filter/soundpressureweighting.py

@@ -7,14 +7,18 @@ Description: Filter design for frequency weighting curves (i.e. A and C
 weighting)
 """
 from .fir_design import freqResponse, arbitrary_fir_design
+from scipy.signal import bilinear_zpk, zpk2sos
 import numpy as np
 
-__all__ = ['A', 'C', 'A_fir_design', 'C_fir_design',
-           'show_Afir', 'show_Cfir']
+__all__ = ['SPLFilterDesigner']
 
+
+class SPLFilterDesigner:
     fr = 1000.
     fL = 10**1.5
     fH = 10**3.9
+
+
     fLsq = fL**2
     fHsq = fH**2
     frsq = fr**2
@@ -29,20 +33,25 @@ f1 = np.sqrt((-b-np.sqrt(b**2-4*c))/2)
     f4 = np.sqrt((-b+np.sqrt(b**2-4*c))/2)
     f4sq = f4**2
 
-
-def A_uncor(f):
+    def _A_uncor(self, f):
         """
         Computes the uncorrected frequency response of the A-filter
+
+        Args:
+            f: Frequency (array, float)
+
+        Returns:
+            Linear filter transfer function
         """
         fsq = f**2
-    num = f4sq*fsq**2
-    denom1 = (fsq+f1**2)
-    denom2 = np.sqrt((fsq+f2**2)*(fsq+f3**2))*(fsq+f4sq)
+        num = self.f4sq*fsq**2
+        denom1 = (fsq+self.f1**2)
+        denom2 = np.sqrt((fsq+self.f2**2)*(fsq+self.f3**2))*(fsq+self.f4sq)
 
         return (num/(denom1*denom2))
 
 
-def A(f):
+    def A(self, f):
         """
         Computes the linear A-weighting freqency response. Hence, to obtain
         A-weighted values, the *amplitude* need to be multiplied with this value.
@@ -54,36 +63,37 @@ def A(f):
         Returns:
             A(f) for each frequency
         """
-    Auncor = A_uncor(f)
-    A1000 = A_uncor(1000.)
+        Auncor = self._A_uncor(f)
+        A1000 = self._A_uncor(self.fr)
         return Auncor/A1000
 
 
-def C_uncor(f):
+    def _C_uncor(self, f):
         """
         Computes the uncorrected frequency response of the C-filter
         """
         fsq = f**2
-    num = f4sq*fsq
-    denom1 = (fsq+f1**2)
-    denom2 = (fsq+f4**2)
+        num = self.f4sq*fsq
+        denom1 = (fsq+self.f1**2)
+        denom2 = (fsq+self.f4**2)
         return num/(denom1*denom2)
 
 
-def C(f):
+    def C(self, f):
         """
         Computes the linear A-weighting freqency response
         """
-    Cuncor = C_uncor(f)
-    C1000 = C_uncor(1000.)
+        Cuncor = self._C_uncor(f)
+        C1000 = self._C_uncor(self.fr)
         return Cuncor/C1000
 
 
-def A_fir_design():
-    fs = 48000.
+    def A_fir_design(self, fs):
+
+        assert int(fs) == 48000
         freq_design = np.linspace(0, 17e3, 3000)
         freq_design[-1] = fs/2
-    amp_design = A(freq_design)
+        amp_design = self.A(freq_design)
         amp_design[-1] = 0.
 
         L = 2048  # Filter order
@@ -92,7 +102,8 @@ def A_fir_design():
         return fir
 
 
-def C_fir_design():
+    def C_fir_design(self, fs):
+        assert int(fs) == 48000
         fs = 48000.
         freq_design = np.linspace(0, 17e3, 3000)
         freq_design[-1] = fs/2
@@ -104,54 +115,50 @@ def C_fir_design():
                                    window='rectangular')
         return fir
 
+    def C_Sos_design(self, fs):
+        """
+        Create filter coefficients of the C-weighting filter. Uses the bilinear
+        transform to convert the analog filter to a digital one.
 
-def show_Afir():
-    from asceefig.plot import Figure
+        Args:
+            fs: Sampling frequency [Hz]
 
-    fs = 48000.
-    freq_design = np.linspace(0, 17e3, 3000)
-    freq_design[-1] = fs/2
-    amp_design = A(freq_design)
-    amp_design[-1] = 0.
-    firs = []
+        Returns:
+            Sos: Second order sections
+        """
         
-    # firs.append(arbitrary_fir_design(fs,L,freq_design,amp_design,window='hamming'))
-    # firs.append(arbitrary_fir_design(fs,L,freq_design,amp_design,window='hann'))
-    firs.append(A_fir_design())
-    # from scipy.signal import iirdesign
-    # b,a = iirdesign()
-    freq_check = np.logspace(0, np.log10(fs/2), 5000)
-    f = Figure()
+        p1 = 2*np.pi*self.f1
+        p4 = 2*np.pi*self.f4
+        zeros_analog = [0,0]
+        poles_analog = [p1, p1, p4, p4]
+        k_analog = p4**2/self._C_uncor(self.fr)
 
-    f.semilogx(freq_check, 20*np.log10(A(freq_check)))
-    for fir in firs:
-        H = freqResponse(fs, freq_check, fir)
-        f.plot(freq_check, 20*np.log10(np.abs(H)))
+        z, p, k = bilinear_zpk(zeros_analog, poles_analog, k_analog, fs)
+        sos = zpk2sos(z, p, k)
+        return sos
 
-    f.fig.get_axes()[0].set_ylim(-75, 3)
+    def A_Sos_design(self, fs):
+        """
+        Create filter coefficients of the A-weighting filter. Uses the bilinear
+        transform to convert the analog filter to a digital one.
 
+        Args:
+            fs: Sampling frequency [Hz]
 
-def show_Cfir():
-    from asceefig.plot import Figure
+        Returns:
+            Sos: Second order sections
+        """
+        # Poles of A-filter 
+        p1 = 2*np.pi*self.f1
+        p2 = 2*np.pi*self.f2
+        p3 = 2*np.pi*self.f3
+        p4 = 2*np.pi*self.f4
 
-    fs = 48000.
-    freq_design = np.linspace(0, 17e3, 3000)
-    freq_design[-1] = fs/2
-    amp_design = C(freq_design)
-    amp_design[-1] = 0.
-    firs = []
+        zeros_analog = [0,0,0,0]
+        poles_analog = [p1, p1, p2, p3, p4, p4]
+        k_analog = p4**2/self._A_uncor(self.fr)
 
-    # firs.append(arbitrary_fir_design(fs,L,freq_design,amp_design,window='hamming'))
-    # firs.append(arbitrary_fir_design(fs,L,freq_design,amp_design,window='hann'))
-    firs.append(C_fir_design())
-    # from scipy.signal import iirdesign
-    # b,a = iirdesign()
-    freq_check = np.logspace(0, np.log10(fs/2), 5000)
-    f = Figure()
+        z, p, k = bilinear_zpk(zeros_analog, poles_analog, k_analog, fs)
+        sos = zpk2sos(z, p, k)
+        return sos
 
-    f.semilogx(freq_check, 20*np.log10(C(freq_check)))
-    for fir in firs:
-        H = freqResponse(fs, freq_check, fir)
-        f.plot(freq_check, 20*np.log10(np.abs(H)))
-
-    f.fig.get_axes()[0].set_ylim(-30, 1)

lasp/lasp_weighcal.py

@@ -5,7 +5,7 @@ Weighting and calibration filter in one
 @author: J.A. de Jong - ASCEE
 """
 from .lasp_common import FreqWeighting
-from .filter import (A, C, arbitrary_fir_design, freqResponse as frp)
+from .filter import SPLFilterDesigner
 from lasp.lasp_config import ones, empty
 from .wrappers import FilterBank
 import numpy as np