Fix documentation issues
[u/mrichter/AliRoot.git] / PWGLF / FORWARD / analysis2 / AliForwarddNdetaTask.h
CommitLineData
b2e7f2d6 1//
2// Task to analyse the AOD for for dN/deta in the forward regions
3//
4#ifndef ALIFORWARDDNDETATASK_H
5#define ALIFORWARDDNDETATASK_H
ffca499d 6/**
7 * @file AliForwarddNdetaTask.h
8 * @author Christian Holm Christensen <cholm@dalsgaard.hehi.nbi.dk>
9 * @date Wed Mar 23 14:04:54 2011
10 *
11 * @brief
12 *
13 *
bd6f5206 14 * @ingroup pwglf_forward_dndeta
ffca499d 15 */
4acee65c 16#include "AliBasedNdetaTask.h"
b2e7f2d6 17class TList;
18class TH2D;
19class TH1D;
20
21/**
ffca499d 22 * Tasks to determine @f$ dN/d\eta@f$ in the forward regions
23 *
bd6f5206 24 * @ingroup pwglf_forward_tasks_dndeta
25 * @ingroup pwglf_forward_dndeta
b2e7f2d6 26 */
fe52e455 27class AliForwarddNdetaTask : public AliBasedNdetaTask
b2e7f2d6 28{
29public:
30 /**
31 * Constructor
32 *
33 */
34 AliForwarddNdetaTask();
35 /**
36 * Constructor
37 *
38 * @param name Name of task
b2e7f2d6 39 */
40 AliForwarddNdetaTask(const char* name);
b2e7f2d6 41 /**
42 * Destructor
43 *
44 */
fe52e455 45 virtual ~AliForwarddNdetaTask() {}
b2e7f2d6 46protected:
b2e7f2d6 47 /**
fe52e455 48 * Copy constructor
b2e7f2d6 49 */
fe52e455 50 AliForwarddNdetaTask(const AliForwarddNdetaTask& o);
b2e7f2d6 51 /**
fe52e455 52 * Assigmement operator
b2e7f2d6 53 *
fe52e455 54 * @return Reference to this
b2e7f2d6 55 */
fe52e455 56 AliForwarddNdetaTask& operator=(const AliForwarddNdetaTask&) { return *this; }
57
b2e7f2d6 58 /**
fe52e455 59 * Retrieve the histogram
b2e7f2d6 60 *
fe52e455 61 * @param aod AOD event
62 * @param mc Whether to get the MC histogram or not
63 *
64 * @return Retrieved histogram or null
b2e7f2d6 65 */
fb3430ac 66 TH2D* GetHistogram(const AliAODEvent* aod, Bool_t mc);
9ecab72f 67 /**
68 * Get the colour to use for markers (only pp - in PbPb we use a rainbow)
69 *
70 * @return Marker colour
71 */
72 virtual Int_t GetColor() const { return kRed+2; }
e1f47419 73 /**
74 * Make a new centrality bin
75 *
76 * @param name Histogram names
77 * @param l Lower cut
78 * @param h Upper cut
79 *
80 * @return Newly allocated object (of our type)
81 */
82 AliBasedNdetaTask::CentralityBin*
83 MakeCentralityBin(const char* name, Short_t l, Short_t h) const;
84
badf1074 85 class CentralityBin : public AliBasedNdetaTask::CentralityBin
e1f47419 86 {
badf1074 87 public:
e1f47419 88 /**
89 * Constructor
90 */
9ecab72f 91 CentralityBin() : AliBasedNdetaTask::CentralityBin() {}
e1f47419 92 /**
93 * Constructor
94 *
95 * @param name Name used for histograms (e.g., Forward)
96 * @param low Lower centrality cut in percent
97 * @param high Upper centrality cut in percent
98 */
99 CentralityBin(const char* name, Short_t low, Short_t high)
9ecab72f 100 : AliBasedNdetaTask::CentralityBin(name, low, high)
e1f47419 101 {}
102 /**
103 * Copy constructor
104 *
105 * @param other Object to copy from
106 */
107 CentralityBin(const CentralityBin& other)
9ecab72f 108 : AliBasedNdetaTask::CentralityBin(other)
e1f47419 109 {}
110 /**
111 * Destructor
112 */
113 virtual ~CentralityBin() {}
114 /**
115 * Assignement operator
116 *
117 *
118 * @return
119 */
120 CentralityBin& operator=(const CentralityBin&) { return *this; }
e1f47419 121 /**
122 * End of processing
123 *
124 * @param sums List of sums
125 * @param results Output list of results
ffca499d 126 * @param scheme Normalisation scheme options
e1f47419 127 * @param shapeCorr Shape correction or nil
128 * @param trigEff Trigger efficiency
129 * @param symmetrice Whether to symmetrice the results
130 * @param rebin Whether to rebin the results
c25b5e1b 131 * @param rootProj If true, use TH2::ProjectionX
e1f47419 132 * @param corrEmpty Whether to correct for empty bins
133 * @param cutEdges Whether to cut edges when rebinning
e1f47419 134 * @param triggerMask Trigger mask
ffca499d 135 * @param color Marker colour
136 * @param marker Marker style
c6115ede 137 * @param mclist List of MC results
138 * @param truthlist List of MC truth results
e1f47419 139 */
140 virtual void End(TList* sums,
141 TList* results,
ffca499d 142 UShort_t scheme,
f67d699c 143 const TH2F* shapeCorr,
e1f47419 144 Double_t trigEff,
145 Bool_t symmetrice,
146 Int_t rebin,
c25b5e1b 147 Bool_t rootProj,
e1f47419 148 Bool_t corrEmpty,
149 Bool_t cutEdges,
ffca499d 150 Int_t triggerMask,
9ecab72f 151 Int_t marker,
c89b9ac1 152 Int_t color,
153 TList* mclist,
154 TList* truthlist);
e1f47419 155 protected:
9ecab72f 156 ClassDef(CentralityBin,2); // A centrality bin
e1f47419 157 };
b2e7f2d6 158
9ecab72f 159 ClassDef(AliForwarddNdetaTask,2); // Determine multiplicity in forward region
b2e7f2d6 160};
161
162#endif
fe52e455 163//
164// Local Variables:
165// mode: C++
166// End:
167//