GETAutoBLoffset.hh

Go to the documentation of this file.

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

#ifndef GET_AUTO_BL_OFFSET_HH
#define GET_AUTO_BL_OFFSET_HH

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

#include "GETSignalModifier.hh"

//======================================================================
/*! \class GETAutoBLoffset
 *
 *  This class defines an automatic base-line correction process.
 *
 *  The automatic baseline computes an average at the beginning of the
 *  sample and another average at the end of the sample, and use them
 *  to perform a linear subtraction to the signal.
 */
class GETAutoBLoffset : public GETSignalModifier
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETAutoBLoffset);
  //------------------------------------------------------------

  protected:
    u_short bucket_min;       ///< Lower time bucket for offset estimate (included)
    u_short bucket_max;       ///< Uppet time bucket for offset estimate (excluded)

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

  //----------------------------------------------------------
  /** @name Process parameters */
  //@{
    virtual void SetOffsetRange  ( u_short itmin, u_short itmax );

  //@}

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

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


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


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