GETFilterLow.hh

Go to the documentation of this file.

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

#ifndef GET_FILTER_LOW_HH
#define GET_FILTER_LOW_HH

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

#include "GETFilterCut.hh"

//======================================================================
/*! \class GETFilterLow
 *
 *  This class defines a low pass filter of order 1, with a response
 *  in Fourier space with following form:
 *    \f[
          F(f) = \frac{1}{1 + j \frac{f}{f_{0}}}
 *    \f]
 *  where \f$ f_{0} \f$ is the cut frequency.
 */
class GETFilterLow : public GETFilterCut
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETFilterLow);
  //------------------------------------------------------------

  protected:


  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETFilterLow ( GETObject & obj, double fcut = 0. );
    GETFilterLow ( u_int n = 0, double dt = 0.01, double fcut = 0. );
    GETFilterLow ( const GETFilterLow & proc );
    virtual ~GETFilterLow ( );
  //@}


  //----------------------------------------------------------
  /** @name Initialization functions */
  //@{
    virtual void  UpdateFilter ( );
  //@}

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

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


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


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