Container for particles within the EMCAL framework. More...

#include <AliParticleContainer.h>

Inheritance diagram for AliParticleContainer:

Public Types
enum	EChargeCut_t { kNoChargeCut, kCharged, kNeutral, kPositiveCharge, kNegativeCharge }

Public Member Functions
	AliParticleContainer ()

	AliParticleContainer (const char *name)

virtual	~AliParticleContainer ()

virtual TObject *	operator[] (int index) const

virtual Bool_t	ApplyParticleCuts (const AliVParticle *vp, UInt_t &rejectionReason) const

virtual Bool_t	ApplyKinematicCuts (const AliTLorentzVector &mom, UInt_t &rejectionReason) 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	AcceptParticle (const AliVParticle *vp, UInt_t &rejectionReason) const

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

Double_t	GetParticlePtCut () const

Double_t	GetParticleEtaMin () const

Double_t	GetParticleEtaMax () const

Double_t	GetParticlePhiMin () const

Double_t	GetParticlePhiMax () const

void	SetParticlePtCut (Double_t cut)

void	SetParticleEtaLimits (Double_t min, Double_t max)

void	SetParticlePhiLimits (Double_t min, Double_t max)

virtual AliVParticle *	GetLeadingParticle (const char *opt="")

virtual AliVParticle *	GetParticle (Int_t i=-1) const

virtual AliVParticle *	GetAcceptParticle (Int_t i=-1) const

virtual AliVParticle *	GetNextAcceptParticle ()

virtual AliVParticle *	GetNextParticle ()

virtual Bool_t	GetMomentumFromParticle (TLorentzVector &mom, const AliVParticle *part, Double_t mass) const

virtual Bool_t	GetMomentumFromParticle (TLorentzVector &mom, const AliVParticle *part) const

virtual Bool_t	GetMomentum (TLorentzVector &mom, Int_t i) const

virtual Bool_t	GetAcceptMomentum (TLorentzVector &mom, Int_t i) const

virtual Bool_t	GetNextMomentum (TLorentzVector &mom)

virtual Bool_t	GetNextAcceptMomentum (TLorentzVector &mom)

Int_t	GetNParticles () const

Int_t	GetNAcceptedParticles () const

void	SetMinDistanceTPCSectorEdge (Double_t min)

void	SetCharge (EChargeCut_t c)

void	SelectHIJING (Bool_t s)

void	SetGeneratorIndex (Short_t i)

const char *	GetTitle () const

const AliParticleIterableContainer	all () const

const AliParticleIterableContainer	accepted () const

const AliParticleIterableMomentumContainer	all_momentum () const

const AliParticleIterableMomentumContainer	accepted_momentum () const

Protected Attributes
Double_t	fMinDistanceTPCSectorEdge
	require minimum distance to edge of TPC sector edge More...

EChargeCut_t	fChargeCut
	select particles according to their charge More...

Short_t	fGeneratorIndex
	select MC particles with generator index (default = -1 = switch off selection) More...

Private Member Functions
	AliParticleContainer (const AliParticleContainer &obj)

AliParticleContainer &	operator= (const AliParticleContainer &other)

Detailed Description

Container for particles within the EMCAL framework.

Author: Marta 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 particles

Definition at line 28 of file AliParticleContainer.h.

Member Enumeration Documentation

enum AliParticleContainer::EChargeCut_t

Enumerator
kNoChargeCut
kCharged
kNeutral
kPositiveCharge
kNegativeCharge

Definition at line 30 of file AliParticleContainer.h.

Constructor & Destructor Documentation

AliParticleContainer::AliParticleContainer ( )

Default constructor.

Definition at line 33 of file AliParticleContainer.cxx.

AliParticleContainer::AliParticleContainer ( const char * name )

Standard constructor.

Parameters

name	Name of the particle branch (TClonesArray)

Definition at line 47 of file AliParticleContainer.cxx.

virtual AliParticleContainer::~AliParticleContainer ( )

inlinevirtual

Definition at line 34 of file AliParticleContainer.h.

AliParticleContainer::AliParticleContainer ( const AliParticleContainer & obj )

private

Member Function Documentation

const AliParticleIterableContainer AliParticleContainer::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 460 of file AliParticleContainer.cxx.

Referenced by AliAnalysisTaskJetSubstructure::DoTrackLoop(), AliAnalysisTaskEmcalSample::DoTrackLoop(), AliAnalysisTaskEmcalJetSample::DoTrackLoop(), AliAnalysisTaskEmcalDijetImbalance::DoTrackLoop(), AliAnalysisTaskEmcalJetHF::DoTrackLoop(), AliAnalysisTaskIDFragmentationFunction::GetTracksInCone(), and TestParticleContainerIterator().

const AliParticleIterableMomentumContainer AliParticleContainer::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 478 of file AliParticleContainer.cxx.

Referenced by AliEmcalJetTask::FindJets().

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

inlinevirtual

Reimplemented in AliJetContainer, AliTrackContainer, and AliMCParticleContainer.

Definition at line 46 of file AliParticleContainer.h.

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

inlinevirtual

Reimplemented in AliJetContainer, AliTrackContainer, and AliMCParticleContainer.

Definition at line 47 of file AliParticleContainer.h.

Bool_t AliParticleContainer::AcceptParticle	(	const AliVParticle *	vp,
		UInt_t &	rejectionReason
	)		const

virtual

Perform full particle selection consisting of kinematical and particle property selection on the particle provided. In case the particle is rejected, the reason for the rejection is encoded in the bitmap rejectionReason.

Parameters

vp	Particle for which to perform the selection
rejectionReason	Bitmap with the reason why the particle was accepted. Note: The value is not set to 0 in the function in order to combine the information with other selection steps.

Returns: True if the particle is accepted, false otherwise.

Reimplemented in AliTrackContainer, and AliMCParticleContainer.

Definition at line 268 of file AliParticleContainer.cxx.

Referenced by AcceptObject(), AliAnalysisTaskEmcal::AcceptTrack(), AliHadCorrTask::ApplyHadCorrAllTracks(), AliEmcalCorrectionClusterHadronicCorrection::ApplyHadCorrAllTracks(), AliHadCorrTask::ApplyHadCorrOneTrack(), AliEmcalCorrectionClusterHadronicCorrection::ApplyHadCorrOneTrack(), AliHadCorrTask::DoMatchedTracksLoop(), AliEmcalCorrectionClusterHadronicCorrection::DoMatchedTracksLoop(), AliAnalysisTaskEmcalJetQA::DoTrackLoop(), GetAcceptParticle(), GetNAcceptedParticles(), AliAnalysisTaskLocalRho::PassesCuts(), AliAnalysisTaskJetV2::PassesCuts(), and TestParticleContainerIterator().

Bool_t AliParticleContainer::AcceptParticle	(	Int_t	i,
		UInt_t &	rejectionReason
	)		const

virtual

Perform full particle selection consisting of kinematical and particle property selection on the \( i^{th} \) particle in the array. In case the particle is rejected, the reason for the rejection is encoded in the bitmap rejectionReason.

Parameters

[in]	i	Index of the particle to select.
[out]	rejectionReason	Bitmap with the reason why the particle was accepted. Note: The value is not set to 0 in the function in order to combine the information with other selection steps.

Returns: True if the particle was accepted, false otherwise

Reimplemented in AliTrackContainer, and AliMCParticleContainer.

Definition at line 296 of file AliParticleContainer.cxx.

const AliParticleIterableContainer AliParticleContainer::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 451 of file AliParticleContainer.cxx.

Referenced by NS_AliAnalysisTaskEmcalJetCDF::SortTracksPt(), and TestParticleContainerIterator().

const AliParticleIterableMomentumContainer AliParticleContainer::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 469 of file AliParticleContainer.cxx.

Referenced by AliAnalysisTaskEmcalJetQA::DoTrackLoop().

Bool_t AliParticleContainer::ApplyKinematicCuts	(	const AliTLorentzVector &	mom,
		UInt_t &	rejectionReason
	)		const

virtual

Apply kinematical cuts to the momentum vector provided. In addition to the standard kinematical cuts in \( p_{t} \), \( \eta \) and \( \phi \), implemented in the AliEmcalContainer::ApplyKinematicCuts, also the distance to the TPC sector boundary is checked.

Parameters

[in]	mom	Momentum vector for which
[out]	rejectionReason	Bitmap with the reason why the particle was accepted. Note: The value is not set to 0 in the function in order to combine the information with other selection steps.

Returns: True if the momentum vector was selected under the given cuts, false otherwise

Definition at line 393 of file AliParticleContainer.cxx.

Referenced by AliJetContainer::AcceptJet(), AliMCParticleContainer::AcceptMCParticle(), AliHFAODMCParticleContainer::AcceptMCParticle(), AcceptParticle(), and AliTrackContainer::AcceptTrack().

Bool_t AliParticleContainer::ApplyParticleCuts	(	const AliVParticle *	vp,
		UInt_t &	rejectionReason
	)		const

virtual

Apply cuts on the particle properties. Implemented are

Monte-Carlo label
Charge
Generator index

Parameters

[in]	vp	Particle for which the selection is performed
[out]	rejectionReason	Bitmap with the reason why the particle was accepted. Note: The value is not set to 0 in the function in order to combine the information with other selection steps.

Returns: True if the particle is accepted, False otherwise

Definition at line 319 of file AliParticleContainer.cxx.

Referenced by AcceptParticle(), AliMCParticleContainer::ApplyMCParticleCuts(), and AliTrackContainer::ApplyTrackCuts().

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

virtual

Fills a TLorentzVector with the monentum infomation of the \( i^{th} \) accepted particle in the container, using a global mass hypothesis. In case the provided index is out of range, or the particle under the index is not accepted, false is returned as return value.

Parameters

[out]	mom	Momentum vector of the accepted particle
[in]	i	Index to check

Returns: True if the request was successfull, false otherwise

Reimplemented in AliJetContainer, AliTrackContainer, AliMCParticleContainerToyModel, and AliTrackContainerToyModel.

Definition at line 236 of file AliParticleContainer.cxx.

Referenced by AliMCParticleContainerToyModel::GetAcceptMomentum().

AliVParticle * AliParticleContainer::GetAcceptParticle ( Int_t i = -1 ) const

virtual

Get \( i^{th} \) particle in the container if it is accepted. In case it is not accepted a nullpointer is returned.

Parameters

[in] i Index of the particle

Returns: Particle at the index if it is accepted, NULL otherwise

Reimplemented in AliTrackContainer, and AliMCParticleContainer.

Definition at line 110 of file AliParticleContainer.cxx.

Referenced by AliHadCorrTask::ApplyHadCorrAllTracks(), AliEmcalCorrectionClusterHadronicCorrection::ApplyHadCorrAllTracks(), AliHadCorrTask::ApplyHadCorrOneTrack(), AliEmcalCorrectionClusterHadronicCorrection::ApplyHadCorrOneTrack(), AliHadCorrTask::DoMatchedTracksLoop(), AliEmcalCorrectionClusterHadronicCorrection::DoMatchedTracksLoop(), AliAnalysisTaskJetShapeDeriv::FillHistograms(), GetAcceptMomentum(), AliAnalysisTaskEmcal::GetAcceptParticleFromArray(), GetNextAcceptParticle(), and AliAnalysisTaskEmcalLight::IsEventSelected().

AliVParticle * AliParticleContainer::GetLeadingParticle ( const char * opt = "" )

virtual

Get the leading particle in the container. If "p" is contained in the parameter opt, then the absolute momentum is use instead of the transverse momentum.

Parameters

[in] opt Options for the selection of the leading particle

Returns: Leading particle in the container

Definition at line 63 of file AliParticleContainer.cxx.

Referenced by AliMCParticleContainer::GetLeadingMCParticle(), AliTrackContainer::GetLeadingTrack(), and AliAnalysisTaskChargedJetsHadronCF::Run().

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

virtual

Fills a TLorentzVector with the monentum infomation of the \( i^{th} \) particle in the container, using a global mass hypothesis. In case the provided index is out of range, false is returned as return value.

Parameters

[out]	mom	Momentum vector of the \( i^{th} \) particle in the array
[in]	i	Index of th particle to check

Returns: True if the request was successfull, false otherwise

Reimplemented in AliJetContainer, AliTrackContainer, AliMCParticleContainerToyModel, and AliTrackContainerToyModel.

Definition at line 204 of file AliParticleContainer.cxx.

Referenced by AliMCParticleContainer::AcceptMCParticle(), AliHFAODMCParticleContainer::AcceptMCParticle(), AcceptParticle(), and AliMCParticleContainerToyModel::GetMomentum().

Bool_t AliParticleContainer::GetMomentumFromParticle	(	TLorentzVector &	mom,
		const AliVParticle *	part,
		Double_t	mass
	)		const

virtual

Retrieve momentum information of a particle (part) and fill a TLorentzVector with it. In case the optional parameter mass is provided, it is used as mass hypothesis, otherwise the mass hypothesis from the particle itself is used.

Parameters

[out]	mom	Momentum vector to be filled
[in]	part	Particle from which the momentum information is obtained.
[in]	mass	(Optional) Mass hypothesis

Returns

Definition at line 170 of file AliParticleContainer.cxx.

Referenced by AliMCParticleContainer::AcceptMCParticle(), AliHFAODMCParticleContainer::AcceptMCParticle(), AcceptParticle(), GetAcceptMomentum(), GetMomentum(), AliMCParticleContainerToyModel::GetMomentumFromParticle(), GetMomentumFromParticle(), GetNextAcceptMomentum(), and GetNextMomentum().

Bool_t AliParticleContainer::GetMomentumFromParticle	(	TLorentzVector &	mom,
		const AliVParticle *	part
	)		const

virtual

Fills a TLorentzVector with the momentum information of the particle provided under a global mass hypothesis.

Parameters

[out]	mom	Momentum vector of the particle provided
[in]	part	Particle from which to obtain the momentum information

Returns: Always true

Definition at line 190 of file AliParticleContainer.cxx.

Int_t AliParticleContainer::GetNAcceptedParticles ( ) const

Get number of accepted particles. In order to get this number, the selection has to be applied to each particle within this function.

Returns: Number of selected particles under the given particle selection

Definition at line 414 of file AliParticleContainer.cxx.

Referenced by AliAnalysisTaskJetExtractor::FillEventControlHistograms(), AliAnalysisTaskScale::FillHistograms(), AliAnalysisTaskSoftDrop::FillHistograms(), AliAnalysisTaskEmcalHighMultTrigger::FillHistograms(), AliAnalysisTaskBackFlucRandomCone::FillHistograms(), AliAnalysisTaskJetShapeConst::FillHistograms(), AliAnalysisTaskRhoMassScale::FillHistograms(), AliAnalysisTaskRhoMassBase::FillHistograms(), AliAnalysisTaskRhoBase::FillHistograms(), AliAnalysisTaskEmcalJetMassBkg::FillHistograms(), AliAnalysisTaskEmcalJetCDF::FillHistograms(), AliTrackContainer::GetNAcceptedTracks(), AliAnalysisTaskEmcalTmpSparseMaker::RetrieveEventObjects(), AliAnalysisTaskEmcalJetSparseMaker::RetrieveEventObjects(), AliAnalysisTaskEmcalJetHadEPpid::Run(), and AliAnalysisTaskDmesonJets::AnalysisEngine::RunParticleLevelAnalysis().

Bool_t AliParticleContainer::GetNextAcceptMomentum ( TLorentzVector & mom )

virtual

Fills a TLorentzVector with the monentum infomation of the next accepted particle in the container, using a global mass hypothesis. In case the iteration reached the end of the array, false is returned as return value.

Deprecated:

Old style iterator - use accept_iterator instead

Parameters

[out] mom Momentum vector of the next particle in the array

Returns: True if the request was successfull, false (no more entries) otherwise

Reimplemented in AliJetContainer, AliTrackContainer, AliMCParticleContainerToyModel, and AliTrackContainerToyModel.

Definition at line 252 of file AliParticleContainer.cxx.

Referenced by AliMCParticleContainerToyModel::GetNextAcceptMomentum().

AliVParticle * AliParticleContainer::GetNextAcceptParticle ( )

virtual

Iterator over accepted particles in the container. Get the next accepted particle in the array. If the end is reached, NULL is returned.

Deprecated:

Only for backward compatibility - use accept_iterator instead

Returns: Next accepted particle in the array (NULL if the end is reached)

Reimplemented in AliTrackContainer, and AliMCParticleContainer.

Definition at line 129 of file AliParticleContainer.cxx.

Bool_t AliParticleContainer::GetNextMomentum ( TLorentzVector & mom )

virtual

Fills a TLorentzVector with the monentum infomation of the next particle in the container, using a global mass hypothesis. In case the iterator reached the end of the array, false is returned as return value.

Deprecated:

Old style iterator - use all_iterator instead

Parameters

[out] mom Momentum vector of the next particle