GETAutoBaseline.hh

Go to the documentation of this file.

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

#ifndef GET_AUTO_BASELINE_HH
#define GET_AUTO_BASELINE_HH

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

#include "GETSignalModifier.hh"

//======================================================================
/*! \class GETAutoBaseline
 *
 *  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 GETAutoBaseline : public GETSignalModifier
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETAutoBaseline);
  //------------------------------------------------------------

  protected:
    u_short bucket_num_lo;      ///< Number of buckets in the low part of the sample
    u_short bucket_off_lo;      ///< Buckets offset from first bucket
    u_short bucket_num_hi;      ///< Number of buckets in the high part of the sample
    u_short bucket_off_hi;      ///< Buckets offset from last bucket

    double  x_lo;               ///< Center of the low part
    double  x_hi;               ///< Center of the high part

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

  //----------------------------------------------------------
  /** @name Process parameters */
  //@{
    virtual void SetBaselineLow  ( u_short num_lo, u_short off_lo = 0 );
    virtual void SetBaselineHigh ( u_short num_hi, u_short off_hi = 0 );

  //@}

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

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


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


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