GETFilterGaus.hh

Go to the documentation of this file.

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

#ifndef GET_FILTER_GAUS_HH
#define GET_FILTER_GAUS_HH

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

#include "GETFilterRef.hh"

//======================================================================
/*! \class GETFilterGaus
 *
 *  This class defines a filter adapted for Gauss signal.
 *
 *  It is based on the optimal filter, considering constant noise
 *  spectral density, corresponding to the reference signal PSD at
 *  cut frequency (see figure for GETFilterRef).
 *
 */
class GETFilterGaus : public GETFilterRef
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETFilterGaus);
  //------------------------------------------------------------

  protected:
    double          ref_fwhm;         ///< Reference signal width (FWHM)

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


  //----------------------------------------------------------
  /** @name Initialization functions */
  //@{
    virtual void  Init ( u_int n, double dt );
    virtual void  SetReference ( double wid, double fcut = 0.L );
    virtual void  UpdateFilter ( );

    double        GetReferenceFWHM ( );     // inline
  //@}

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

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


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


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