GETFilterRef.hh

Go to the documentation of this file.

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

#ifndef GET_FILTER_REF_HH
#define GET_FILTER_REF_HH

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

#include "GETFilter.hh"
#include "GETObject.hh"

//======================================================================
/*! \class GETFilterRef
 *
 *  This class defines a filter adapted for a refence signal.
 *
 *  It is based on the optimal filter, considering constant noise
 *  spectral density, corresponding to the reference signal PSD at
 *  cut frequency.
 *
 *  The picture below shows the construction of such a filter for
 *  a Gauss reference signal.
 *
 *  \image html FilterGaus.png
 */
class GETFilterRef : public GETFilter
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObjectV(GETFilterRef);
  //------------------------------------------------------------

  protected:

    double      cut_frequency;    ///< Filter cut frequency
    GETSample   ref_signal;       ///< Reference Gaus signal

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


  //----------------------------------------------------------
  /** @name Initialization functions */
  //@{
    virtual void  Init ( u_int n, double dt );
    virtual void  SetCutFrequency ( double fcut );

    /*! Compute the reference and the filter sample.*/
    virtual void  UpdateFilter ( ) = 0;

    double        GetCutFrequency  ( );     // inline
    GETSample   & GetReference     ( );     // inline
  //@}

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

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


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


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