RRealSampleFFT.hh

Go to the documentation of this file.

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

#ifndef R_REAL_SAMPLE_FFT_HH
#define R_REAL_SAMPLE_FFT_HH

//======================================================================
#include "GRealSampleFFT.hh"

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

//----------------------------------------------------------------------
/*! \class RRealSampleFFT
 *
 *  This is a class to manage of a real function samples and the
 *  corresponding Fourier transform.
 *
 *  This class is based on GRealSampleFFT general class, with features
 *  for ROOT.
 *  It defines some information for graphs and histograms to be created
 *  for ROOT.
 */
class RRealSampleFFT : public GRealSampleFFT, public TAttLine, public TAttMarker
{
  //------------------------------------------------------------
  /*! \object_doc{RRealSampleFFT} */
  GObject(RRealSampleFFT);
  //------------------------------------------------------------

  using GRealSampleFFT::InitFunctionData;
  using GRealSampleFFT::SetFunctionData;
  using GRealSampleFFT::SetFunctionValues;

  public:

    string    fct_title;        ///< Function title
    string    fct_title_x;      ///< Function title (X axis)
    string    fct_title_y;      ///< Function title (Y axis)

    string    fft_title;        ///< Fourier transform title
    string    fft_title_freq;   ///< Fourier transform frequency axis title
    string    fft_title_amp;    ///< Fourier transform amplitude axis title
    string    fft_title_phase;  ///< Fourier transform phase axis title
    string    fft_title_power;  ///< Fourier transform power axis title
    string    fft_title_re;     ///< Fourier transform real axis title
    string    fft_title_im;     ///< Fourier transform imaginary axis title

  protected:

  public:
    // Constructors
    RRealSampleFFT ( const u_int n = 0, const double dt = 1.L );
    RRealSampleFFT ( const RRealSampleFFT & original );
    RRealSampleFFT ( const GRealSampleFFT & original );

    // Constructors setting function samples
    RRealSampleFFT ( const u_int n, const double data [] );
    RRealSampleFFT ( const u_int n, const double t_lo, const double t_hi,
                                    const double data [], bool ctr = false );
    RRealSampleFFT ( const u_int n, const double t_lo, const double t_hi,
                                    double (*fct_ptr) ( const double, const double [] ),
                                    const double fct_par[], bool ctr = false );
    RRealSampleFFT ( const u_int n, const double t_lo, const double t_hi,
                                    double (*fct_ptr) ( const double [], const double [] ),
                                    const double fct_par[], bool ctr = false );
    RRealSampleFFT ( const u_int n, const double t_lo, const double t_hi,
                                    TF1 * fct, bool ctr = false );
    RRealSampleFFT ( TH1 * hptr );

    // Constructors setting Fourier transform
    RRealSampleFFT ( const u_int n, const double data_re[], const double data_im[] );

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

    // Destructors
    virtual ~RRealSampleFFT ( );


  //----------------------------------------------------------
    // Functions to set data from function sample
    virtual void  InitFunctionData ( const u_int n,
                                     const double t_lo, const double t_hi,
                                     TF1 * fct, bool ctr = false );
    virtual void  InitFunctionData ( TH1 * hptr );

    virtual void  SetFunctionData  ( TF1 * fct );

    virtual void  FillRandomGaus   ( double mean, double fwhm, TRandom * rnd = NULL );
    virtual void  FillRandomGaus   ( double fwhm, TRandom * rnd = NULL );

    virtual int   SetFunctionValues ( u_int i1, u_int i2, TF1 * fct );

  //----------------------------------------------------------
    void  SetDefaultValues ( );
    void  SetColor ( const Color_t col );
    void  SetFunctionTitles ( const char tit  [] = "",
                              const char tit_x[] = "",
                              const char tit_y[] = "" );
 
    void  SetTransformTitles ( const char tit    [] = "",
                               const char tit_f  [] = "",
                               const char tit_amp[] = "",
                               const char tit_ph [] = "",
                               const char tit_pow[] = "" );

    void  SetTransformComplexTitles ( const char tit_re[] = "",
                                      const char tit_im[] = "" );

    TGraph * CreateFunctionGraph  ( double scale = 1.L );
    TGraph * CreateTransformGraph ( double scale = 1.L );
    TGraph * CreateTrfAmpliGraph  ( double scale = 1.L );
    TGraph * CreateTrfPhaseGraph  ( bool deg = false );
    TGraph * CreatePowerGraph     ( double scale = 1.L );

    TH1D   * CreateFunctionHisto  ( const string & name, double scale = 1.L );
    int      FillFunctionHisto    ( TH1D * hptr, double scale = 1.L, bool reset = true );


  //----------------------------------------------------------
    // Arithmetic operators
    // (they need to be redefined from GRealSampleFFT, but I do not
    //  understand why...)

     RRealSampleFFT operator + ( RRealSampleFFT &s );
     RRealSampleFFT operator - ( RRealSampleFFT &s );
     RRealSampleFFT operator * ( RRealSampleFFT &s );
     RRealSampleFFT operator / ( RRealSampleFFT &s );
     RRealSampleFFT operator * ( double r );
     RRealSampleFFT operator / ( double r );
     RRealSampleFFT operator + ( double r );
     RRealSampleFFT operator - ( double r );

  //----------------------------------------------------------
  protected:
    // Functions for internal use
    void  CopyData ( const RRealSampleFFT & original );


  public:

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

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


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