GETFilterSmooth.hh

Go to the documentation of this file.

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

#ifndef GET_FILTER_SMOOTH_HH
#define GET_FILTER_SMOOTH_HH

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

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

//======================================================================
/*! \class GETFilterSmooth
 *
 *  This class defines a smoothing filter by convolution with a
 *  Gauss function.
 */
class GETFilterSmooth : public GETFilter
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETFilterSmooth);
  //------------------------------------------------------------

  protected:

    double  fwhm;       ///< Gauss function FWHM

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


  //----------------------------------------------------------
  /** @name Initialization functions */
  //@{
    virtual void  SetWidth ( double wid );
    double        GetWidth ( ) const;   // inline
    virtual void  SetSigma ( double sig );
    double        GetSigma ( ) const;   // inline

    virtual void  Init ( u_int n, double dt );

    virtual void  UpdateFilter ( );

  //@}

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

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


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


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