GETFilterLowN.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETFilterLowN.hh
 *
 *  Include file for the GETFilterLowN class.
 */
//======================================================================

#ifndef GET_FILTER_LOW_N_HH
#define GET_FILTER_LOW_N_HH

//----------------------------------------------------------------------

#include "GETFilterLow2.hh"

//======================================================================
/*! \class GETFilterLowN
 *
 *  This class defines a low pass filter of order N.
 *  It is constructed as a composition of first and second order filters:
 *  - if <b>N</b> is even, <b>N/2</b> second order filters;
 *  - if <b>N</b> is odd, <b>(N-1)/2</b> second order filters and a first
 *    order filter.
 *
 *  All the filters used in the construction have the same cut frequency,
 *  and the second order filters have the same quality factor <b>Q</b>
 *  (see GETFilterLow2).
 *  For filters with different parameters, it is possible to use the
 *  base filter class GETFilter, with composition constructor.
 */
class GETFilterLowN : public GETFilterLow2
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETFilterLowN);
  //------------------------------------------------------------

  protected:

    u_int     order;              ///< Filter order

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETFilterLowN ( u_int n = 0, double dt = 0.01L,
                    u_int nf = 3,
                    double fcut = 0.L,
                    double q = 0.7071067811865475244008443621048490L );
    GETFilterLowN ( const GETFilterLowN & proc );
    virtual ~GETFilterLowN ( );
  //@}


  //----------------------------------------------------------
  /** @name Initialization functions */
  //@{
    virtual void  SetOrder ( u_int nf );
    u_int         GetOrder ( ) const;   // inline

    virtual void  UpdateFilter ( );
  //@}

  //----------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  public:

    /*! for use within ROOT.*/
    ClassDef(GETFilterLowN,0);
  //@}
};


//----------------------------------------------------------------------
//  Inline functions
#include "icc/GETFilterLowN.icc"


//======================================================================
#endif