renamed filter (#52)

CHANGELOG.rst

@@ -14,13 +14,13 @@ adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
 - Validation for results from tests in every module (so far many tests are
   only regarding functionality)
 
-`0.3.2 <https://pypi.org/project/dsptoolbox/0.3.2>`_ - 
+`0.3.3 <https://pypi.org/project/dsptoolbox/0.3.3>`_ - 
 ---------------------
 
 Added
 ~~~~~~~
-- added variable state filter `VSFilter` discretized with a topology-preserving
-  transform
+- added state variable filter `StateVariableFilter` discretized with a
+  topology-preserving transform
 
 Misc
 ~~~~~~

dsptoolbox/__init__.py

@@ -73,4 +73,4 @@
     "effects",
 ]
 
-__version__ = "0.3.2"
+__version__ = "0.3.3"

dsptoolbox/classes/_vsfilter.py → dsptoolbox/classes/_svfilter.py

@@ -1,5 +1,6 @@
 """
-Variable-State filter topology-Preserving (trapezoidal integrators) 2-Pole multimode filter
+State variable filter topology-Preserving (trapezoidal integrators)
+2-Pole multimode filter
 """
 
 import numpy as np
@@ -10,14 +11,14 @@
 from ..generators import dirac
 
 
-class VariableStateFilter:
-    """This is a variable state filter discretized using the
+class StateVariableFilter:
+    """This is a state variable filter discretized using the
     topology-preserving transform (trapezoidal integrator)."""
 
     def __init__(
         self, frequency_hz: float, resonance: float, sampling_rate_hz: int
     ):
-        """Construct a variable state, 2-pole multimode filter. The
+        """Construct a state variable, 2-pole multimode filter. The
         implementation is based on [1], but the resonance parameter is here
         equal to 2R.
 

dsptoolbox/filterbanks/__init__.py

@@ -40,7 +40,7 @@
 
 from ..classes._lattice_ladder_filter import LatticeLadderFilter
 from ..classes._phaseLinearizer import PhaseLinearizer
-from ..classes._vsfilter import VariableStateFilter
+from ..classes._svfilter import StateVariableFilter
 
 __all__ = [
     "linkwitz_riley_crossovers",
@@ -52,5 +52,5 @@
     "complementary_fir_filter",
     "LatticeLadderFilter",
     "PhaseLinearizer",
-    "VariableStateFilter",
+    "StateVariableFilter",
 ]

tests/test_filterbanks.py

@@ -169,7 +169,7 @@ def test_phase_linearizer(self):
 
     def test_VSFilter(self):
         fs_hz = 10_000
-        f = dsp.filterbanks.VariableStateFilter(500, np.sqrt(2), fs_hz)
+        f = dsp.filterbanks.StateVariableFilter(500, np.sqrt(2), fs_hz)
 
         n = dsp.generators.noise(sampling_rate_hz=fs_hz)
         f.filter_signal(n)