GRealSampleFFT.hh

Go to the documentation of this file.

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

#ifndef G_REAL_SAMPLE_FFT_HH
#define G_REAL_SAMPLE_FFT_HH
//======================================================================

#include "GBaseSampleFFT.hh"

//----------------------------------------------------------------------
/*! \class GRealSampleFFT
 *
 *  This is a class to manage of a \b real function samples and the
 *  corresponding Fourier transform.
 */
class GRealSampleFFT : public GBaseSampleFFT
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GRealSampleFFT);
  //------------------------------------------------------------

  protected:

  public:
  //----------------------------------------------------------
  /** @name Constructors, destructor, affectation */
  //@{
    // Constructors
    GRealSampleFFT ( u_int n = 0, double dt = 1.L );
    GRealSampleFFT ( const GRealSampleFFT & original );

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

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

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

    // Destructors
    virtual ~GRealSampleFFT ( );

  //@}

  //----------------------------------------------------------
  /** @name Functions to initialise and set data for function sample or FT */
  //@{
    virtual void  InitFunctionData  ( u_int n, const double data [] );  // inline
    virtual void  InitFunctionData  ( u_int n, double dt, const double data [] );

    virtual void  InitFunctionData  ( u_int n,
                                      double t_lo, double t_hi,
                                      double (*fct_ptr) ( double, const double [] ),
                                      const double fct_par[], bool ctr = false );
    virtual void  InitFunctionData  ( u_int n,
                                      double t_lo, double t_hi,
                                      double (*fct_ptr) ( const double [], const double [] ),
                                      const double fct_par[], bool ctr = false );

    virtual void  InitTransformData ( u_int n, const double data [] );
    virtual void  InitTransformData ( u_int n, const double data_re[],
                                               const double data_im[] );


    // Functions to set values
    virtual void  SetFunctionData   ( double (*fct_ptr) ( double, const double [] ),
                                      const double fct_par[]);
    virtual void  SetFunctionData   ( double (*fct_ptr) ( const double [], const double [] ),
                                      const double fct_par[]);

    virtual void  SetFullBandFilter ( double amp = 1.L );


    virtual void  SetFunctionValue  ( u_int i, double val );

    virtual void  SetTransformValue ( u_int i, double re, double im = 0.L );
    virtual void  SetFFTValue       ( u_int i, double re, double im = 0.L );


    // Functions to set partial sample values
    virtual int   SetFunctionValues ( u_int i1, u_int i2,
                                      double val );
    virtual int   SetFunctionValues ( u_int i1, u_int i2,
                                      const double data[] );
    virtual int   SetFunctionValues ( u_int i1, u_int i2,
                                      double (*fct_ptr) ( double, const double [] ),
                                      const double fct_par[] );
    virtual int   SetFunctionValues ( const u_int i1, const u_int i2,
                                      double (*fct_ptr) ( const double [], const double [] ),
                                      const double fct_par[] );


    // Computation of the Fourier and inverse transforms
    virtual int   ComputeTransformData ( );
    virtual int   ComputeFunctionData  ( );

    virtual void  Normalise ( double s = 1.L );

  //@}

  //----------------------------------------------------------
  /** @name Function to extract samples information */
  //@{

    virtual double  GetSum      ( );
    virtual double  GetMean     ( );    // inline
    virtual double  GetRMS      ( );
    virtual double  GetIntegral ( );
    virtual double  GetPower    ( bool f = false );
    virtual double  GetMinimum  ( );
    virtual double  GetMinimum  ( double & t );
    virtual double  GetMaximum  ( );
    virtual double  GetMaximum  ( double & t );
    virtual u_int   GetMinimumIndex ( );
    virtual u_int   GetMaximumIndex ( );

    GRealSampleFFT  & Derivate  ( );
    GRealSampleFFT  & Derivate  ( GRealSampleFFT & sample );
    GRealSampleFFT  & Integrate ( );
    GRealSampleFFT  & Integrate ( GRealSampleFFT & sample );

  //@}

  //----------------------------------------------------------
  /** @name Function Functions for convolution / deconvolution */
  //@{

    virtual int   InterpolateFrom ( GRealSampleFFT & fct, double dt,
                                    double t0, int mode = 0 );
    virtual int   InterpolateFrom ( GRealSampleFFT & fct, double dt,
                                    int mode = 0 );

    virtual int   SetTimeResponse ( GRealSampleFFT & signal,
                                    GRealSampleFFT & resp,
                                    int mode = 0 );

    virtual int   SetConvolution  ( GRealSampleFFT & signal,
                                    GRealSampleFFT & resp,
                                    bool inv  = false,
                                    int  mode = 0 );

    virtual int   SetProduct      ( GRealSampleFFT & s1,
                                    GRealSampleFFT & s2 );

  //@}

  //----------------------------------------------------------
  /** @name Modification functions */
  //@{
    virtual GRealSampleFFT & DoubleSymmetric ( bool neg = false );
    virtual GRealSampleFFT & HalfDivide      ( );

  //@}

  //----------------------------------------------------------
  /** @name Arithmetic operators */
  //@{

    GRealSampleFFT operator + ( GRealSampleFFT &s );
    GRealSampleFFT operator - ( GRealSampleFFT &s );
    GRealSampleFFT & operator += ( GRealSampleFFT &s );
    GRealSampleFFT & operator -= ( GRealSampleFFT &s );

    GRealSampleFFT   operator *  ( GRealSampleFFT &s );
    GRealSampleFFT & operator *= ( GRealSampleFFT &s );

    GRealSampleFFT operator * ( double r );
    GRealSampleFFT operator / ( double r );     // inline
    GRealSampleFFT & operator *= ( double r );
    GRealSampleFFT & operator /= ( double r );  // inline

    GRealSampleFFT operator + ( double k );
    GRealSampleFFT operator - ( double k );     // inline
    GRealSampleFFT & operator += ( double k );
    GRealSampleFFT & operator -= ( double k );  // inline

  //@}

};

//======================================================================
//  Related functions

extern GRealSampleFFT operator * ( double r, GRealSampleFFT & s );

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


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