RExtremaFinder.hh

Go to the documentation of this file.

//======================================================================
/*! \file RExtremaFinder.hh
 *
 *  Include file for class RExtremaFinder.
 */
//======================================================================

#ifndef R_EXTREMA_FINDER_HH
#define R_EXTREMA_FINDER_HH

//======================================================================
#include "GExtremaFinder.hh"
#include "RRealSampleFFT.hh"

// ROOT include files
#include "TGraph.h"
#include "TAxis.h"
#include "TH1D.h"
#include "TF1.h"
#include "TRandom3.h"
#include "TGraphAsymmErrors.h"

//----------------------------------------------------------------------
/*! \class RExtremaFinder
 *
 *  This class adds ROOT related functions to the base class GExtremaFinder.
 */
class RExtremaFinder : public GExtremaFinder
{
  //------------------------------------------------------------
  /*! \object_doc{RExtremaFinder} */
  GObject(RExtremaFinder);
  //------------------------------------------------------------

  using GExtremaFinder::InitData;

  public:
  /** @name Constructors, destructors, affectation */
  //@{
    // Constructors
    RExtremaFinder ( u_int n = 0, double * data = NULL, double bin = 1. );
    RExtremaFinder ( RRealSampleFFT * sptr );
    RExtremaFinder ( RRealSampleFFT & s );
    RExtremaFinder ( TH1 * hptr );

    RExtremaFinder ( const RExtremaFinder & original );
    RExtremaFinder ( const GExtremaFinder & original );

    // Affectation
    RExtremaFinder & operator = ( const RExtremaFinder & original );

    // Destructors
    virtual ~RExtremaFinder ( );
  //@}

  //----------------------------------------------------------
  /** @name Initialisation and setting functions */
  //@{

    virtual int   InitData ( u_int n, double * data, double bin = 1. );
    virtual int   InitData ( TH1 * hptr );

  //@}

  //----------------------------------------------------------
  /** @name Access to data */
  //@{
    const RRealSampleFFT  * GetSample ( ) const;            // inline
          RRealSampleFFT  * GetSample ( );                  // inline
    const RRealSampleFFT  * GetDerivativeSample ( ) const;  // inline
          RRealSampleFFT  * GetDerivativeSample ( );        // inline

  //@}

  /** @name ROOT related function */
  //@{
  public:

    virtual TGraph            * CreateExtremaGraph     ( ) const;
    virtual TGraph            * CreateMaximaGraph      ( ) const;
    virtual TGraph            * CreateAverageGraph     ( bool ampl = true ) const;
    virtual TGraphAsymmErrors * CreateMaxZoneGraph     ( bool ampl = false ) const;
    virtual TGraph            * CreateMaxTriangleGraph ( ) const;


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

//======================================================================
//  Inline functions
#include "icc/RExtremaFinder.icc"


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