GETNoise.hh

Go to the documentation of this file.

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

#ifndef GET_NOISE_HH
#define GET_NOISE_HH

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

#include "GETSignalModifier.hh"

//======================================================================
/*! \class GETNoise
 *
 *  This class defines Gauss random noise with an optional offset of the
 *  signal.
 *
 */
class GETNoise : public GETSignalModifier
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETNoise);
  //------------------------------------------------------------

  protected:
    double    width;    ///< Fluctuation width (FWHM)
    double    offset;   ///< Signal offset

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

  //----------------------------------------------------------
  /** @name Process parameters */
  //@{
    void  SetWidth  ( double wid );   // inline
    void  SetOffset ( double off );   // inline

  //@}

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

    virtual GETSample * ProcessSample ( GETSample  & sample,
                                        GETSample  & result,
                                        GETChannel & channel );
  //@}

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

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


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


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