Container structure for EMCAL clusters. More...

#include <AliClusterContainer.h>

Inheritance diagram for AliClusterContainer:

Public Types
typedef enum AliVCluster::VCluUserDefEnergy_t	VCluUserDefEnergy_t

Public Member Functions
	AliClusterContainer ()

	AliClusterContainer (const char *name)

virtual	~AliClusterContainer ()

virtual TObject *	operator[] (int index) const

virtual Bool_t	AcceptObject (Int_t i, UInt_t &rejectionReason) const

virtual Bool_t	AcceptObject (const TObject *obj, UInt_t &rejectionReason) const

virtual Bool_t	AcceptCluster (Int_t i, UInt_t &rejectionReason) const

virtual Bool_t	AcceptCluster (const AliVCluster *vp, UInt_t &rejectionReason) const

virtual Bool_t	ApplyClusterCuts (const AliVCluster *clus, UInt_t &rejectionReason) const

AliVCluster *	GetAcceptCluster (Int_t i) const

AliVCluster *	GetAcceptClusterWithLabel (Int_t lab) const

void	SetClusECut (Double_t cut)

void	SetClusPtCut (Double_t cut)

Double_t	GetClusPtCut () const

AliVCluster *	GetCluster (Int_t i) const

AliVCluster *	GetClusterWithLabel (Int_t lab) const

AliVCluster *	GetLeadingCluster (const char *opt="")

Bool_t	GetMomentum (TLorentzVector &mom, const AliVCluster *vc, Double_t mass) const

Bool_t	GetMomentum (TLorentzVector &mom, const AliVCluster *clus) const

Bool_t	GetMomentum (TLorentzVector &mom, Int_t i) const

Bool_t	GetAcceptMomentum (TLorentzVector &mom, Int_t i) const

Bool_t	GetNextMomentum (TLorentzVector &mom)

Bool_t	GetNextAcceptMomentum (TLorentzVector &mom)

AliVCluster *	GetNextAcceptCluster ()

AliVCluster *	GetNextCluster ()

Int_t	GetNClusters () const

Int_t	GetNAcceptedClusters () const

void	SetClusTimeCut (Double_t min, Double_t max)

void	SetMinMCLabel (Int_t s)

void	SetMaxMCLabel (Int_t s)

void	SetMCLabelRange (Int_t min, Int_t max)

void	SetExoticCut (Bool_t e)

void	SetIncludePHOS (Bool_t b)

void	SetArray (const AliVEvent *event)

void	SetClusUserDefEnergyCut (Int_t t, Double_t cut)

Double_t	GetClusUserDefEnergyCut (Int_t t) const

void	SetClusNonLinCorrEnergyCut (Double_t cut)

void	SetClusHadCorrEnergyCut (Double_t cut)

void	SetDefaultClusterEnergy (Int_t d)

Int_t	GetDefaultClusterEnergy () const

const char *	GetTitle () const

const AliClusterIterableContainer	all () const

const AliClusterIterableContainer	accepted () const

const AliClusterIterableMomentumContainer	all_momentum () const

const AliClusterIterableMomentumContainer	accepted_momentum () const

Static Public Member Functions
static const AliEmcalContainerIndexMap < TClonesArray, AliVCluster > &	GetEmcalContainerIndexMap ()
	Get the EMCal container utils associated with particle containers. More...

Protected Attributes
Double_t	fClusTimeCutLow
	low time cut for clusters More...

Double_t	fClusTimeCutUp
	up time cut for clusters More...

Bool_t	fExoticCut
	reject clusters marked as "exotic" More...

Double_t	fUserDefEnergyCut [AliVCluster::kLastUserDefEnergy+1]
	cut on the energy of the cluster after higher level corrections (see AliVCluster.h) More...

Int_t	fDefaultClusterEnergy
	default cluster energy: -1 for clus->E(); otherwise clus->GetUserDefEnergy(fDefaultClusterEnergy) More...

Bool_t	fIncludePHOS
	whether or not to include PHOS clusters in addition to EMCal clusters More...

Static Protected Attributes
static AliEmcalContainerIndexMap < TClonesArray, AliVCluster >	fgEmcalContainerIndexMap
	! Mapping from containers to indices More...

Private Member Functions
	AliClusterContainer (const AliClusterContainer &obj)

AliClusterContainer &	operator= (const AliClusterContainer &other)

Detailed Description

Container structure for EMCAL clusters.

Author: Martha Verweij; Salvatore Aiola salva.nosp@m.tore.nosp@m..aiol.nosp@m.a@ce.nosp@m.rn.ch, Yale University

Container with name, TClonesArray and cuts for calo clusters

Definition at line 32 of file AliClusterContainer.h.

Member Typedef Documentation

typedef enum AliVCluster::VCluUserDefEnergy_t AliClusterContainer::VCluUserDefEnergy_t

Definition at line 34 of file AliClusterContainer.h.

Constructor & Destructor Documentation

AliClusterContainer::AliClusterContainer ( )

Default constructor.

Definition at line 36 of file AliClusterContainer.cxx.

AliClusterContainer::AliClusterContainer ( const char * name )

Standard constructor.

Parameters

name	Name of the array connected to this container

Definition at line 56 of file AliClusterContainer.cxx.

virtual AliClusterContainer::~AliClusterContainer ( )

inlinevirtual

Definition at line 38 of file AliClusterContainer.h.

AliClusterContainer::AliClusterContainer ( const AliClusterContainer & obj )

private

Member Function Documentation

Bool_t AliClusterContainer::AcceptCluster	(	Int_t	i,
		UInt_t &	rejectionReason
	)		const

virtual

Definition at line 290 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskEmcal::AcceptCluster(), AcceptObject(), AliAnalysisTaskEmcalRun2QA::DoClusterLoop(), AliAnalysisTaskEmcalJetQA::DoClusterLoop(), AliAnalysisTaskPWGJEQA::FillClusterHistograms(), GetAcceptCluster(), GetNAcceptedClusters(), AliEmcalClusterMaker::Run(), and TestClusterContainerIterator().

Bool_t AliClusterContainer::AcceptCluster	(	const AliVCluster *	vp,
		UInt_t &	rejectionReason
	)		const

virtual

Definition at line 301 of file AliClusterContainer.cxx.

const AliClusterIterableContainer AliClusterContainer::accepted ( ) const

Create an iterable container interface over accepted objects in the EMCAL container.

Returns: iterable container over accepted objects in the EMCAL container

Definition at line 441 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskJetSubstructure::DoClusterLoop(), AliAnalysisTaskEmcalSample::DoClusterLoop(), AliAnalysisTaskEmcalJetSample::DoClusterLoop(), AliAnalysisTaskEmcalDijetImbalance::DoClusterLoop(), AliAnalysisTaskEmcalJetHF::DoClusterLoop(), EMCalTriggerPtAnalysis::AliEmcalTriggerEmulation::SelectEvent(), and TestClusterContainerIterator().

const AliClusterIterableMomentumContainer AliClusterContainer::accepted_momentum ( ) const

Create an iterable container interface over accepted objects in the EMCAL container.

Returns: iterable container over accepted objects in the EMCAL container

Definition at line 459 of file AliClusterContainer.cxx.

Referenced by AliEmcalJetTask::FindJets(), AliEmcalCorrectionClusterTrackMatcher::GenerateEmcalParticles(), GetLeadingCluster(), and AliEmcalCorrectionClusterHadronicCorrection::Run().

virtual Bool_t AliClusterContainer::AcceptObject	(	Int_t	i,
		UInt_t &	rejectionReason
	)		const

inlinevirtual

Definition at line 42 of file AliClusterContainer.h.

virtual Bool_t AliClusterContainer::AcceptObject	(	const TObject *	obj,
		UInt_t &	rejectionReason
	)		const

inlinevirtual

Definition at line 43 of file AliClusterContainer.h.

const AliClusterIterableContainer AliClusterContainer::all ( ) const

Create an iterable container interface over all objects in the EMCAL container.

Returns: iterable container over all objects in the EMCAL container

Definition at line 432 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskJetSubstructure::DoClusterLoop(), AliAnalysisTaskEmcalSample::DoClusterLoop(), AliAnalysisTaskEmcalJetSample::DoClusterLoop(), AliAnalysisTaskEmcalDijetImbalance::DoClusterLoop(), AliAnalysisTaskEmcalJetHF::DoClusterLoop(), EMCalTriggerPtAnalysis::AliAnalysisTaskChargedParticlesMCTriggerMimic::Run(), EMCalTriggerPtAnalysis::AliAnalysisTaskEmcalTriggerMultiplicity::Run(), and TestClusterContainerIterator().

const AliClusterIterableMomentumContainer AliClusterContainer::all_momentum ( ) const

Create an iterable container interface over all objects in the EMCAL container.

Returns: iterable container over all objects in the EMCAL container

Definition at line 450 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskEmcalRun2QA::DoClusterLoop(), AliAnalysisTaskEmcalJetQA::DoClusterLoop(), AliAnalysisTaskPWGJEQA::FillClusterHistograms(), AliEmcalCorrectionClusterExotics::Run(), and AliEmcalCorrectionClusterNonLinearity::Run().

Bool_t AliClusterContainer::ApplyClusterCuts	(	const AliVCluster *	clus,
		UInt_t &	rejectionReason
	)		const

virtual

Return true if cluster is accepted.

Parameters

clus

Returns

Definition at line 317 of file AliClusterContainer.cxx.

Referenced by AcceptCluster().

AliVCluster * AliClusterContainer::GetAcceptCluster ( Int_t i ) const

Return pointer to cluster if cluster is accepted

Parameters

i

Returns

Definition at line 120 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskPi0Hadron::DoClusterLoop(), AliAnalysisTaskJetSubstructure::DoTrackLoop(), AliAnalysisTaskEmcalSample::DoTrackLoop(), AliAnalysisTaskEmcalJetSample::DoTrackLoop(), AliAnalysisTaskEmcalDijetImbalance::DoTrackLoop(), AliAnalysisTaskEmcalJetHF::DoTrackLoop(), AliAnalysisTaskEmcal::GetAcceptClusterFromArray(), GetAcceptClusterWithLabel(), GetAcceptMomentum(), and GetNextAcceptCluster().

AliVCluster * AliClusterContainer::GetAcceptClusterWithLabel ( Int_t lab ) const

Get particle with label lab in array

Parameters

lab

Returns

Definition at line 150 of file AliClusterContainer.cxx.

Bool_t AliClusterContainer::GetAcceptMomentum	(	TLorentzVector &	mom,
		Int_t	i
	)		const

Get momentum of the i^th particle in array

Parameters

mom
i

Returns

Definition at line 273 of file AliClusterContainer.cxx.

Double_t AliClusterContainer::GetClusPtCut ( ) const

inline

Definition at line 51 of file AliClusterContainer.h.

AliVCluster * AliClusterContainer::GetCluster ( Int_t i ) const

Get i^th cluster in array

Parameters

i

Returns

Definition at line 107 of file AliClusterContainer.cxx.

Referenced by AcceptCluster(), AliHadCorrTask::ApplyHadCorrAllTracks(), AliHadCorrTask::ApplyHadCorrOneTrack(), AliAnalysisTaskSoftDrop::CheckClusTrackMatching(), AliAnalysisTaskJetJTJT::CheckClusTrackMatching(), AliAnalysisTaskPi0Hadron::DoClusterLoop(), AliAnalysisTaskEmcalJetHF::DoJetLoop(), AliHadCorrTask::DoMatchedTracksLoop(), AliAnalysisTaskEmcalJetTriggerQA::FillHistograms(), AliAnalysisTaskEmcalTriggerPatchClusterMatch::FillHistograms(), AliAnalysisTaskEmcalTriggerPatchJetMatch::FillHistograms(), AliEmcalJetTask::FillJetConstituents(), AliAnalysisTaskJetV2::FillWeightedClusterHistograms(), AliAnalysisTaskJetV3::FillWeightedClusterHistograms(), GetAcceptCluster(), GetClusterWithLabel(), GetMomentum(), GetNAcceptedClusters(), GetNextCluster(), AliJetResponseMaker::GetSameCollectionsMatchingLevel(), operator[](), AliAnalysisTaskEmcalJetFlavourTagExample::Run(), AliAnalysisTaskEmcalJetTriggerMatcher::Run(), and TestClusterContainerIterator().

AliVCluster * AliClusterContainer::GetClusterWithLabel ( Int_t lab ) const

Get particle with label lab in array

Parameters

lab

Returns

Definition at line 139 of file AliClusterContainer.cxx.

Double_t AliClusterContainer::GetClusUserDefEnergyCut ( Int_t t ) const

Get the energy cut of the applied on cluster energy of type t

Parameters

t	Cluster energy type (base energy, non-linearity corrected energy, hadronically corrected energy)

Returns: Cluster energy cut

Definition at line 386 of file AliClusterContainer.cxx.

Referenced by GetTitle().

Int_t AliClusterContainer::GetDefaultClusterEnergy ( ) const

inline

Definition at line 79 of file AliClusterContainer.h.

Referenced by AliAnalysisTaskEmcalSample::DoClusterLoop(), AliAnalysisTaskEmcalJetSpectraQA::FillHistograms(), and GetTitle().

static const AliEmcalContainerIndexMap<TClonesArray, AliVCluster>& AliClusterContainer::GetEmcalContainerIndexMap ( )

inlinestatic

Get the EMCal container utils associated with particle containers.

Definition at line 85 of file AliClusterContainer.h.

Referenced by AliEmcalJet::Cluster(), AliEmcalJet::ClusterAt(), AliEmcalCorrectionClusterHadronicCorrection::ExecOnce(), AliEmcalCorrectionClusterTrackMatcher::ExecOnce(), and AliEmcalJetTask::ExecOnce().

AliVCluster * AliClusterContainer::GetLeadingCluster ( const char * opt = "" )

Get the leading cluster; use e if "e" is contained in opt (otherwise et)

Parameters

opt

Returns

Definition at line 77 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskEmcalSample::DoClusterLoop(), AliAnalysisTaskEmcalTriggerPatchClusterMatch::ExtractMainPatch(), and AliAnalysisTaskEmcalTriggerPatchJetMatch::ExtractMainPatch().

Bool_t AliClusterContainer::GetMomentum	(	TLorentzVector &	mom,
		const AliVCluster *	vc,
		Double_t	mass
	)		const

Definition at line 190 of file AliClusterContainer.cxx.

Referenced by AcceptCluster(), AliAnalysisTaskEmcalJetSpectraQA::FillHistograms(), AliEmcalJetTask::FillJetConstituents(), AliAnalysisTaskEmcalTmpSparseMaker::FillSparseClus(), GetAcceptMomentum(), GetMomentum(), GetNextAcceptMomentum(), GetNextMomentum(), AliAnalysisTaskRhoAverage::Run(), and EMCalTriggerPtAnalysis::AliAnalysisTaskChargedParticlesMCTriggerMimic::Run().

Bool_t AliClusterContainer::GetMomentum	(	TLorentzVector &	mom,
		const AliVCluster *	clus
	)		const

Definition at line 225 of file AliClusterContainer.cxx.

Bool_t AliClusterContainer::GetMomentum	(	TLorentzVector &	mom,
		Int_t	i
	)		const

Get momentum of the i^th particle in array

Parameters

mom
i

Returns

Definition at line 250 of file AliClusterContainer.cxx.

Int_t AliClusterContainer::GetNAcceptedClusters ( ) const

Get number of accepted particles

Returns

Definition at line 370 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskPi0Hadron::DoClusterLoop(), AliAnalysisTaskRhoMassBase::FillHistograms(), AliAnalysisTaskRhoBase::FillHistograms(), AliAnalysisTaskEmcalJetCDF::FillHistograms(), AliAnalysisTaskEmcalTmpSparseMaker::RetrieveEventObjects(), and AliAnalysisTaskEmcalJetSparseMaker::RetrieveEventObjects().

Int_t AliClusterContainer::GetNClusters ( ) const

inline

Definition at line 63 of file AliClusterContainer.h.

Referenced by AliAnalysisTaskPi0Hadron::DoClusterLoop(), AliAnalysisTaskEmcalJetTriggerQA::FillHistograms(), AliAnalysisTaskEmcalTriggerPatchClusterMatch::FillHistograms(), AliAnalysisTaskEmcalTriggerPatchJetMatch::FillHistograms(), AliAnalysisTaskJetV2::FillWeightedClusterHistograms(), AliAnalysisTaskJetV3::FillWeightedClusterHistograms(), AliEmcalJetTask::FindJets(), AliAnalysisTaskEmcalJetTriggerMatcher::Run(), and TestClusterContainerIterator().

AliVCluster * AliClusterContainer::GetNextAcceptCluster ( )

Get next accepted cluster

Returns

Definition at line 160 of file AliClusterContainer.cxx.

Referenced by AliAnalysisTaskJetV2::CalculateRandomCone(), AliAnalysisTaskJetV3::CalculateRandomCone(), AliAnalysisTaskSoftDrop::CheckClusTrackMatching(), AliAnalysisTaskJetJTJT::CheckClusTrackMatching(), AliJetConstituentTagCopier::DoClusterLoop(), AliAnalysisTaskScale::FillHistograms(), AliAnalysisTaskSoftDrop::FillHistograms(), AliAnalysisTaskDcalDijetPerf::FillHistograms(), AliAnalysisTaskJetJTJT::FillHistograms(), AliAnalysisTaskEmcalTmpSparseMaker::FillSparseClus(), AliEmcalClusTrackMatcherTask::GenerateEmcalParticles(), AliAnalysisTaskEmcalJetMassBkg::GetCone(), GetNextAcceptMomentum(), AliAnalysisTaskDeltaPt::GetRandomCone(), AliAnalysisTaskRhoAverage::Run(), AliHadCorrTask::Run(), AliAnalysisTaskEmcalJetv2QA::Run(), AliAnalysisTaskEmcalJetFlavourTagExample::Run(), and AliAnalysisTaskEmcalJetTriggerMatcher::Run().

Bool_t AliClusterContainer::GetNextAcceptMomentum ( TLorentzVector & mom )

Get momentum of the next accepted particle in array

Parameters

mom

Returns

Definition at line 284 of file AliClusterContainer.cxx.

AliVCluster * AliClusterContainer::GetNextCluster ( )

Get next cluster

Returns

Definition at line 177 of file AliClusterContainer.cxx.

Referenced by GetNextMomentum(), and AliEmcalClusterMaker::Run().

Bool_t AliClusterContainer::GetNextMomentum ( TLorentzVector & mom )

Get momentum of the next particle in array

Parameters

mom

Returns

Definition at line 261 of file AliClusterContainer.cxx.

const char * AliClusterContainer::GetTitle ( ) const

Definition at line 463 of file AliClusterContainer.cxx.

Referenced by AliJetContainer::GenerateJetName().

AliClusterContainer& AliClusterContainer::operator= ( const AliClusterContainer & other )

private

virtual TObject* AliClusterContainer::operator[] ( int index ) const

inlinevirtual

Definition at line 40 of file AliClusterContainer.h.

void AliClusterContainer::SetArray ( const AliVEvent * event )

Connect the container to the array with content stored inside the virtual event. The object name in the event must match the name given in the constructor.

Additionally register the array into the index map.

Parameters

event Input event containing the array with content.

Definition at line 419 of file AliClusterContainer.cxx.

Referenced by AliEmcalCorrectionTask::ExecOnce(), AliAnalysisTaskEmcalLight::ExecOnce(), and AliAnalysisTaskEmcal::ExecOnce().

void AliClusterContainer::SetClusECut ( Double_t cut )

inline

Definition at line 49 of file AliClusterContainer.h.

Referenced by AliEmcalJetTask::AddTaskEmcalJet(), AliAnalysisTaskEmcalJetTreeBase::AddTaskEmcalJetTree(), EMCalTriggerPtAnalysis::AliAnalysisTaskEmcalTriggerMultiplicity::AddTaskEmcalTriggerMultiplicity(), and AliEmcalJetTask::SetMinJetClusE().

void AliClusterContainer::SetClusHadCorrEnergyCut ( Double_t cut )

inline

Definition at line 76 of file AliClusterContainer.h.