]>
Commit | Line | Data |
---|---|---|
f49fc45d | 1 | // |
2 | // See implementation or Doxygen comments for more information | |
3 | // | |
4 | #ifndef ALIAODFORWARDMULT_H | |
5 | #define ALIAODFORWARDMULT_H | |
ffca499d | 6 | /** |
7 | * @file AliAODForwardMult.h | |
8 | * @author Christian Holm Christensen <cholm@dalsgaard.hehi.nbi.dk> | |
9 | * @date Wed Mar 23 13:58:00 2011 | |
10 | * | |
11 | * @brief | |
12 | * | |
bd6f5206 | 13 | * @ingroup pwglf_forward_aod |
ffca499d | 14 | * |
15 | */ | |
7e4038b5 | 16 | #include <TObject.h> |
17 | #include <TH2D.h> | |
18 | class TBrowser; | |
e938e22b | 19 | class TH1I; |
7e4038b5 | 20 | /** |
21 | * Class that contains the forward multiplicity data per event | |
22 | * | |
23 | * This class contains a histogram of | |
24 | * @f[ | |
25 | * \frac{d^2N_{ch}}{d\eta d\phi}\quad, | |
26 | * @f] | |
27 | * as well as a trigger mask for each analysed event. | |
28 | * | |
29 | * The eta acceptance of the event is stored in the underflow bins of | |
30 | * the histogram. So to build the final histogram, one needs to | |
31 | * correct for this acceptance (properly weighted by the events), and | |
32 | * the vertex efficiency. This simply boils down to defining a 2D | |
33 | * histogram and summing the event histograms in that histogram. One | |
34 | * should of course also do proper book-keeping of the accepted event. | |
35 | * | |
36 | * @code | |
fa4236ed | 37 | * TTree* GetAODTree() |
38 | * { | |
39 | * TFile* file = TFile::Open("AliAODs.root","READ"); | |
40 | * TTree* tree = static_cast<TTree*>(file->Get("aodTree")); | |
41 | * return tree; | |
42 | * } | |
43 | * | |
44 | * void Analyse() | |
45 | * { | |
46 | * TH2D* sum = 0; // Summed hist | |
47 | * TTree* tree = GetAODTree(); // AOD tree | |
48 | * AliAODForwardMult* mult = 0; // AOD object | |
49 | * Int_t nTriggered = 0; // # of triggered ev. | |
50 | * Int_t nWithVertex= 0; // # of ev. w/vertex | |
51 | * Int_t nAccepted = 0; // # of ev. used | |
52 | * Int_t nAvailable = tree->GetEntries(); // How many entries | |
53 | * Float_t vzLow = -10; // Lower ip cut | |
54 | * Float_t vzHigh = 10; // Upper ip cut | |
55 | * Int_t mask = AliAODForwardMult::kInel;// Trigger mask | |
56 | * tree->SetBranchAddress("forward", &forward); // Set the address | |
7e4038b5 | 57 | * |
58 | * for (int i = 0; i < nAvailable; i++) { | |
59 | * // Create sum histogram on first event - to match binning to input | |
60 | * if (!sum) sum = static_cast<TH2D*>(mult->Clone("d2ndetadphi")); | |
61 | * | |
62 | * tree->GetEntry(i); | |
63 | * | |
64 | * // Other trigger/event requirements could be defined | |
65 | * if (!mult->IsTriggerBits(mask)) continue; | |
66 | * nTriggered++; | |
fa4236ed | 67 | * |
68 | * // Check if we have vertex | |
69 | * if (!mult->HasIpZ()) continue; | |
70 | * nWithVertex++; | |
7e4038b5 | 71 | * |
72 | * // Select vertex range (in centimeters) | |
73 | * if (!mult->InRange(vzLow, vzHigh) continue; | |
74 | * nAccepted++; | |
75 | * | |
76 | * // Add contribution from this event | |
77 | * sum->Add(&(mult->GetHistogram())); | |
78 | * } | |
79 | * | |
80 | * // Get acceptance normalisation from underflow bins | |
81 | * TH1D* norm = sum->Projection("norm", 0, 1, ""); | |
82 | * // Project onto eta axis - _ignoring_underflow_bins_! | |
83 | * TH1D* dndeta = sum->Projection("dndeta", 1, -1, "e"); | |
84 | * // Normalize to the acceptance | |
85 | * dndeta->Divide(norm); | |
86 | * // Scale by the vertex efficiency | |
fa4236ed | 87 | * dndeta->Scale(Double_t(nWithVertex)/nTriggered, "width"); |
7e4038b5 | 88 | * // And draw the result |
89 | * dndeta->Draw(); | |
fa4236ed | 90 | * } |
7e4038b5 | 91 | * @endcode |
92 | * | |
93 | * The above code will draw the final @f$ dN_{ch}/d\eta@f$ for the | |
94 | * selected event class and vertex range | |
95 | * | |
96 | * The histogram can be used as input for other kinds of analysis too, | |
97 | * like flow, event-plane, centrality, and so on. | |
98 | * | |
bd6f5206 | 99 | * @ingroup pwglf_forward |
100 | * @ingroup pwglf_forward_aod | |
7e4038b5 | 101 | */ |
102 | class AliAODForwardMult : public TObject | |
103 | { | |
104 | public: | |
105 | /** | |
106 | * Bits of the trigger pattern | |
107 | */ | |
108 | enum { | |
109 | /** In-elastic collision */ | |
110 | kInel = 0x001, | |
111 | /** In-elastic collision with at least one SPD tracklet */ | |
112 | kInelGt0 = 0x002, | |
113 | /** Non-single diffractive collision */ | |
114 | kNSD = 0x004, | |
115 | /** Empty bunch crossing */ | |
116 | kEmpty = 0x008, | |
117 | /** A-side trigger */ | |
118 | kA = 0x010, | |
119 | /** B(arrel) trigger */ | |
120 | kB = 0x020, | |
121 | /** C-side trigger */ | |
122 | kC = 0x080, | |
123 | /** Empty trigger */ | |
e58000b7 | 124 | kE = 0x100, |
125 | /** pileup from SPD */ | |
126 | kPileUp = 0x200, | |
127 | /** true NSD from MC */ | |
0be6c8cd | 128 | kMCNSD = 0x400, |
129 | /** Offline MB triggered */ | |
5bb5d1f6 | 130 | kOffline = 0x800, |
131 | /** At least one SPD cluster */ | |
e6463868 | 132 | kNClusterGt0 = 0x1000, |
133 | /** V0-AND trigger */ | |
134 | kV0AND | |
7e4038b5 | 135 | }; |
e938e22b | 136 | /** |
137 | * Bin numbers in trigger histograms | |
138 | */ | |
139 | enum { | |
140 | kBinAll=1, | |
141 | kBinInel, | |
142 | kBinInelGt0, | |
143 | kBinNSD, | |
e6463868 | 144 | kBinV0AND, |
e938e22b | 145 | kBinA, |
146 | kBinB, | |
147 | kBinC, | |
148 | kBinE, | |
149 | kBinPileUp, | |
150 | kBinMCNSD, | |
0be6c8cd | 151 | kBinOffline, |
5bb5d1f6 | 152 | kBinNClusterGt0, |
e938e22b | 153 | kWithTrigger, |
154 | kWithVertex, | |
155 | kAccepted | |
156 | }; | |
7e4038b5 | 157 | /** |
158 | * Default constructor | |
159 | * | |
160 | * Used by ROOT I/O sub-system - do not use | |
161 | */ | |
162 | AliAODForwardMult(); | |
163 | /** | |
164 | * Constructor | |
165 | * | |
f49fc45d | 166 | * @param isMC Whether this was from MC or not |
7e4038b5 | 167 | */ |
f49fc45d | 168 | AliAODForwardMult(Bool_t isMC); |
7e4038b5 | 169 | /** |
170 | * Destructor | |
171 | */ | |
f49fc45d | 172 | virtual ~AliAODForwardMult() {} // Destructor |
7e4038b5 | 173 | /** |
174 | * Initialize | |
175 | * | |
176 | * @param etaAxis Pseudo-rapidity axis | |
177 | */ | |
178 | void Init(const TAxis& etaAxis); | |
179 | /** | |
180 | * Get the @f$ d^2N_{ch}/d\eta d\phi@f$ histogram, | |
181 | * | |
182 | * @return @f$ d^2N_{ch}/d\eta d\phi@f$ histogram, | |
183 | */ | |
f49fc45d | 184 | const TH2D& GetHistogram() const { return fHist; } // Get histogram |
7e4038b5 | 185 | /** |
186 | * Get the @f$ d^2N_{ch}/d\eta d\phi@f$ histogram, | |
187 | * | |
188 | * @return @f$ d^2N_{ch}/d\eta d\phi@f$ histogram, | |
189 | */ | |
f49fc45d | 190 | TH2D& GetHistogram() { return fHist; } // Get histogram |
7e4038b5 | 191 | /** |
9453b19e | 192 | * Get the trigger bits |
7e4038b5 | 193 | * |
9453b19e | 194 | * @return Trigger bits |
7e4038b5 | 195 | */ |
9453b19e | 196 | UInt_t GetTriggerBits() const { return fTriggers; } // Get triggers |
7e4038b5 | 197 | /** |
198 | * Set the trigger mask | |
199 | * | |
200 | * @param trg Trigger mask | |
201 | */ | |
f49fc45d | 202 | void SetTriggerMask(UInt_t trg) { fTriggers = trg; } // Set triggers |
7e4038b5 | 203 | /** |
204 | * Set bit(s) in trigger mask | |
205 | * | |
206 | * @param bits bit(s) to set | |
207 | */ | |
f49fc45d | 208 | void SetTriggerBits(UInt_t bits) { fTriggers |= bits; } // Set trigger bits |
7e4038b5 | 209 | /** |
5bb5d1f6 | 210 | * Check if all bit(s) are set in the trigger mask. Note, this is |
211 | * an @e and between the bits. If you need an @e or you should use | |
212 | * the member function IsTriggerOrBits | |
7e4038b5 | 213 | * |
214 | * @param bits Bits to test for | |
215 | * | |
5bb5d1f6 | 216 | * @return true if all enabled bits in the argument is also set in |
217 | * the trigger word | |
7e4038b5 | 218 | */ |
219 | Bool_t IsTriggerBits(UInt_t bits) const; | |
5bb5d1f6 | 220 | /** |
221 | * Check if any of bit(s) are enabled in the trigger word. This is | |
222 | * an @e or between the selected bits. If you need and @a and you | |
223 | * should use the member function IsTriggerBits; | |
224 | * | |
225 | * @param bits Bits to check for | |
226 | * | |
227 | * @return true if any of the enabled bits in the arguments are also | |
228 | * enabled in the trigger mask | |
229 | */ | |
230 | Bool_t IsTriggerOrBits(UInt_t bits) const; | |
7e4038b5 | 231 | /** |
232 | * Whether we have any trigger bits | |
233 | */ | |
f49fc45d | 234 | Bool_t HasTrigger() const { return fTriggers != 0; } // Check for triggers |
7e4038b5 | 235 | /** |
236 | * Clear all data | |
237 | * | |
238 | * @param option Passed on to TH2::Reset verbatim | |
239 | */ | |
240 | void Clear(Option_t* option=""); | |
241 | /** | |
242 | * browse this object | |
243 | * | |
244 | * @param b Browser | |
245 | */ | |
246 | void Browse(TBrowser* b); | |
247 | /** | |
248 | * This is a folder | |
249 | * | |
250 | * @return Always true | |
251 | */ | |
f49fc45d | 252 | Bool_t IsFolder() const { return kTRUE; } // Always true |
7e4038b5 | 253 | /** |
254 | * Print content | |
255 | * | |
256 | * @param option Passed verbatim to TH2::Print | |
257 | */ | |
258 | void Print(Option_t* option="") const; | |
259 | /** | |
260 | * Set the z coordinate of the interaction point | |
261 | * | |
262 | * @param ipZ Interaction point z coordinate | |
263 | */ | |
f49fc45d | 264 | void SetIpZ(Float_t ipZ) { fIpZ = ipZ; } // Set Ip's Z coordinate |
b2e7f2d6 | 265 | /** |
266 | * Set the center of mass energy per nucleon-pair. This is stored | |
267 | * in the (0,0) of the histogram | |
268 | * | |
269 | * @param sNN Center of mass energy per nucleon pair (GeV) | |
270 | */ | |
271 | void SetSNN(UShort_t sNN); | |
272 | /** | |
273 | * Get the collision system number | |
274 | * - 0: Unknown | |
275 | * - 1: pp | |
276 | * - 2: PbPb | |
277 | * | |
278 | * @param sys Collision system number | |
279 | */ | |
280 | void SetSystem(UShort_t sys); | |
e58000b7 | 281 | /** |
282 | * Set the event centrality | |
283 | * | |
284 | * @param c Centrality | |
285 | */ | |
286 | void SetCentrality(Float_t c) { fCentrality = c; } | |
7e4038b5 | 287 | /** |
288 | * Set the z coordinate of the interaction point | |
289 | * | |
290 | * @return Interaction point z coordinate | |
291 | */ | |
f49fc45d | 292 | Float_t GetIpZ() const { return fIpZ; } // Get Ip's Z coordinate |
7e4038b5 | 293 | /** |
294 | * Check if we have a valid z coordinate of the interaction point | |
295 | * | |
296 | * @return True if we have a valid interaction point z coordinate | |
297 | */ | |
298 | Bool_t HasIpZ() const; | |
b2e7f2d6 | 299 | /** |
300 | * Get the center of mass energy per nucleon pair (GeV) | |
301 | * | |
302 | * @return Center of mass energy per nucleon pair (GeV) | |
303 | */ | |
304 | UShort_t GetSNN() const; | |
305 | /** | |
306 | * Get the collision system number | |
307 | * - 0: Unknown | |
308 | * - 1: pp | |
309 | * - 2: PbPb | |
310 | * | |
311 | * @return Collision system number | |
312 | */ | |
313 | UShort_t GetSystem() const; | |
7e4038b5 | 314 | /** |
315 | * Check if the z coordinate of the interaction point is within the | |
316 | * given limits. Note that the convention used corresponds to the | |
317 | * convention used in ROOTs TAxis. | |
318 | * | |
319 | * @param low Lower cut (inclusive) | |
320 | * @param high Upper cut (exclusive) | |
321 | * | |
322 | * @return true if @f$ low \ge ipz < high@f$ | |
323 | */ | |
324 | Bool_t InRange(Float_t low, Float_t high) const; | |
e58000b7 | 325 | /** |
326 | * Get the event centrality | |
327 | * | |
328 | * | |
329 | * @return | |
330 | */ | |
331 | Float_t GetCentrality() const { return fCentrality; } | |
332 | /** | |
333 | * Check if we have a valid centrality | |
334 | * | |
335 | * | |
336 | * @return | |
337 | */ | |
338 | Bool_t HasCentrality() const { return !(fCentrality < 0); } | |
5bb5d1f6 | 339 | /** |
340 | * Get the number of SPD clusters seen in @f$ |\eta|<1@f$ | |
341 | * | |
342 | * @return Number of SPD clusters seen | |
343 | */ | |
344 | UShort_t GetNClusters() const { return fNClusters; } | |
345 | /** | |
346 | * Set the number of SPD clusters seen in @f$ |\eta|<1@f$ | |
347 | * | |
348 | * @param n Number of SPD clusters | |
349 | */ | |
350 | void SetNClusters(UShort_t n) { fNClusters = n; } | |
7e4038b5 | 351 | /** |
352 | * Get the name of the object | |
353 | * | |
354 | * @return Name of object | |
355 | */ | |
f49fc45d | 356 | const Char_t* GetName() const { return (fIsMC ? "ForwardMC" : "Forward"); } |
e938e22b | 357 | /** |
ffca499d | 358 | * Check if event meets the passses requirements. |
359 | * | |
360 | * It returns true if @e all of the following is true | |
361 | * | |
362 | * - The trigger is within the bit mask passed. | |
363 | * - The vertex is within the specified limits. | |
364 | * - The centrality is within the specified limits, or if lower | |
365 | * limit is equal to or larger than the upper limit. | |
366 | * | |
950ab33b | 367 | * Note, for data with out a centrality estimate (e.g., pp), one |
368 | * must pass equal centrality cuts, or no data will be accepted. In | |
369 | * other words, for pp data, always pass cMin=0, cMax=0 | |
370 | * | |
ffca499d | 371 | * If a histogram is passed in the last parameter, then that |
372 | * histogram is filled with the trigger bits. | |
e938e22b | 373 | * |
374 | * @param triggerMask Trigger mask | |
375 | * @param vzMin Minimum @f$ v_z@f$ (in centimeters) | |
376 | * @param vzMax Maximum @f$ v_z@f$ (in centimeters) | |
377 | * @param cMin Minimum centrality (in percent) | |
378 | * @param cMax Maximum centrality (in percent) | |
379 | * @param hist Histogram to fill | |
380 | * | |
381 | * @return @c true if the event meets the requirements | |
382 | */ | |
383 | Bool_t CheckEvent(Int_t triggerMask=kInel, | |
384 | Double_t vzMin=-10, Double_t vzMax=10, | |
385 | UShort_t cMin=0, UShort_t cMax=100, | |
386 | TH1* hist=0) const; | |
7e4038b5 | 387 | /** |
388 | * Get a string correspondig to the trigger mask | |
389 | * | |
390 | * @param mask Trigger mask | |
391 | * | |
392 | * @return Static string (copy before use) | |
393 | */ | |
394 | static const Char_t* GetTriggerString(UInt_t mask); | |
e938e22b | 395 | /** |
ffca499d | 396 | * Make a histogram to record triggers in. |
397 | * | |
398 | * The bins defined by the trigger enumeration in this class. One | |
399 | * can use this enumeration to retrieve the number of triggers for | |
400 | * each class. | |
e938e22b | 401 | * |
402 | * @param name Name of the histogram | |
403 | * | |
404 | * @return Newly allocated histogram | |
405 | */ | |
ffca499d | 406 | static TH1I* MakeTriggerHistogram(const char* name="triggers"); |
9453b19e | 407 | /** |
408 | * Utility function to make a trigger mask from the passed string. | |
409 | * | |
410 | * The string is a comma or space seperated list of case-insensitive | |
411 | * strings | |
412 | * | |
413 | * - INEL | |
414 | * - INEL>0 | |
415 | * - NSD | |
416 | * | |
417 | * @param what Which triggers to put in the mask. | |
418 | * | |
419 | * @return The generated trigger mask. | |
420 | */ | |
421 | static UInt_t MakeTriggerMask(const char* what); | |
7e4038b5 | 422 | protected: |
5bb5d1f6 | 423 | Bool_t fIsMC; // Whether this is from MC |
424 | TH2D fHist; // Histogram of d^2N_{ch}/(deta dphi) for this event | |
425 | UInt_t fTriggers; // Trigger bit mask | |
426 | Float_t fIpZ; // Z coordinate of the interaction point | |
427 | Float_t fCentrality; // Event centrality | |
428 | UShort_t fNClusters; // Number of SPD clusters in |eta|<1 | |
7e4038b5 | 429 | |
430 | static const Float_t fgkInvalidIpZ; // Invalid IpZ value | |
5bb5d1f6 | 431 | ClassDef(AliAODForwardMult,3); // AOD forward multiplicity |
7e4038b5 | 432 | }; |
433 | ||
434 | //____________________________________________________________________ | |
435 | inline Bool_t | |
436 | AliAODForwardMult::InRange(Float_t low, Float_t high) const | |
437 | { | |
438 | return HasIpZ() && fIpZ >= low && fIpZ < high; | |
439 | } | |
440 | ||
441 | //____________________________________________________________________ | |
442 | inline Bool_t | |
443 | AliAODForwardMult::IsTriggerBits(UInt_t bits) const | |
444 | { | |
0be6c8cd | 445 | return HasTrigger() && ((fTriggers & bits) == bits); |
7e4038b5 | 446 | } |
5bb5d1f6 | 447 | //____________________________________________________________________ |
448 | inline Bool_t | |
449 | AliAODForwardMult::IsTriggerOrBits(UInt_t bits) const | |
450 | { | |
451 | return HasTrigger() && ((fTriggers & bits) != 0); | |
452 | } | |
7e4038b5 | 453 | |
454 | #endif | |
455 | // Local Variables: | |
456 | // mode: C++ | |
457 | // End: | |
458 |