Version 4.0

include/TwoZero.h

@@ -1,27 +1,74 @@
-/*******************************************/
-/*  Two Zero Filter Class,                 */
-/*  by Perry R. Cook, 1995-96              */ 
-/*  See books on filters to understand     */
-/*  more about how this works.  Nothing    */
-/*  out of the ordinary in this version.   */
-/*******************************************/
-
-#if !defined(__TwoZero_h)
-#define __TwoZero_h
-
-#include "Filter.h"
-
-class TwoZero : public Filter
-{
-  protected:  
-    MY_FLOAT zeroCoeffs[2];
-  public:
-    TwoZero();
-    ~TwoZero();
-    void clear();
-    void setZeroCoeffs(MY_FLOAT *coeffs);
-    void setGain(MY_FLOAT aValue);
-    MY_FLOAT tick(MY_FLOAT sample);
-};
-
-#endif
+/***************************************************/
+/*! \class TwoZero
+    \brief STK two-zero filter class.
+
+    This protected Filter subclass implements
+    a two-zero digital filter.  A method is
+    provided for creating a "notch" in the
+    frequency response while maintaining a
+    constant filter gain.
+
+    by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
+*/
+/***************************************************/
+
+#if !defined(__TWOZERO_H)
+#define __TWOZERO_H
+
+#include "Filter.h"
+
+class TwoZero : protected Filter
+{
+ public:
+  //! Default constructor creates a second-order pass-through filter.
+  TwoZero();
+
+  //! Class destructor.
+  ~TwoZero();
+
+  //! Clears the internal states of the filter.
+  void clear(void);
+
+  //! Set the b[0] coefficient value.
+  void setB0(MY_FLOAT b0);
+
+  //! Set the b[1] coefficient value.
+  void setB1(MY_FLOAT b1);
+
+  //! Set the b[2] coefficient value.
+  void setB2(MY_FLOAT b2);
+
+  //! Sets the filter coefficients for a "notch" at \e frequency (in Hz).
+  /*!
+    This method determines the filter coefficients corresponding to
+    two complex-conjugate zeros with the given \e frequency (in Hz)
+    and \e radius from the z-plane origin.  The coefficients are then
+    normalized to produce a maximum filter gain of one (independent of
+    the filter \e gain parameter).  The resulting filter frequency
+    response has a "notch" or anti-resonance at the given \e
+    frequency.  The closer the zeros are to the unit-circle (\e radius
+    close to or equal to one), the narrower the resulting notch width.
+  */
+  void setNotch(MY_FLOAT frequency, MY_FLOAT radius);
+
+  //! Set the filter gain.
+  /*!
+    The gain is applied at the filter input and does not affect the
+    coefficient values.  The default gain value is 1.0.
+   */
+  void setGain(MY_FLOAT theGain);
+
+  //! Return the current filter gain.
+  MY_FLOAT getGain(void) const;
+
+  //! Return the last computed output value.
+  MY_FLOAT lastOut(void) const;
+
+  //! Input one sample to the filter and return one output.
+  MY_FLOAT tick(MY_FLOAT sample);
+
+  //! Input \e vectorSize samples to the filter and return an equal number of outputs in \e vector.
+  MY_FLOAT *tick(MY_FLOAT *vector, unsigned int vectorSize);
+};
+
+#endif