AliPhysics  64f4410 (64f4410)
AliForwardMultiplicityBase Class Referenceabstract

#include <AliForwardMultiplicityBase.h>

Inheritance diagram for AliForwardMultiplicityBase:

Public Types

enum  {
  kTimingEventInspector = 1, kTimingSharingFilter = 2, kTimingDensityCalculator = 3, kTimingCorrections = 4,
  kTimingHistCollector = 5, kTimingEventPlaneFinder = 6, kTimingTotal = 7
}
 
enum  {
  kStatusNoEvent = 1, kStatusNoTrigger, kStatusNoSPD, kStatusNoFMD,
  kStatusNoVertex, kStatusPileup, kStatusSPDOutlier, kStatusIPzOutOfRange,
  kStatusFailSharing, kStatusFailDensity, kStatusFailEventPlane, kStatusOutlier,
  kStatusFailCorrector, kStatusFailCollector, kStatusNotAdded, kStatusAllThrough
}
 

Public Member Functions

virtual void Print (Option_t *option="") const
 
virtual void SetDoTiming (Bool_t enable=true)
 
virtual void SetEnableLowFlux (Bool_t use=true)
 
virtual void SetDebug (Int_t dbg)
 
void SetStorePerRing (Bool_t use)
 
void SetAddMask (UInt_t mask)
 
Interface methods
virtual Bool_t Book ()
 
virtual Bool_t PreData (const TAxis &vertex, const TAxis &eta)
 
virtual Bool_t PostEvent ()
 
virtual Bool_t Finalize ()
 
Access to sub-algorithms
virtual AliFMDESDFixerGetESDFixer ()=0
 
virtual AliFMDSharingFilterGetSharingFilter ()=0
 
virtual AliFMDDensityCalculatorGetDensityCalculator ()=0
 
virtual AliFMDCorrectorGetCorrections ()=0
 
virtual AliFMDHistCollectorGetHistCollector ()=0
 
virtual const AliFMDESDFixerGetESDFixer () const =0
 
virtual const AliFMDSharingFilterGetSharingFilter () const =0
 
virtual const AliFMDDensityCalculatorGetDensityCalculator () const =0
 
virtual const AliFMDCorrectorGetCorrections () const =0
 
virtual const AliFMDHistCollectorGetHistCollector () const =0
 
virtual AliFMDEventPlaneFinderGetEventPlaneFinder ()=0
 
virtual const AliFMDEventPlaneFinderGetEventPlaneFinder () const =0
 
- Public Member Functions inherited from AliBaseESDTask
 AliBaseESDTask ()
 
 AliBaseESDTask (const char *name, const char *title, AliCorrectionManagerBase *manager)
 
virtual Bool_t Connect (const char *sumFile=0, const char *resFile=0)
 
virtual Bool_t Connect (const char *sumFile, const char *resFile, Bool_t old)
 
virtual Bool_t Setup ()
 
virtual void PreCorrections (const AliESDEvent *esd)
 
virtual Bool_t PreEvent ()
 
virtual Bool_t Event (AliESDEvent &esd)=0
 
virtual void SetDebugLevel (Int_t dbg)
 
void SetIPzMethod (const char *str)
 
virtual Bool_t Configure (const char *macro="-default-")
 
virtual AliFMDEventInspectorGetEventInspector ()=0
 
virtual const AliFMDEventInspectorGetEventInspector () const =0
 

Protected Member Functions

 AliForwardMultiplicityBase (const char *name)
 
 AliForwardMultiplicityBase ()
 
 AliForwardMultiplicityBase (const AliForwardMultiplicityBase &o)
 
AliForwardMultiplicityBaseoperator= (const AliForwardMultiplicityBase &o)
 
virtual void InitMembers (const TAxis &pe, const TAxis &pv)
 
virtual void CreateBranches (AliAODHandler *ah)
 
virtual void EstimatedNdeta (const TList *input, TList *output) const
 
virtual Bool_t MakeSimpledNdeta (const TList *input, TList *output, Double_t &nTr, Double_t &nTrVtx, Double_t &nAcc)
 
virtual void MakeRingdNdeta (const TList *input, const char *inName, TList *output, const char *outName, Int_t style=20) const
 
TAxisDefaultEtaAxis () const
 
TAxisDefaultVertexAxis () const
 
- Protected Member Functions inherited from AliBaseESDTask
 AliBaseESDTask (const AliBaseESDTask &o)
 
AliBaseESDTaskoperator= (const AliBaseESDTask &o)
 
virtual Bool_t IsMC () const
 
virtual AliCorrectionManagerBaseGetManager () const
 
virtual AliCorrectionManagerBaseGetManager ()
 
virtual void MarkEventForStore () const
 
virtual Bool_t CheckCorrections (UInt_t what) const
 
virtual Bool_t ReadCorrections (const TAxis *&pe, const TAxis *&pv, Bool_t mc=false, Bool_t sat=false)
 
virtual AliESDEventGetESDEvent ()
 
virtual Bool_t StoreTrainName (Int_t no)
 
virtual const char * DefaultConfig () const
 
void LocalInit ()
 
void UserCreateOutputObjects ()
 
void UserExec (Option_t *option)
 
void Terminate (Option_t *option)
 

Protected Attributes

Bool_t fEnableLowFlux
 
Bool_t fStorePerRing
 
TH2DfHData
 
AliForwardUtil::Histos fHistos
 
AliAODForwardMult fAODFMD
 
AliAODForwardEP fAODEP
 
AliForwardUtil::Histos fRingSums
 
Bool_t fDoTiming
 
TProfile * fHTiming
 
TH1fHStatus
 
UInt_t fAddMask
 
- Protected Attributes inherited from AliBaseESDTask
Bool_t fFirstEvent
 
TListfList
 
TListfResults
 
UInt_t fNeededCorrections
 
UInt_t fExtraCorrections
 
Bool_t fCloneList
 

Detailed Description

Base class for classes that calculate the multiplicity in the forward regions event-by-event

Inputs:
Outputs:
Histograms
Corrections used

Definition at line 62 of file AliForwardMultiplicityBase.h.

Member Enumeration Documentation

anonymous enum

Bins in timing histogram

Enumerator
kTimingEventInspector 
kTimingSharingFilter 
kTimingDensityCalculator 
kTimingCorrections 
kTimingHistCollector 
kTimingEventPlaneFinder 
kTimingTotal 

Definition at line 68 of file AliForwardMultiplicityBase.h.

anonymous enum

Bins in status histogram

Enumerator
kStatusNoEvent 
kStatusNoTrigger 
kStatusNoSPD 
kStatusNoFMD 
kStatusNoVertex 
kStatusPileup 
kStatusSPDOutlier 
kStatusIPzOutOfRange 
kStatusFailSharing 
kStatusFailDensity 
kStatusFailEventPlane 
kStatusOutlier 
kStatusFailCorrector 
kStatusFailCollector 
kStatusNotAdded 
kStatusAllThrough 

Definition at line 80 of file AliForwardMultiplicityBase.h.

Constructor & Destructor Documentation

AliForwardMultiplicityBase::AliForwardMultiplicityBase ( const char *  name)
protected

Constructor

Parameters
nameName of task

Definition at line 49 of file AliForwardMultiplicityBase.cxx.

AliForwardMultiplicityBase::AliForwardMultiplicityBase ( )
inlineprotected

Constructor

Definition at line 274 of file AliForwardMultiplicityBase.h.

Referenced by SetAddMask().

AliForwardMultiplicityBase::AliForwardMultiplicityBase ( const AliForwardMultiplicityBase o)
protected

Copy constructor

Parameters
oObject to copy from

Member Function Documentation

Bool_t AliForwardMultiplicityBase::Book ( )
virtual

Create output objects

Returns
true on success

Implements AliBaseESDTask.

Reimplemented in AliForwardMCMultiplicityTask.

Definition at line 91 of file AliForwardMultiplicityBase.cxx.

Referenced by AliForwardMCMultiplicityTask::Book().

void AliForwardMultiplicityBase::CreateBranches ( AliAODHandler *  ah)
protectedvirtual

Create output branches - called from UserCreateOutputObjects

Reimplemented from AliBaseESDTask.

Reimplemented in AliForwardMCMultiplicityTask.

Definition at line 183 of file AliForwardMultiplicityBase.cxx.

Referenced by AliForwardMultiplicityBase(), and AliForwardMCMultiplicityTask::CreateBranches().

TAxis* AliForwardMultiplicityBase::DefaultEtaAxis ( ) const
inlineprotectedvirtual

Set the default eta axis to use in case we didn't get one from the read-in corretions. Override this if the sub class should go on even without a valid eta axis from the corrections (e.g. QA task)

Returns
null

Reimplemented from AliBaseESDTask.

Definition at line 352 of file AliForwardMultiplicityBase.h.

TAxis* AliForwardMultiplicityBase::DefaultVertexAxis ( ) const
inlineprotectedvirtual

Set the default eta axis to use in case we didn't get one from the read-in corretions. Override this if the sub class should go on even without a valid eta axis from the corrections (e.g. QA task)

Returns
null

Reimplemented from AliBaseESDTask.

Definition at line 353 of file AliForwardMultiplicityBase.h.

void AliForwardMultiplicityBase::EstimatedNdeta ( const TList input,
TList output 
) const
protectedvirtual

Do estimates of \(dN/d\eta\) - called at Terminate

Parameters
inputInput list
outputOutput list

Reimplemented in AliForwardMCMultiplicityTask.

Definition at line 360 of file AliForwardMultiplicityBase.cxx.

Referenced by AliForwardMultiplicityBase(), AliForwardMCMultiplicityTask::EstimatedNdeta(), and Finalize().

Bool_t AliForwardMultiplicityBase::Finalize ( )
virtual

End of job

Returns
true on success

Reimplemented from AliBaseESDTask.

Definition at line 319 of file AliForwardMultiplicityBase.cxx.

virtual AliFMDCorrector& AliForwardMultiplicityBase::GetCorrections ( )
pure virtual

Get reference to the Corrections algorithm

Returns
Reference to AliFMDCorrector object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

Referenced by Book(), Finalize(), ForwardAODConfig(), PreData(), Print(), SetDebug(), SetEnableLowFlux(), and TunedConfig().

virtual const AliFMDCorrector& AliForwardMultiplicityBase::GetCorrections ( ) const
pure virtual

Get reference to the Corrections algorithm

Returns
Reference to AliFMDCorrector object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

virtual AliFMDDensityCalculator& AliForwardMultiplicityBase::GetDensityCalculator ( )
pure virtual

Get reference to the DensityCalculator algorithm

Returns
Reference to AliFMDDensityCalculator object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

Referenced by Book(), Finalize(), ForwardAODConfig(), PreData(), Print(), SetDebug(), SetEnableLowFlux(), and TunedConfig().

virtual const AliFMDDensityCalculator& AliForwardMultiplicityBase::GetDensityCalculator ( ) const
pure virtual

Get reference to the DensityCalculator algorithm

Returns
Reference to AliFMDDensityCalculator object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

virtual AliFMDESDFixer& AliForwardMultiplicityBase::GetESDFixer ( )
pure virtual

Get a reference to the event inspector. User must override this to return proper object

Returns
Reference to the event inspector Get a reference to the event inspector. User must override this to return proper object
Reference to the event inspector Get reference to the ESDFixer algorithm
Reference to AliFMDESDFixer object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

Referenced by AddTaskForwardMult(), Book(), ForwardAODConfig(), Print(), SetEnableLowFlux(), and TunedConfig().

virtual const AliFMDESDFixer& AliForwardMultiplicityBase::GetESDFixer ( ) const
pure virtual

Get reference to the ESDFixer algorithm

Returns
Reference to AliFMDESDFixer object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

virtual AliFMDEventPlaneFinder& AliForwardMultiplicityBase::GetEventPlaneFinder ( )
pure virtual

Get reference to the EventPlaneFinder algorithm

Returns
Reference to AliFMDEventPlaneFinder object

Implemented in AliForwardMultiplicityTask, and AliForwardMCMultiplicityTask.

Referenced by Book(), ForwardAODConfig(), PreData(), Print(), SetDebug(), SetEnableLowFlux(), and TunedConfig().

virtual const AliFMDEventPlaneFinder& AliForwardMultiplicityBase::GetEventPlaneFinder ( ) const
pure virtual

Get reference to the EventPlaneFinder algorithm

Returns
Reference to AliFMDEventPlaneFinder object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

virtual AliFMDHistCollector& AliForwardMultiplicityBase::GetHistCollector ( )
pure virtual

Get reference to the HistCollector algorithm

Returns
Reference to AliFMDHistCollector object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

Referenced by Book(), ForwardAODConfig(), PreData(), Print(), SetDebug(), SetEnableLowFlux(), and TunedConfig().

virtual const AliFMDHistCollector& AliForwardMultiplicityBase::GetHistCollector ( ) const
pure virtual

Get reference to the HistCollector algorithm

Returns
Reference to AliFMDHistCollector object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

virtual AliFMDSharingFilter& AliForwardMultiplicityBase::GetSharingFilter ( )
pure virtual

Get reference to the SharingFilter algorithm

Returns
Reference to AliFMDSharingFilter object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

Referenced by Book(), Finalize(), ForwardAODConfig(), PreData(), Print(), SetDebug(), SetEnableLowFlux(), and TunedConfig().

virtual const AliFMDSharingFilter& AliForwardMultiplicityBase::GetSharingFilter ( ) const
pure virtual

Get reference to the SharingFilter algorithm

Returns
Reference to AliFMDSharingFilter object

Implemented in AliForwardMCMultiplicityTask, and AliForwardMultiplicityTask.

void AliForwardMultiplicityBase::InitMembers ( const TAxis pe,
const TAxis pv 
)
protectedvirtual

Initialize members based on eta and vertex axis - only available after first event - called from SetupForData.

Parameters
pe\(\eta\) axis
pvInteraction point Z-coordinate axis

Reimplemented in AliForwardMCMultiplicityTask.

Definition at line 282 of file AliForwardMultiplicityBase.cxx.

Referenced by AliForwardMultiplicityBase(), AliForwardMCMultiplicityTask::InitMembers(), and PreData().

void AliForwardMultiplicityBase::MakeRingdNdeta ( const TList input,
const char *  inName,
TList output,
const char *  outName,
Int_t  style = 20 
) const
protectedvirtual

Make Ring \( dN/d\eta \) histogram and a stack

Parameters
inputList with summed signals
outputOutput list
inNameInput name
outNameOutput name
styleStyle

Definition at line 472 of file AliForwardMultiplicityBase.cxx.

Referenced by AliForwardMultiplicityBase(), AliForwardMCMultiplicityTask::EstimatedNdeta(), and EstimatedNdeta().

Bool_t AliForwardMultiplicityBase::MakeSimpledNdeta ( const TList input,
TList output,
Double_t nTr,
Double_t nTrVtx,
Double_t nAcc 
)
protectedvirtual

Calculate a simple dN/deta from all accepted events

Parameters
inputInput list
outputOutput list
nTrOn return, number of triggers
nTrVtxOn return, number of trigger+vertex events
nAccOn return, number of accepted events
Returns
true on success

Definition at line 368 of file AliForwardMultiplicityBase.cxx.

Referenced by AliForwardMultiplicityBase(), and Finalize().

AliForwardMultiplicityBase& AliForwardMultiplicityBase::operator= ( const AliForwardMultiplicityBase o)
protected

Assignment operator

Parameters
oObject to assign from
Returns
Reference to this object

Referenced by AliForwardMultiplicityBase().

Bool_t AliForwardMultiplicityBase::PostEvent ( )
virtual

Called after processing a single event - should not do anything but clear data, etc.

Returns
true on success

Reimplemented from AliBaseESDTask.

Reimplemented in AliForwardMCMultiplicityTask.

Definition at line 312 of file AliForwardMultiplicityBase.cxx.

Referenced by AliForwardMCMultiplicityTask::PostEvent().

Bool_t AliForwardMultiplicityBase::PreData ( const TAxis vertex,
const TAxis eta 
)
virtual

Initialise the sub objects and stuff. Called on first event

Parameters
vertexVertex axis to use
etaEta axis to use
Returns
false on errors

Reimplemented from AliBaseESDTask.

Definition at line 207 of file AliForwardMultiplicityBase.cxx.

void AliForwardMultiplicityBase::Print ( Option_t option = "") const
virtual

Print information

Parameters
optionNot used

Reimplemented from AliBaseESDTask.

Definition at line 594 of file AliForwardMultiplicityBase.cxx.

void AliForwardMultiplicityBase::SetAddMask ( UInt_t  mask)
inline

For which triggers to add internally

Parameters
maskTrigger mask as defined in AliAODForwardMult

Definition at line 263 of file AliForwardMultiplicityBase.h.

Referenced by TunedConfig().

void AliForwardMultiplicityBase::SetDebug ( Int_t  dbg)
virtual

Set the debug level

Parameters
dbg

Reimplemented from AliBaseESDTask.

Definition at line 73 of file AliForwardMultiplicityBase.cxx.

Referenced by SetEnableLowFlux().

virtual void AliForwardMultiplicityBase::SetDoTiming ( Bool_t  enable = true)
inlinevirtual

Set whether to make a timing histogram

Parameters
enable

Reimplemented in AliForwardMultiplicityTask.

Definition at line 144 of file AliForwardMultiplicityBase.h.

virtual void AliForwardMultiplicityBase::SetEnableLowFlux ( Bool_t  use = true)
inlinevirtual

Whether to enable low-flux code

Parameters
useIF true, enable low-flux code

Definition at line 150 of file AliForwardMultiplicityBase.h.

Referenced by ForwardAODConfig(), and TunedConfig().

void AliForwardMultiplicityBase::SetStorePerRing ( Bool_t  use)
inline

Set whether to make separate branches for each ring. If enabled there will be 5 additional branches on the AOD tree - each holding a TH2D object of the charged particle multiplicity in \((\eta,\varphi)\) bins for that event.

Parameters
useIf true, make separate branches for each ring.

Definition at line 257 of file AliForwardMultiplicityBase.h.

Referenced by ForwardAODConfig(), and TunedConfig().

Member Data Documentation

UInt_t AliForwardMultiplicityBase::fAddMask
protected
Bool_t AliForwardMultiplicityBase::fDoTiming
protected
Bool_t AliForwardMultiplicityBase::fEnableLowFlux
protected
TH2D* AliForwardMultiplicityBase::fHData
protected
TH1* AliForwardMultiplicityBase::fHStatus
protected
TProfile* AliForwardMultiplicityBase::fHTiming
protected

Definition at line 363 of file AliForwardMultiplicityBase.h.

Referenced by Book().

AliForwardUtil::Histos AliForwardMultiplicityBase::fRingSums
protected
Bool_t AliForwardMultiplicityBase::fStorePerRing
protected

Definition at line 355 of file AliForwardMultiplicityBase.h.

Referenced by CreateBranches(), Print(), and SetStorePerRing().


The documentation for this class was generated from the following files: