PFourier.h

Go to the documentation of this file.

/***************************************************************************
 
  PFourier.h
 
  Author: Andreas Suter
  e-mail: andreas.suter@psi.ch
 
***************************************************************************/
 
/***************************************************************************
 *   Copyright (C) 2007-2026 by Andreas Suter                              *
 *   andreas.suter@psi.ch                                                  *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#ifndef _PFOURIER_H_
#define _PFOURIER_H_
 
#include <vector>
 
#include "fftw3.h"
 
#include <TH1F.h>
 
#include "Minuit2/FCNBase.h"
 
#include "PMusr.h"
 
//-------------------------------------------------------------
#define F_APODIZATION_NONE   1
#define F_APODIZATION_WEAK   2
#define F_APODIZATION_MEDIUM 3
#define F_APODIZATION_STRONG 4
 
//-------------------------------------------------------------
class PFTPhaseCorrection : public ROOT::Minuit2::FCNBase
{
  public:
    PFTPhaseCorrection(const Int_t minBin=-1, const Int_t maxBin=-1);

    PFTPhaseCorrection(std::vector<Double_t> &reFT, std::vector<Double_t> &imFT, const Int_t minBin=-1, const Int_t maxBin=-1);
 
    virtual ~PFTPhaseCorrection() {}

    virtual Bool_t IsValid() { return fValid; }

    virtual void Minimize();

    virtual void SetGamma(const Double_t gamma) { fGamma = gamma; }

    virtual void SetPh(const Double_t c0, const Double_t c1) { fPh_c0 = c0; fPh_c1 = c1; CalcPhasedFT(); CalcRealPhFTDerivative(); }

    virtual Double_t GetGamma() { return fGamma; }

    virtual Double_t GetPhaseCorrectionParam(UInt_t idx);

    virtual Double_t GetMinimum();
 
  private:
    Bool_t fValid;
 
    std::vector<Double_t> fReal; 
    std::vector<Double_t> fImag; 
    mutable std::vector<Double_t> fRealPh;  
    mutable std::vector<Double_t> fImagPh;  
    mutable std::vector<Double_t> fRealPhD; 
 
    Int_t fMinBin; 
    Int_t fMaxBin; 
    mutable Double_t fPh_c0; 
    mutable Double_t fPh_c1; 
    Double_t fGamma; 
    Double_t fMin; 
 
    virtual void Init();
    virtual void CalcPhasedFT() const;
    virtual void CalcRealPhFTDerivative() const;
    virtual Double_t Penalty() const;
    virtual Double_t Entropy() const;
 
    virtual Double_t Up() const { return 1.0; }
    virtual Double_t operator()(const std::vector<Double_t>&) const;
};
 
//-------------------------------------------------------------
class PFourier
{
  public:
    PFourier(TH1F *data, Int_t unitTag,
             Double_t startTime = 0.0, Double_t endTime = 0.0,
             Bool_t dcCorrected = false, UInt_t zeroPaddingPower = 0);
 
    virtual ~PFourier();

    virtual void Transform(UInt_t apodizationTag = 0);

    virtual const char* GetDataTitle() { return fData->GetTitle(); }

    virtual const Int_t GetUnitTag() { return fUnitTag; }

    virtual Double_t GetResolution() { return fResolution; }

    virtual Double_t GetMaxFreq();

    virtual TH1F* GetRealFourier(const Double_t scale = 1.0);

    virtual TH1F* GetImaginaryFourier(const Double_t scale = 1.0);

    virtual TH1F* GetPowerFourier(const Double_t scale = 1.0);

    virtual TH1F* GetPhaseFourier(const Double_t scale = 1.0);

    static TH1F* GetPhaseOptRealFourier(const TH1F *re, const TH1F *im, std::vector<Double_t> &phase,
                                        const Double_t scale = 1.0, const Double_t min = -1.0, const Double_t max = -1.0);

    virtual Bool_t IsValid() { return fValid; }
 
  private:
    TH1F *fData; 
 
    Bool_t fValid; 
    Int_t  fUnitTag; 
 
    Int_t fApodization; 
 
    Double_t fTimeResolution; 
    Double_t fStartTime; 
    Double_t fEndTime; 
    Bool_t fDCCorrected; 
    UInt_t fZeroPaddingPower; 
    Double_t fResolution; 
 
    UInt_t fNoOfData; 
    UInt_t fNoOfBins; 
    fftw_plan fFFTwPlan; 
    fftw_complex *fIn; 
    fftw_complex *fOut; 
 
//as    PFTPhaseCorrection *fPhCorrectedReFT;
 
    virtual void PrepareFFTwInputData(UInt_t apodizationTag);
    virtual void ApodizeData(Int_t apodizationTag);
};
 
#endif // _PFOURIER_H_