AliPhysics  8d00e07 (8d00e07)
PWG::JETFW::AliEmcalJetConstituent Class Referenceabstract

Interface class for constituent objects (clusters / particles) in an ALICE jet. More...

#include <AliEmcalJetConstituent.h>

Inheritance diagram for PWG::JETFW::AliEmcalJetConstituent:

Public Member Functions

 AliEmcalJetConstituent ()
 Constructor. More...
 
virtual ~AliEmcalJetConstituent ()
 Destructor. More...
 
virtual double Px () const =0
 Access to x-component of the momentum vector. More...
 
virtual double Py () const =0
 Access to y-component of the momentum vector. More...
 
virtual double Pz () const =0
 Access to z-component of the momentum vector. More...
 
virtual double Pt () const =0
 Access to transverse momentum. More...
 
virtual double E () const =0
 Access to constituent energy. More...
 
virtual double Eta () const =0
 Access to pseudorapidity. More...
 
virtual double Phi () const =0
 Access to azimuthal angle. More...
 
Bool_t IsFromEmbeddedEvent () const
 Checks whether the constituent is from an embedded event. More...
 
ULong_t GetGlobalIndex () const
 Get the index of the constituent in the global index map. More...
 
void SetIsFromEmbeddedEvent (Bool_t isEmbedded)
 Specify whether constituent is from embedded event. More...
 
void SetGlobalIndex (ULong_t index)
 Set the index in the globl. More...
 

Protected Attributes

Bool_t fIsFromEmbeddedEvent
 Flag whether constituent is from embedded event. More...
 
ULong_t fGlobalIndex
 Index of the constituent in the global index map. More...
 

Detailed Description

Interface class for constituent objects (clusters / particles) in an ALICE jet.

Author
Markus Fasel marku.nosp@m.s.fa.nosp@m.sel@c.nosp@m.ern..nosp@m.ch, Oak Ridge National Laboratory
Since
Sept 22, 2017

The interface object defines access functions to kinematic quantities (4-momentum vector). Implementation is done within the classes implementing the constituents for particles and clusters. Here also the access to the underlying object is provided.

Definition at line 56 of file AliEmcalJetConstituent.h.

Constructor & Destructor Documentation

PWG::JETFW::AliEmcalJetConstituent::AliEmcalJetConstituent ( )

Constructor.

Definition at line 35 of file AliEmcalJetConstituent.cxx.

PWG::JETFW::AliEmcalJetConstituent::~AliEmcalJetConstituent ( )
virtual

Destructor.

Definition at line 41 of file AliEmcalJetConstituent.cxx.

Member Function Documentation

virtual double PWG::JETFW::AliEmcalJetConstituent::E ( ) const
pure virtual

Access to constituent energy.

Returns
Constituent energy

Implemented in PWG::JETFW::AliEmcalClusterJetConstituent, and PWG::JETFW::AliEmcalParticleJetConstituent.

virtual double PWG::JETFW::AliEmcalJetConstituent::Eta ( ) const
pure virtual

Access to pseudorapidity.

Returns
Constituent pseudorapidity

Implemented in PWG::JETFW::AliEmcalClusterJetConstituent, and PWG::JETFW::AliEmcalParticleJetConstituent.

ULong_t PWG::JETFW::AliEmcalJetConstituent::GetGlobalIndex ( ) const
inline

Get the index of the constituent in the global index map.

Returns
Index of the constituent in the global index map

Definition at line 120 of file AliEmcalJetConstituent.h.

Bool_t PWG::JETFW::AliEmcalJetConstituent::IsFromEmbeddedEvent ( ) const
inline

Checks whether the constituent is from an embedded event.

Returns
True if the constituent is from an embedded event

Definition at line 114 of file AliEmcalJetConstituent.h.

virtual double PWG::JETFW::AliEmcalJetConstituent::Phi ( ) const
pure virtual

Access to azimuthal angle.

Returns
Constituent azimuthal angle

Implemented in PWG::JETFW::AliEmcalClusterJetConstituent, and PWG::JETFW::AliEmcalParticleJetConstituent.

virtual double PWG::JETFW::AliEmcalJetConstituent::Pt ( ) const
pure virtual

Access to transverse momentum.

Returns
Constituent transverse momentum

Implemented in PWG::JETFW::AliEmcalClusterJetConstituent, and PWG::JETFW::AliEmcalParticleJetConstituent.

virtual double PWG::JETFW::AliEmcalJetConstituent::Px ( ) const
pure virtual

Access to x-component of the momentum vector.

Returns
x-component of the momentum vector

Implemented in PWG::JETFW::AliEmcalClusterJetConstituent, and PWG::JETFW::AliEmcalParticleJetConstituent.

virtual double PWG::JETFW::AliEmcalJetConstituent::Py ( ) const
pure virtual

Access to y-component of the momentum vector.

Returns
y-component of the momentum vector

Implemented in PWG::JETFW::AliEmcalClusterJetConstituent, and PWG::JETFW::AliEmcalParticleJetConstituent.

virtual double PWG::JETFW::AliEmcalJetConstituent::Pz ( ) const
pure virtual

Access to z-component of the momentum vector.

Returns
z-component of the momentum vector

Implemented in PWG::JETFW::AliEmcalClusterJetConstituent, and PWG::JETFW::AliEmcalParticleJetConstituent.

void PWG::JETFW::AliEmcalJetConstituent::SetGlobalIndex ( ULong_t  index)
inline

Set the index in the globl.

Parameters
[in]indexIndex of the constituent in the global index map

Definition at line 132 of file AliEmcalJetConstituent.h.

Referenced by AliEmcalJet::AddClusterConstituent(), and AliEmcalJet::AddParticleConstituent().

void PWG::JETFW::AliEmcalJetConstituent::SetIsFromEmbeddedEvent ( Bool_t  isEmbedded)
inline

Specify whether constituent is from embedded event.

Parameters
[in]isEmbeddedFlag of embedded status (true - constituent is from embedded event)

Definition at line 126 of file AliEmcalJetConstituent.h.

Referenced by AliEmcalJet::AddClusterConstituent(), and AliEmcalJet::AddParticleConstituent().

Member Data Documentation

ULong_t PWG::JETFW::AliEmcalJetConstituent::fGlobalIndex
protected

Index of the constituent in the global index map.

Definition at line 136 of file AliEmcalJetConstituent.h.

Referenced by GetGlobalIndex(), and SetGlobalIndex().

Bool_t PWG::JETFW::AliEmcalJetConstituent::fIsFromEmbeddedEvent
protected

Flag whether constituent is from embedded event.

Definition at line 135 of file AliEmcalJetConstituent.h.

Referenced by IsFromEmbeddedEvent(), and SetIsFromEmbeddedEvent().


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