From f49fc45d8f70375b1141f34487f3e20aa7061b09 Mon Sep 17 00:00:00 2001 From: cholm Date: Wed, 5 Jan 2011 11:25:48 +0000 Subject: [PATCH] Documentation fixes --- PWG2/FORWARD/analysis2/AliAODForwardMult.cxx | 66 ++++++++++++++++++-- PWG2/FORWARD/analysis2/AliAODForwardMult.h | 34 +++++----- 2 files changed, 81 insertions(+), 19 deletions(-) diff --git a/PWG2/FORWARD/analysis2/AliAODForwardMult.cxx b/PWG2/FORWARD/analysis2/AliAODForwardMult.cxx index 2f1926ab384..ab2adb7e8a8 100644 --- a/PWG2/FORWARD/analysis2/AliAODForwardMult.cxx +++ b/PWG2/FORWARD/analysis2/AliAODForwardMult.cxx @@ -1,3 +1,19 @@ +// +// Class that contains the forward multiplicity data per event +// +// This class contains a histogram of +// @f[ +// \frac{d^2N_{ch}}{d\eta d\phi}\quad, +// @f] +// as well as a trigger mask for each analysed event. +// +// The eta acceptance of the event is stored in the underflow bins of +// the histogram. So to build the final histogram, one needs to +// correct for this acceptance (properly weighted by the events), and +// the vertex efficiency. This simply boils down to defining a 2D +// histogram and summing the event histograms in that histogram. One +// should of course also do proper book-keeping of the accepted event. +// #include "AliAODForwardMult.h" #include #include @@ -14,21 +30,34 @@ const Float_t AliAODForwardMult::fgkInvalidIpZ = 1e6; //____________________________________________________________________ AliAODForwardMult::AliAODForwardMult() - : fHist(), + : fIsMC(false), + fHist(), fTriggers(0), fIpZ(fgkInvalidIpZ) -{} +{ + // + // Constructor + // +} //____________________________________________________________________ -AliAODForwardMult::AliAODForwardMult(Bool_t) - : fHist("forwardMult", "d^{2}N_{ch}/d#etad#varphi in the forward regions", +AliAODForwardMult::AliAODForwardMult(Bool_t isMC) + : fIsMC(isMC), + fHist("forwardMult", "d^{2}N_{ch}/d#etad#varphi in the forward regions", 200, -4, 6, 20, 0, 2*TMath::Pi()), fTriggers(0), fIpZ(fgkInvalidIpZ) { + // + // Constructor + // + // Parameters: + // isMC If set to true this is for MC data (effects branch name) + // fHist.SetXTitle("#eta"); fHist.SetYTitle("#varphi [radians]"); fHist.SetZTitle("#frac{d^{2}N_{ch}}{d#etad#varphi}"); + fHist.SetDirectory(0); fHist.Sumw2(); } @@ -36,6 +65,11 @@ AliAODForwardMult::AliAODForwardMult(Bool_t) void AliAODForwardMult::Init(const TAxis& etaAxis) { + // Initialize the histogram with an eta axis + // + // Parameters: + // etaAxis Eta axis to use + // fHist.SetBins(etaAxis.GetNbins(), etaAxis.GetXmin(), etaAxis.GetXmax(), 20, 0, 2*TMath::Pi()); } @@ -44,6 +78,11 @@ AliAODForwardMult::Init(const TAxis& etaAxis) void AliAODForwardMult::Clear(Option_t* option) { + // Clear (or reset) internal values + // + // Parameters: + // option Passed to TH1::Reset + // fHist.Reset(option); fTriggers = 0; fIpZ = fgkInvalidIpZ; @@ -52,6 +91,11 @@ AliAODForwardMult::Clear(Option_t* option) Bool_t AliAODForwardMult::HasIpZ() const { + // Check if we have valid z coordinate of the interaction point + // + // Return: + // true if the z coordinate of the interaction point is valid + // return TMath::Abs(fIpZ - fgkInvalidIpZ) > 1; } @@ -59,6 +103,10 @@ AliAODForwardMult::HasIpZ() const void AliAODForwardMult::Browse(TBrowser* b) { + // Browse this object + // + // Parameters: + // b Browser to use static TObjString ipz; static TObjString trg; ipz = Form("ip_z=%fcm", fIpZ); @@ -72,6 +120,12 @@ AliAODForwardMult::Browse(TBrowser* b) const Char_t* AliAODForwardMult::GetTriggerString(UInt_t mask) { + // Get a string that describes the triggers + // + // Parameters: + // mask Bit pattern of triggers + // Return: + // Character string representation of mask static TString trg; trg = ""; if ((mask & kInel) != 0x0) trg.Append("INEL "); @@ -88,6 +142,10 @@ AliAODForwardMult::GetTriggerString(UInt_t mask) void AliAODForwardMult::Print(Option_t* option) const { + // Print this object + // + // Parameters: + // option Passed to TH1::Print fHist.Print(option); std::cout << "Ipz: " << fIpZ << "cm " << (HasIpZ() ? "" : "in") << "valid\n" diff --git a/PWG2/FORWARD/analysis2/AliAODForwardMult.h b/PWG2/FORWARD/analysis2/AliAODForwardMult.h index b484097d240..1b303a98fb8 100644 --- a/PWG2/FORWARD/analysis2/AliAODForwardMult.h +++ b/PWG2/FORWARD/analysis2/AliAODForwardMult.h @@ -1,5 +1,8 @@ -#ifndef ALIROOT_PWG2_FORWARD_ANALYSIS_ALIAODFORWARDMULT_H -#define ALIROOT_PWG2_FORWARD_ANALYSIS_ALIAODFORWARDMULT_H +// +// See implementation or Doxygen comments for more information +// +#ifndef ALIAODFORWARDMULT_H +#define ALIAODFORWARDMULT_H #include #include class TBrowser; @@ -117,12 +120,13 @@ public: /** * Constructor * + * @param isMC Whether this was from MC or not */ - AliAODForwardMult(Bool_t); + AliAODForwardMult(Bool_t isMC); /** * Destructor */ - ~AliAODForwardMult() {} + virtual ~AliAODForwardMult() {} // Destructor /** * Initialize * @@ -134,31 +138,31 @@ public: * * @return @f$ d^2N_{ch}/d\eta d\phi@f$ histogram, */ - const TH2D& GetHistogram() const { return fHist; } + const TH2D& GetHistogram() const { return fHist; } // Get histogram /** * Get the @f$ d^2N_{ch}/d\eta d\phi@f$ histogram, * * @return @f$ d^2N_{ch}/d\eta d\phi@f$ histogram, */ - TH2D& GetHistogram() { return fHist; } + TH2D& GetHistogram() { return fHist; } // Get histogram /** * Get the trigger mask * * @return Trigger mask */ - UInt_t GetTriggerMask() const { return fTriggers; } + UInt_t GetTriggerMask() const { return fTriggers; } // Get triggers /** * Set the trigger mask * * @param trg Trigger mask */ - void SetTriggerMask(UInt_t trg) { fTriggers = trg; } + void SetTriggerMask(UInt_t trg) { fTriggers = trg; } // Set triggers /** * Set bit(s) in trigger mask * * @param bits bit(s) to set */ - void SetTriggerBits(UInt_t bits) { fTriggers |= bits; } + void SetTriggerBits(UInt_t bits) { fTriggers |= bits; } // Set trigger bits /** * Check if bit(s) are set in the trigger mask * @@ -170,7 +174,7 @@ public: /** * Whether we have any trigger bits */ - Bool_t HasTrigger() const { return fTriggers != 0; } + Bool_t HasTrigger() const { return fTriggers != 0; } // Check for triggers /** * Clear all data * @@ -188,7 +192,7 @@ public: * * @return Always true */ - Bool_t IsFolder() const { return kTRUE; } + Bool_t IsFolder() const { return kTRUE; } // Always true /** * Print content * @@ -200,13 +204,13 @@ public: * * @param ipZ Interaction point z coordinate */ - void SetIpZ(Float_t ipZ) { fIpZ = ipZ; } + void SetIpZ(Float_t ipZ) { fIpZ = ipZ; } // Set Ip's Z coordinate /** * Set the z coordinate of the interaction point * * @return Interaction point z coordinate */ - Float_t GetIpZ() const { return fIpZ; } + Float_t GetIpZ() const { return fIpZ; } // Get Ip's Z coordinate /** * Check if we have a valid z coordinate of the interaction point * @@ -229,7 +233,7 @@ public: * * @return Name of object */ - const Char_t* GetName() const { return "Forward"; } + const Char_t* GetName() const { return (fIsMC ? "ForwardMC" : "Forward"); } /** * Get a string correspondig to the trigger mask * @@ -239,6 +243,7 @@ public: */ static const Char_t* GetTriggerString(UInt_t mask); protected: + Bool_t fIsMC; // Whether this is from MC TH2D fHist; // Histogram of d^2N_{ch}/(deta dphi) for this event UInt_t fTriggers; // Trigger bit mask Float_t fIpZ; // Z coordinate of the interaction point @@ -260,7 +265,6 @@ AliAODForwardMult::IsTriggerBits(UInt_t bits) const { return HasTrigger() && ((fTriggers & bits) != 0); } - #endif // Local Variables: -- 2.43.0