Added Support for asymmetric normalization uncertainties
[u/mrichter/AliRoot.git] / PWGLF / ThermalFits / AliParticleYield.h
CommitLineData
2f86df33 1#ifndef _ALIPARTICLEYIELD_H_
2#define _ALIPARTICLEYIELD_H_
3
4// AliParticleYield
5// This class implements a container for particle yields results, to
6// be used e.g. in thermal model fits, with utility methods to
7// read/write to ASCII files or root trees
8// Author: Michele FLoris, michele.floris@cern.ch
9
10#include "TObject.h"
11#include "TString.h"
12
13class TClonesArray;
14class TTree;
15
16class AliParticleYield : public TObject
17{
18public:
19
20 enum AliPYCSystem_t {kCSpp = 0,
21 kCSpPb = 1,
22 kCSPbPb = 2 } ;
23
24 static const char * kSystemString[];
25
26 enum AliPYStatusCode_t {
27 kSCPublished = 0,
28 kSCPreliminary = 1,
29 kSCFinalNotPublished = 2,
30 kSCMayChange = 3,
31 };
32
33 static const char * kStatusString[];
34
35 enum AliPYMeasurementType_t { // this is a bit mask: more than one bit can be one (be careful not to set mutually exclusive ones).
36 // Type of measurements (lowest nibble reserved for this)
37 kTypeLinearInterpolation = 0x1,
38 kTypeParticleRatio = 0x2, // If true, this is a ratio of 2 particles where the propagation of uncertainty was properly taken into account.
39
40 // Type of errors
41 kTypeOnlyTotError = 0x10, // If on, only the total error is returned as "GetSystError". GetStatError should be set to 0;
42 };
43
44 AliParticleYield();
45 AliParticleYield(Int_t pdg, Int_t system, Float_t sqrts, Float_t value, Float_t stat, Float_t syst, Float_t norm, Float_t ymin, Float_t ymax, Int_t status, Int_t type, TString centr, Int_t isSum = 0, TString tag = "ALICE");
3e8c4dd8 46 AliParticleYield(Int_t pdg, Int_t system, Float_t sqrts, Float_t value, Float_t stat, Float_t syst, Float_t normPos, Float_t normNeg, Float_t ymin, Float_t ymax, Int_t status, Int_t type, TString centr, Int_t isSum = 0, TString tag = "ALICE");
2f86df33 47 virtual ~AliParticleYield();
48 AliParticleYield(const AliParticleYield& part);
49
50 // IO
51 static TClonesArray * ReadFromASCIIFile(const char * fileName, const char * separators = " \t");
52 static TTree * ReadFromASCIIFileAsTree(const char * fileName, const char * separators = " \t");
53 static void SaveAsASCIIFile(TClonesArray * arr, const char * filename, const char * separator = " ", Int_t colWidth = 7);
5a633e19 54 static void WriteThermusFile(TClonesArray * arr, const char * filename, Int_t colWidth = 10);
2f86df33 55 static TClonesArray * GetEntriesMatchingSelection(TTree * tree, TString selection);
56
57 // Misc helpers
58 Bool_t CheckTypeConsistency() const;
16163c99 59 Bool_t CheckForDuplicates(TClonesArray * arr) ;
60 virtual void Print (Option_t * opt = "") const;
2f86df33 61 static Float_t GetError(TString error, Float_t yield) ;
5a633e19 62 static const char * FormatCol(const char * text, Int_t width, const char * sep =" ") ;
2f86df33 63 static Double_t RoundToSignificantFigures(double num, int n) ;
16163c99 64 Bool_t operator==(const AliParticleYield& rhs);
65 Bool_t IsTheSameMeasurement(AliParticleYield &rhs);
2f86df33 66
67 // Getters
68 TString GetCentr() const{ return fCentr ;}
69 Int_t GetCollisionSystem() const{ return fCollisionSystem ;}
70 Int_t GetIsSum() const{ return fIsSum ;}
71 Int_t GetPdgCode() const{ return fPdgCode ;}
72 Int_t GetPdgCode2() const{ return fPdgCode2; }
73 Float_t GetSqrtS() const{ return fSqrtS ;}
74 Float_t GetYield() const{ return fYield ;}
3e8c4dd8 75 Float_t GetNormError() const;
76 Float_t GetNormErrorNeg() const{ return fNormErrorNeg; }
77 Float_t GetNormErrorPos() const{ return fNormErrorPos; }
78
2f86df33 79 TString GetPartName() const{ return fPartName ;}
80 Float_t GetStatError() const{ return fStatError ;}
81 Int_t GetStatus() const{ return fStatus ;}
82 Float_t GetSystError() const{ return fSystError ;}
83 Float_t GetYMax() const{ return fYMax ;}
84 Float_t GetYMin() const{ return fYMin ;}
85 UInt_t GetMeasurementType() const{ return fMeasurementType ;}
86 TString GetTag() const{ return fTag; }
87
88 const char * GetLatexName(Int_t pdg = 0) const;
89 Float_t GetTotalError(Bool_t includeNormalization = kFALSE) const;
90
91 Bool_t IsTypeMeasured() const{ CheckTypeConsistency(); return !(fMeasurementType & kTypeLinearInterpolation);}
92 Bool_t IsTypeRatio() const{ CheckTypeConsistency(); return (fMeasurementType & kTypeParticleRatio);}
93 Bool_t IsTypeLinearInterp() const{ CheckTypeConsistency(); return fMeasurementType & kTypeLinearInterpolation;}
94 Bool_t IsTypeOnlyTotErr() const{ CheckTypeConsistency(); return fMeasurementType & kTypeOnlyTotError; }
95
96 static Int_t GetSignificantDigits() { return fSignificantDigits; }
97
98 // Setters
99 void SetCentr (TString var ) { fCentr = var ;}
100 void SetCollisionSystem (AliPYCSystem_t var ) { fCollisionSystem = var ;}
101 void SetIsSum (Int_t var ) { fIsSum = var ;}
102 void SetPdgCode (Int_t var ) { fPdgCode = var ; SetPartName(var);}
103 void SetPdgCode2 (Int_t var ) { fPdgCode2 = var; }
104 void SetSqrtS (Float_t var ) { fSqrtS = var ;}
105 void SetYield (Float_t var ) { fYield = var ;}
3e8c4dd8 106 void SetNormError (Float_t var ) { fNormErrorPos = var ; fNormErrorNeg=0;};
107 void SetNormErrorNeg (Float_t var ) { fNormErrorNeg = var;}
108 void SetNormErrorPos (Float_t var ) { fNormErrorPos = var;}
2f86df33 109 void SetPartName (TString var ) { fPartName = var; SetPdgCode(var); }
110 void SetStatError (Float_t var ) { fStatError = var ;}
111 void SetStatus (AliPYStatusCode_t var ) { fStatus = var ;}
112 void SetSystError (Float_t var ) { fSystError = var ;}
113 void SetYMax (Float_t var ) { fYMax = var ;}
114 void SetYMin (Float_t var ) { fYMin = var ;}
115 void SetMeasurementType (UInt_t var ) { fMeasurementType = var ;}
116 void SetTag (TString var ) { fTag = var;}
117 //This 2 additional setters will ensure consistency between the pdg code and the name of the particle
118 void SetPartName(Int_t pdgCode);
119 void SetPdgCode (TString partName);
120
121 void SetTypeBits(UInt_t mask) { fMeasurementType |= mask; } // This switches on the bits passed. Does not affect the others! If you want to set the Whole mask, use SetMeasurementType
122
123 static void SetSignificantDigits (Int_t var) { fSignificantDigits = var;}
124
125
126
127
128private:
129
16163c99 130 Bool_t Compare2Floats(Float_t a, Float_t b) ;
131
2f86df33 132 Int_t fPdgCode; // PdgCode
133 Int_t fPdgCode2; // The PdgCode of the second particle, only needed in case of a ratio
134 TString fPartName; // Particle name (redundant, we also have PDG code)
135 Int_t fCollisionSystem; // Collision System, see the AliPYCSystem_t enum for possible values
136 Float_t fSqrtS; // center of mass energy, in GeV
137 Float_t fYield; // The yield
138 Float_t fStatError; // StatError
139 Float_t fSystError; // SystError
3e8c4dd8 140 Float_t fNormErrorPos; // Normalization error, if the error is simmetric, this is used as the symmetric error. Otherwise it is just the positive one
141 Float_t fNormErrorNeg; // Normalization error (negative)
2f86df33 142 Float_t fYMin; // min rapidity cut
143 Float_t fYMax; // max rapidity cut
144 Int_t fStatus; // Status code, to determine the quality of the measurement, see AliPYStatusCode_t for possible values
145
3e8c4dd8 146
147
2f86df33 148 UInt_t fMeasurementType; // Measurement Type, e.g. actually measured, interpolated from 2 centrality bins or only total error given, etc. THIS IS A BIT MASK see AliPYMeasurementType_t for possible values and the IsType* Methods for easy access. Be carefull not to set mutually exclusive values
149
150 TString fCentr; // Centrality. The format is estimator 3-digits id, bin low-edge 2 digits, bin hi-edge 2 digits , e.g. V0A0005
151 Int_t fIsSum; // A flag which indicates if the yield is for a single charge or for the sum. 0 = single charge, 1 = particle + antiparticle
152 TString fTag; // Generic text tag (to be used e.g. for the name of the experiment)
153
154
155 static Int_t fSignificantDigits; // Significant Digits to be used in values and errors
16163c99 156 static Float_t fEpsilon; // Used for float conparisons
2f86df33 157
158 ClassDef(AliParticleYield,1)
159};
160
161
162#endif /* _ALIPARTICLEYIELD_H_ */