GETFilterModifier.hh

Go to the documentation of this file.

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

#ifndef GET_FILTER_MODIFIER_HH
#define GET_FILTER_MODIFIER_HH

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

#include "GETSignalModifier.hh"
#include "GETFilter.hh"

//======================================================================
/*! \class GETFilterModifier
 *
 *  This class defines a signal correction process using a filter
 *  process.
 *
 *  It can then be used to apply a filter, considered as output signal
 *  correction.
 */
class GETFilterModifier : public GETSignalModifier
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETFilterModifier);
  //------------------------------------------------------------

  protected:
    GETFilter * filter;     ///< Pointer to the filter process

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

  //----------------------------------------------------------
  /** @name Process parameters */
  //@{
    virtual void              SetFilter  ( GETFilter * filt );
    virtual const GETFilter * GetFilter  ( ) const; // inline
    virtual       GETFilter * GetFilter  ( );       // inline

  //@}

  //----------------------------------------------------------
  /** @name Signal processing */
  //@{
    virtual GETSample * ProcessSample ( GETSample  & sample,
                                        GETSample  & result,
                                        GETChannel & channel );
  //@}

  //----------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  public:
    /*! for use within ROOT.*/
    ClassDef(GETFilterModifier,0);
  //@}
};


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


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