GETFilterAgetGaus.hh

Go to the documentation of this file.

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

#ifndef GET_FILTER_AGET_GAUS_HH
#define GET_FILTER_AGET_GAUS_HH

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

#include "GETFilterRef.hh"

//======================================================================
/*! \class GETFilterAgetGaus
 *
 *  This class defines a filter adapted for AGet analytical response
 *  function to a Gaus input 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 GETFilterAgetGaus : public GETFilterRef
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETFilterAgetGaus);
  //------------------------------------------------------------

  protected:
    double          ref_fwhm;         ///< Reference signal width (FWHM)
    double          peaking_time;     ///< Reference response peaking time (us)

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


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

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

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

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


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


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