GETFilter.hh

Go to the documentation of this file.

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

#ifndef GET_FILTER_HH
#define GET_FILTER_HH

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

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

//======================================================================
/*! \class GETFilter
 *
 *  This class defines the filter function for the GET signal processing.
 */
class GETFilter : public GETProcess
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETFilter);
  //------------------------------------------------------------

  protected:
    GETSample    filter_fct;     ///< Filter function for an AGET channel

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

  //----------------------------------------------------------
  /** @name Initialization functions */
  //@{
    virtual void  Reset ( );
    virtual void  Init ( u_int n, double dt );

    virtual void  SetNormalized ( bool b = true );    // inline

    virtual void  Normalize ( double norm = 1. );
    virtual void  Scale     ( double fact = 1. );     // inline
  //@}


  //----------------------------------------------------------
  /** @name Access to class data */
  //@{
    const GETSample * GetFilterPtr ( ) const;  // inline
          GETSample * GetFilterPtr ( );        // inline
    const GETSample & GetFilter    ( ) const;  // inline
          GETSample & GetFilter    ( );        // inline
  //@}

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

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

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

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


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


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