GETSignalModifier.hh

Go to the documentation of this file.

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

#ifndef GET_SIGNAL_MODIFIER_HH
#define GET_SIGNAL_MODIFIER_HH

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

#include "GETCommon.hh"
#include "GETProcess.hh"

//======================================================================
/*! \class GETSignalModifier
 *
 *  GETSignalModifier is the base class for modification of signal
 *  samples (noise, baseline corrections,...).
 */
class GETSignalModifier : public GETProcess
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObjectV(GETSignalModifier);
  //------------------------------------------------------------

  protected:

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

  //----------------------------------------------------------
  /** @name Signal processing */
  //@{
    virtual GETSample * ProcessSample ( GETChannel & channel,
                                        u_short      info );

    /*! This is the effective function that processes the \b input sample 
     *  and stores the result in the \b result sample.
     *  This function must be defined in the derived classes.
     *  \param  sample    input sample to be processed
     *  \param  result    sample where result should be stored
     *  \param  channel   GET system channel (the samples should correspond to this channel)
     */
    virtual GETSample * ProcessSample ( GETSample  & sample,
                                        GETSample  & result,
                                        GETChannel & channel ) = 0;
  //@}

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

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


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


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