GETSampleWindow.hh

Go to the documentation of this file.

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

#ifndef GET_SAMPLE_WINDOW_HH
#define GET_SAMPLE_WINDOW_HH

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

#include "GETSignalModifier.hh"

//======================================================================
/*! \class GETSampleWindow
 *
 *  This class defines a windowing process for samples.
 *
 */
class GETSampleWindow : public GETSignalModifier
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETSampleWindow);
  //------------------------------------------------------------

  protected:

    GETSample   window;   ///< Sample for windowing the signal

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

  //----------------------------------------------------------
  /** @name Signal windowing function */
  //@{
    const GETSample & GetWindow ( ) const;     // inline
          GETSample & GetWindow ( );           // inline

    void  ClearWindow   ( );
    int   SetWindow     ( const GETSample & w );
    int   SetWindowHann ( );

    int   ApplyWindow ( GETSample & sample, GETSample & result ); // inline
  //@}

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

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

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


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


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