[u/mrichter/AliRoot.git] / CORRFW / AliCFUnfolding.h


#ifndef ALICFUNFOLDING_H
#define ALICFUNFOLDING_H

//--------------------------------------------------------------------//
//                                                                    //
// AliCFUnfolding Class                                               //
// Class to handle general unfolding procedure using bayesian method  //
//                                                                    //
// Author : renaud.vernet@cern.ch                                     //
//--------------------------------------------------------------------//

#include "TNamed.h"
#include "THnSparse.h"
#include "AliLog.h"

class TF1;
class TRandom3;

class AliCFUnfolding : public TNamed {

 public :

  AliCFUnfolding();
  AliCFUnfolding(const Char_t* name, const Char_t* title, const Int_t nVar, 
		 const THnSparse* response, const THnSparse* efficiency, const THnSparse* measured, const THnSparse* prior=0x0, 
		 Double_t maxConvergencePerDOF = 1.e-06, UInt_t randomSeed = 0,
		 Int_t maxNumIterations = 10);
  ~AliCFUnfolding();
  void UnsetCorrelatedErrors()  {AliError("===================> DEPRECATED <=====================");}
  void SetUseCorrelatedErrors() {AliError("===================> DEPRECATED <=====================");}
  void SetMaxNumberOfIterations(Int_t n = 10)  {
    AliError("===================> DEPRECATED : should be set in constructor <=====================");
    AliError("===================> DEPRECATED : will be removed soon         <=====================");
    fMaxNumIterations = n;
  }

  void SetNRandomIterations(Int_t n = 100) {fNRandomIterations = n;};

  void UseSmoothing(TF1* fcn=0x0, Option_t* opt="iremn") { // if fcn=0x0 then smooth using neighbouring bins 
    fUseSmoothing=kTRUE;                                   // this function must NOT be used if fNVariables > 3
    fSmoothFunction=fcn;                                   // the option "opt" is used if "fcn" is specified
    fSmoothOption=opt;
  } 
                                                                                                
  void Unfold();

  const THnSparse* GetResponse()             const {return fResponseOrig;}
  const THnSparse* GetEfficiency()           const {return fEfficiencyOrig;}
  const THnSparse* GetMeasured()             const {return fMeasuredOrig;}
  const THnSparse* GetOriginalPrior()        const {return fPriorOrig;}
        THnSparse* GetInverseResponse()      const {return fInverseResponse;}
        THnSparse* GetPrior()                const {return fPrior;}
	THnSparse* GetUnfolded()             const {return fUnfoldedFinal;}
        THnSparse* GetEstMeasured()          const {return fMeasuredEstimate;}
	THnSparse* GetConditional()          const {return fConditional;}
	TF1*       GetSmoothFunction()       const {return fSmoothFunction;}
	THnSparse* GetDeltaUnfoldedProfile() const {return fDeltaUnfoldedP;}
	Int_t      GetDOF();                 // Returns number of degrees of freedom

  static Short_t  SmoothUsingNeighbours(THnSparse*); // smoothes the unfolded spectrum using the neighbouring cells

 private :
  AliCFUnfolding(const AliCFUnfolding& c);
  AliCFUnfolding& operator= (const AliCFUnfolding& c);
  
  //
  // user-related settings
  //
  const THnSparse     *fResponseOrig;     // Response matrix : dimensions must be 2N = 2 x (number of variables)
                                          // dimensions 0 ->  N-1 must be filled with reconstructed values
                                          // dimensions N -> 2N-1 must be filled with generated values
  const THnSparse     *fPriorOrig;        // This is the assumed generated distribution : dimensions must be N = number of variables
                                          // it will be used at the first step 
                                          // then will be updated automatically at each iteration
  const THnSparse     *fEfficiencyOrig;   // Efficiency map : dimensions must be N = number of variables (modified)
                                          // this map must be filled only with "true" values of the variables (should not do "bin smearing")
  const THnSparse     *fMeasuredOrig;     // Measured spectrum to be unfolded : dimensions must be N = number of variables (modified)

        Int_t          fMaxNumIterations; // Maximum  number of iterations to be performed
	Int_t          fNVariables;       // Number of variables used in analysis spectra (pt, y, ...)
        Bool_t         fUseSmoothing;     // Smooth the unfolded sectrum at each iteration; default is kFALSE
	TF1           *fSmoothFunction;   // Function used to smooth the unfolded spectrum
	Option_t      *fSmoothOption;     // Option to use during the fit (with fSmoothFunction) ; default is "iremn"

  //
  // internal settings
  //
	Double_t       fMaxConvergence;    // Convergence criterion in case of correlated error calculation
        Int_t          fNRandomIterations; // Number of random distributed measured spectra
	THnSparse     *fResponse;          // Copy of the original response matrix    (modified)
	THnSparse     *fPrior;             // Copy of the original prior spectrum     (modified)
	THnSparse     *fEfficiency;        // Copy of original efficiency             (modified)
	THnSparse     *fMeasured;          // Copy of the original measureed spectrum (modified)
        THnSparse     *fInverseResponse;   // Inverse response matrix
        THnSparse     *fMeasuredEstimate;  // Estimation of the measured (M) spectrum given the a priori (T) distribution
	THnSparse     *fConditional;       // Matrix holding the conditional probabilities P(M|T)
        THnSparse     *fUnfolded;          // Unfolded spectrum (modified before and during error calculation)
	THnSparse     *fUnfoldedFinal;     // Final unfolded spectrum
        Int_t         *fCoordinates2N;     // Coordinates in 2N (measured,true) space
	Int_t         *fCoordinatesN_M;    // Coordinates in measured space
	Int_t         *fCoordinatesN_T;    // Coordinates in true space


  /* correlated error calculation */
  THnSparse     *fRandomResponse;    // Randomized distribution for each bin of the response matrix     to calculate correlated errors
  THnSparse     *fRandomEfficiency;  // Randomized distribution for each bin of the efficiency spectrum to calculate correlated errors
  THnSparse     *fRandomMeasured;    // Randomized distribution for each bin of the measured   spectrum to calculate correlated errors
  TRandom3      *fRandom3;           // Object to get random number following Poisson distribution
  THnSparse     *fDeltaUnfoldedP;    // Profile of the delta-unfolded distribution
  THnSparse     *fDeltaUnfoldedN;    // Entries of the delta-unfolded distribution (count for each bin)
  Short_t        fNCalcCorrErrors;   // Book-keeping to prevend infinite loop
  UInt_t         fRandomSeed;        // Random seed


  // functions
  void     Init();                  // initialisation of the internal settings
  void     GetCoordinates();        // gets a cell coordinates in Measured and True space
  void     CreateConditional();     // creates the conditional matrix from the response matrix
  void     CreateEstMeasured();     // creates the measured spectrum estimation from the conditional matrix and the prior distribution
  void     CreateInvResponse();     // creates the inverse response function (Bayes Theorem) from the conditional matrix and the prior distribution
  void     CreateUnfolded();        // creates the unfolded spectrum from the inverse response matrix and the measured distribution
  void     CreateFlatPrior();       // creates a flat a priori distribution in case the one given in the constructor is null
  Double_t GetChi2();               // returns the chi2 between unfolded and prior spectra
  Short_t  Smooth();                // function calling smoothing methods
  Short_t  SmoothUsingFunction();   // smoothes the unfolded spectrum using a fit function

  /* correlated error calculation */
  Double_t GetConvergence();            // Returns convergence criterion
  void     CalculateCorrelatedErrors(); // Calculates correlated errors for the final unfolded spectrum
  void     CreateRandomizedDist();      // Create randomized dist from measured distribution
  void     FillDeltaUnfoldedProfile();  // Fills the fDeltaUnfoldedP profile
  void     SetMaxConvergencePerDOF (Double_t val);

  ClassDef(AliCFUnfolding,1);
};

#endif
Commit	Line	Data
c0b10ad4	1
	2	#ifndef ALICFUNFOLDING_H
	3	#define ALICFUNFOLDING_H
	4
	5	//--------------------------------------------------------------------//
	6	// //
	7	// AliCFUnfolding Class //
fb494025	8	// Class to handle general unfolding procedure using bayesian method //
c0b10ad4	9	// //
	10	// Author : renaud.vernet@cern.ch //
	11	//--------------------------------------------------------------------//
	12
	13	#include "TNamed.h"
	14	#include "THnSparse.h"
a9500e70	15	#include "AliLog.h"
c0b10ad4	16
85b6bda9	17	class TF1;
769f5114	18	class TRandom3;
85b6bda9	19
c0b10ad4	20	class AliCFUnfolding : public TNamed {
	21
	22	public :
a9500e70	23
c0b10ad4	24	AliCFUnfolding();
c0b10ad4	25	AliCFUnfolding(const Char_t* name, const Char_t* title, const Int_t nVar,
a9500e70	26	const THnSparse* response, const THnSparse* efficiency, const THnSparse* measured, const THnSparse* prior=0x0,
	27	Double_t maxConvergencePerDOF = 1.e-06, UInt_t randomSeed = 0,
	28	Int_t maxNumIterations = 10);
c0b10ad4	29	~AliCFUnfolding();
a9500e70	30	void UnsetCorrelatedErrors() {AliError("===================> DEPRECATED <=====================");}
	31	void SetUseCorrelatedErrors() {AliError("===================> DEPRECATED <=====================");}
	32	void SetMaxNumberOfIterations(Int_t n = 10) {
	33	AliError("===================> DEPRECATED : should be set in constructor <=====================");
	34	AliError("===================> DEPRECATED : will be removed soon <=====================");
	35	fMaxNumIterations = n;
769f5114	36	}
769f5114	37
eb532873	38	void SetNRandomIterations(Int_t n = 100) {fNRandomIterations = n;};
eb532873	39
85b6bda9	40	void UseSmoothing(TF1* fcn=0x0, Option_t* opt="iremn") { // if fcn=0x0 then smooth using neighbouring bins
	41	fUseSmoothing=kTRUE; // this function must NOT be used if fNVariables > 3
	42	fSmoothFunction=fcn; // the option "opt" is used if "fcn" is specified
	43	fSmoothOption=opt;
	44	}
	45
c0b10ad4	46	void Unfold();
c0b10ad4	47
5a575436	48	const THnSparse* GetResponse() const {return fResponseOrig;}
	49	const THnSparse* GetEfficiency() const {return fEfficiencyOrig;}
	50	const THnSparse* GetMeasured() const {return fMeasuredOrig;}
	51	const THnSparse* GetOriginalPrior() const {return fPriorOrig;}
	52	THnSparse* GetInverseResponse() const {return fInverseResponse;}
	53	THnSparse* GetPrior() const {return fPrior;}
	54	THnSparse* GetUnfolded() const {return fUnfoldedFinal;}
	55	THnSparse* GetEstMeasured() const {return fMeasuredEstimate;}
	56	THnSparse* GetConditional() const {return fConditional;}
	57	TF1* GetSmoothFunction() const {return fSmoothFunction;}
	58	THnSparse* GetDeltaUnfoldedProfile() const {return fDeltaUnfoldedP;}
	59	Int_t GetDOF(); // Returns number of degrees of freedom
c0b10ad4	60
7036630f	61	static Short_t SmoothUsingNeighbours(THnSparse*); // smoothes the unfolded spectrum using the neighbouring cells
7036630f	62
c0b10ad4	63	private :
67f40e08	64	AliCFUnfolding(const AliCFUnfolding& c);
67f40e08	65	AliCFUnfolding& operator= (const AliCFUnfolding& c);
c0b10ad4	66
5a575436	67	//
c0b10ad4	68	// user-related settings
5a575436	69	//
	70	const THnSparse *fResponseOrig; // Response matrix : dimensions must be 2N = 2 x (number of variables)
	71	// dimensions 0 -> N-1 must be filled with reconstructed values
	72	// dimensions N -> 2N-1 must be filled with generated values
	73	const THnSparse *fPriorOrig; // This is the assumed generated distribution : dimensions must be N = number of variables
	74	// it will be used at the first step
	75	// then will be updated automatically at each iteration
	76	const THnSparse *fEfficiencyOrig; // Efficiency map : dimensions must be N = number of variables (modified)
	77	// this map must be filled only with "true" values of the variables (should not do "bin smearing")
	78	const THnSparse *fMeasuredOrig; // Measured spectrum to be unfolded : dimensions must be N = number of variables (modified)
	79
	80	Int_t fMaxNumIterations; // Maximum number of iterations to be performed
	81	Int_t fNVariables; // Number of variables used in analysis spectra (pt, y, ...)
	82	Bool_t fUseSmoothing; // Smooth the unfolded sectrum at each iteration; default is kFALSE
	83	TF1 *fSmoothFunction; // Function used to smooth the unfolded spectrum
	84	Option_t *fSmoothOption; // Option to use during the fit (with fSmoothFunction) ; default is "iremn"
	85
	86	//
c0b10ad4	87	// internal settings
5a575436	88	//
	89	Double_t fMaxConvergence; // Convergence criterion in case of correlated error calculation
	90	Int_t fNRandomIterations; // Number of random distributed measured spectra
	91	THnSparse *fResponse; // Copy of the original response matrix (modified)
	92	THnSparse *fPrior; // Copy of the original prior spectrum (modified)
	93	THnSparse *fEfficiency; // Copy of original efficiency (modified)
	94	THnSparse *fMeasured; // Copy of the original measureed spectrum (modified)
	95	THnSparse *fInverseResponse; // Inverse response matrix
	96	THnSparse *fMeasuredEstimate; // Estimation of the measured (M) spectrum given the a priori (T) distribution
	97	THnSparse *fConditional; // Matrix holding the conditional probabilities P(M\|T)
	98	THnSparse *fUnfolded; // Unfolded spectrum (modified before and during error calculation)
	99	THnSparse *fUnfoldedFinal; // Final unfolded spectrum
	100	Int_t *fCoordinates2N; // Coordinates in 2N (measured,true) space
	101	Int_t *fCoordinatesN_M; // Coordinates in measured space
	102	Int_t *fCoordinatesN_T; // Coordinates in true space
769f5114	103
	104
	105	/* correlated error calculation */
5a575436	106	THnSparse *fRandomResponse; // Randomized distribution for each bin of the response matrix to calculate correlated errors
	107	THnSparse *fRandomEfficiency; // Randomized distribution for each bin of the efficiency spectrum to calculate correlated errors
	108	THnSparse *fRandomMeasured; // Randomized distribution for each bin of the measured spectrum to calculate correlated errors
769f5114	109	TRandom3 *fRandom3; // Object to get random number following Poisson distribution
a9500e70	110	THnSparse *fDeltaUnfoldedP; // Profile of the delta-unfolded distribution
	111	THnSparse *fDeltaUnfoldedN; // Entries of the delta-unfolded distribution (count for each bin)
	112	Short_t fNCalcCorrErrors; // Book-keeping to prevend infinite loop
769f5114	113	UInt_t fRandomSeed; // Random seed
769f5114	114
c0b10ad4	115
c0b10ad4	116	// functions
85b6bda9	117	void Init(); // initialisation of the internal settings
	118	void GetCoordinates(); // gets a cell coordinates in Measured and True space
	119	void CreateConditional(); // creates the conditional matrix from the response matrix
	120	void CreateEstMeasured(); // creates the measured spectrum estimation from the conditional matrix and the prior distribution
	121	void CreateInvResponse(); // creates the inverse response function (Bayes Theorem) from the conditional matrix and the prior distribution
	122	void CreateUnfolded(); // creates the unfolded spectrum from the inverse response matrix and the measured distribution
	123	void CreateFlatPrior(); // creates a flat a priori distribution in case the one given in the constructor is null
	124	Double_t GetChi2(); // returns the chi2 between unfolded and prior spectra
	125	Short_t Smooth(); // function calling smoothing methods
85b6bda9	126	Short_t SmoothUsingFunction(); // smoothes the unfolded spectrum using a fit function
c0b10ad4	127
769f5114	128	/* correlated error calculation */
	129	Double_t GetConvergence(); // Returns convergence criterion
	130	void CalculateCorrelatedErrors(); // Calculates correlated errors for the final unfolded spectrum
769f5114	131	void CreateRandomizedDist(); // Create randomized dist from measured distribution
	132	void FillDeltaUnfoldedProfile(); // Fills the fDeltaUnfoldedP profile
	133	void SetMaxConvergencePerDOF (Double_t val);
	134
	135	ClassDef(AliCFUnfolding,1);
c0b10ad4	136	};
	137
	138	#endif