#include <TruthEtIsolations.h>

Collaboration diagram for TruthEtIsolations:

Public Types
typedef ElementLink< McEventCollection >	GenEventLink_t
	A (persistent) link to a `HepMC::GenEvent`. More...

typedef McAod::EtIsolations	EtIsol_t
	An array of doubles of fixed size to modelize the Et isolations for different values of isolation radii' cones. More...

typedef std::unordered_map< int, EtIsol_t >	EtIsolMap_t
	The map of barcode-to-Et isolations. More...

typedef EtIsolMap_t::const_iterator	const_iterator
	The iterator over the map of barcode-to-Et-isolations. More...

Public Member Functions
	TruthEtIsolations ()
	Default constructor. More...

	TruthEtIsolations (const TruthEtIsolations &rhs)
	Copy constructor. More...

	TruthEtIsolations (const GenEventLink_t &genEvtLink)
	Constructor with parameters: construct a `TruthEtIsolations` container from an `ElementLink` to a `HepMC::GenEvent` (hold by a `McEventCollection`) Note that no Et isolations are computed at that time. More...

	TruthEtIsolations (const std::string &genEvtName, const std::size_t genEvtIdx)
	Constructor with parameters: construct a `TruthEtIsolations` container from a `StoreGate` key to a `McEventCollection` and an index `std::size_t` to a `HepMC::GenEvent`. More...

TruthEtIsolations &	operator= (const TruthEtIsolations &rhs)
	Assignment operator. More...

	~TruthEtIsolations ()
	Default destructor: More...

const std::string &	genEventName () const
	Return the name (ie: the `StoreGate` key) of the `McEventCollection` holding the `HepMC::GenEvent` from which the Et isolations have been computed. More...

std::size_t	genEventIdx () const
	Return the index in the `McEventCollection` container holding the `HepMC::GenEvent` from which the Et isolations have been computed. More...

std::size_t	size () const
	Return the number of `HepMC::GenParticle` for which Et isolations have been stored into this `TruthEtIsolations` container. More...

bool	hasEtIsol (const HepMC::ConstGenParticlePtr &genParticle) const
	Return true if this `TruthEtIsolations` container holds Et isolations for that `HepMC::GenParticle`. More...

bool	hasEtIsol (const int genParticleBarcode) const
	Return true if this `TruthEtIsolations` container holds Et isolations for that `HepMC::GenParticle`. More...

const EtIsol_t *	etIsolations (const HepMC::ConstGenParticlePtr &genParticle) const
	Return the transverse energies for all cone sizes of isolation, for a given `HepMC::GenParticle's` barcode. More...

const EtIsol_t *	etIsolations (const int genParticleBarcode) const
	Return the transverse energies for all cone sizes of isolation, for a given `HepMC::GenParticle's` barcode. More...

double	etIsol (const HepMC::ConstGenParticlePtr &genParticle, const TruthParticleParameters::ConeSize coneIdx) const
	Return the transverse energy in a given cone size of isolation, for a given `HepMC::GenParticle`. More...

double	etIsol (const int genParticleBarcode, const TruthParticleParameters::ConeSize coneIdx) const
	Return the transverse energy in a given cone size of isolation, for a given `HepMC::GenParticle's` barcode Note that the size of the code must be one of the encoded sizes (see TruthEtIsolationsParamDefs.h file) and that the index is checked for out of bounds. More...

const_iterator	begin () const
	Const iterator over the barcodes of the `HepMC::GenParticle` for which we have Et isolations computed. More...

const_iterator	end () const
	Const iterator over the barcodes of the `HepMC::GenParticle` for which we have Et isolations computed. More...

void	setEtIsol (const HepMC::ConstGenParticlePtr &genParticle, const TruthParticleParameters::ConeSize coneIdx, const double etIsol)
	Set the transverse energy isolation of a `HepMC::GenParticle` for a given Cone size. More...

void	setEtIsol (const HepMC::ConstGenParticlePtr &genParticle, const std::vector< double > &etIsols)
	Set the transverse energy isolations for all the Cone sizes. More...

void	setEtIsol (const HepMC::ConstGenParticlePtr &genParticle, const EtIsol_t &etIsols)
	Set the transverse energy isolations for all the Cone sizes. More...

Protected Attributes
GenEventLink_t	m_genEvtLink
	`ElementLink` to the `HepMC::GenEvent` from which the Et isolations have been (or will be) computed More...

EtIsolMap_t	m_etIsolations
	Holds transverse energy isolations for different isolation cones The key of this map is the barcode of the `HepMC::GenParticle` for which the Et isolations have been computed. More...

Static Protected Attributes
static const EtIsol_t	m_dfltEtIsols
	The default Et isolation energy which is being returned when I don't know what to return. More...

Friends
class	TruthEtIsolationsCnv_p1

Detailed Description

container which holds isolation informations for a given HepMC::GenParticle (labelled by barcode) for a given HepMC::GenEvent of a given McEventCollection

Definition at line 39 of file TruthEtIsolations.h.

Member Typedef Documentation

◆ const_iterator

typedef EtIsolMap_t::const_iterator TruthEtIsolations::const_iterator

The iterator over the map of barcode-to-Et-isolations.

Definition at line 58 of file TruthEtIsolations.h.

◆ EtIsol_t

typedef McAod::EtIsolations TruthEtIsolations::EtIsol_t

An array of doubles of fixed size to modelize the Et isolations for different values of isolation radii' cones.

Definition at line 52 of file TruthEtIsolations.h.

◆ EtIsolMap_t

typedef std::unordered_map<int,EtIsol_t> TruthEtIsolations::EtIsolMap_t

The map of barcode-to-Et isolations.

Definition at line 55 of file TruthEtIsolations.h.

◆ GenEventLink_t

typedef ElementLink<McEventCollection> TruthEtIsolations::GenEventLink_t

A (persistent) link to a HepMC::GenEvent.

Definition at line 48 of file TruthEtIsolations.h.

Constructor & Destructor Documentation

◆ TruthEtIsolations() [1/4]

TruthEtIsolations::TruthEtIsolations ( )

Default constructor.

Definition at line 45 of file TruthEtIsolations.cxx.

                                      :
   m_genEvtLink   ( ),
   m_etIsolations ( )
 {}

◆ TruthEtIsolations() [2/4]

TruthEtIsolations::TruthEtIsolations ( const TruthEtIsolations & rhs )

Copy constructor.

Definition at line 50 of file TruthEtIsolations.cxx.

                                                                    :
   m_genEvtLink   ( rhs.m_genEvtLink ),
   m_etIsolations ( rhs.m_etIsolations )
 {}

◆ TruthEtIsolations() [3/4]

TruthEtIsolations::TruthEtIsolations ( const GenEventLink_t & genEvtLink )

Constructor with parameters: construct a TruthEtIsolations container from an ElementLink to a HepMC::GenEvent (hold by a McEventCollection) Note that no Et isolations are computed at that time.

Definition at line 56 of file TruthEtIsolations.cxx.

                                                                        :
   m_genEvtLink   ( genEvtLink ),
   m_etIsolations ( )
 {}

◆ TruthEtIsolations() [4/4]

TruthEtIsolations::TruthEtIsolations	(	const std::string &	genEvtName,
		const std::size_t	genEvtIdx
	)

Constructor with parameters: construct a TruthEtIsolations container from a StoreGate key to a McEventCollection and an index std::size_t to a HepMC::GenEvent.

Note that no Et isolations are computed at that time.

Definition at line 61 of file TruthEtIsolations.cxx.

                                                    :
   m_genEvtLink  ( genEvtName, genEvtIdx ),
   m_etIsolations( )
 {}

◆ ~TruthEtIsolations()

TruthEtIsolations::~TruthEtIsolations ( )

Default destructor:

Definition at line 80 of file TruthEtIsolations.cxx.

81 {}

Member Function Documentation

◆ begin()

TruthEtIsolations::const_iterator TruthEtIsolations::begin ( ) const

inline

Const iterator over the barcodes of the HepMC::GenParticle for which we have Et isolations computed.

Definition at line 249 of file TruthEtIsolations.h.

250 { return m_etIsolations.begin(); }

◆ end()

TruthEtIsolations::const_iterator TruthEtIsolations::end ( ) const

inline

Const iterator over the barcodes of the HepMC::GenParticle for which we have Et isolations computed.

Definition at line 252 of file TruthEtIsolations.h.

253 { return m_etIsolations.end(); }

◆ etIsol() [1/2]

double TruthEtIsolations::etIsol	(	const HepMC::ConstGenParticlePtr &	genParticle,
		const TruthParticleParameters::ConeSize	coneIdx
	)		const

Return the transverse energy in a given cone size of isolation, for a given HepMC::GenParticle.

Note that the size of the code must be one of the encoded sizes (see TruthEtIsolationsParamDefs.h file) and that the index is checked for out of bounds.

Definition at line 114 of file TruthEtIsolations.cxx.

 {
   return ( 0 == p ) 
     ? m_dfltEtIsols[idx]
     : etIsol( HepMC::barcode(p), idx );
 }

◆ etIsol() [2/2]

double TruthEtIsolations::etIsol	(	const int	genParticleBarcode,
		const TruthParticleParameters::ConeSize	coneIdx
	)		const

inline

Return the transverse energy in a given cone size of isolation, for a given HepMC::GenParticle's barcode Note that the size of the code must be one of the encoded sizes (see TruthEtIsolationsParamDefs.h file) and that the index is checked for out of bounds.

Definition at line 243 of file TruthEtIsolations.h.

 {
   return (*etIsolations(bc))[idx];
 }

◆ etIsolations() [1/2]

const TruthEtIsolations::EtIsol_t * TruthEtIsolations::etIsolations ( const HepMC::ConstGenParticlePtr & genParticle ) const

Return the transverse energies for all cone sizes of isolation, for a given HepMC::GenParticle's barcode.

Definition at line 106 of file TruthEtIsolations.cxx.

 {
   return ( 0 == p ) 
     ? 0
     : etIsolations( HepMC::barcode(p) );
 }

◆ etIsolations() [2/2]

const TruthEtIsolations::EtIsol_t * TruthEtIsolations::etIsolations ( const int genParticleBarcode ) const

inline

Return the transverse energies for all cone sizes of isolation, for a given HepMC::GenParticle's barcode.

Definition at line 233 of file TruthEtIsolations.h.

 {
   const EtIsolMap_t::const_iterator i = m_etIsolations.find( bc );
   return ( m_etIsolations.end() == i )
     ? 0
     : &i->second;
 }

◆ genEventIdx()

std::size_t TruthEtIsolations::genEventIdx ( ) const

Return the index in the McEventCollection container holding the HepMC::GenEvent from which the Et isolations have been computed.

Definition at line 92 of file TruthEtIsolations.cxx.

 {
   return m_genEvtLink.index();
 }

◆ genEventName()

const std::string & TruthEtIsolations::genEventName ( ) const

Return the name (ie: the StoreGate key) of the McEventCollection holding the HepMC::GenEvent from which the Et isolations have been computed.

Definition at line 87 of file TruthEtIsolations.cxx.

 {
   return m_genEvtLink.dataID();
 }

◆ hasEtIsol() [1/2]

bool TruthEtIsolations::hasEtIsol ( const HepMC::ConstGenParticlePtr & genParticle ) const

Return true if this TruthEtIsolations container holds Et isolations for that HepMC::GenParticle.

Definition at line 98 of file TruthEtIsolations.cxx.

 {
   return ( 0 == p ) 
     ? false
     : hasEtIsol( HepMC::barcode(p) );
 }

◆ hasEtIsol() [2/2]

bool TruthEtIsolations::hasEtIsol ( const int genParticleBarcode ) const

inline

Return true if this TruthEtIsolations container holds Et isolations for that HepMC::GenParticle.

Definition at line 227 of file TruthEtIsolations.h.

 {
   return m_etIsolations.end() != m_etIsolations.find( bc );
 }

◆ operator=()

TruthEtIsolations & TruthEtIsolations::operator= ( const TruthEtIsolations & rhs )

Assignment operator.

Definition at line 68 of file TruthEtIsolations.cxx.

 {
   if ( this != &rhs ) {
     m_genEvtLink   = rhs.m_genEvtLink;
     m_etIsolations = rhs.m_etIsolations;
   }
   return *this;
 }

◆ setEtIsol() [1/3]

void TruthEtIsolations::setEtIsol	(	const HepMC::ConstGenParticlePtr &	genParticle,
		const EtIsol_t &	etIsols
	)

Set the transverse energy isolations for all the Cone sizes.

Definition at line 147 of file TruthEtIsolations.cxx.

 {
   m_etIsolations[HepMC::barcode(genParticle)] = etIsols;
 }

◆ setEtIsol() [2/3]

void TruthEtIsolations::setEtIsol	(	const HepMC::ConstGenParticlePtr &	genParticle,
		const std::vector< double > &	etIsols
	)

Set the transverse energy isolations for all the Cone sizes.

Definition at line 135 of file TruthEtIsolations.cxx.

 {
   EtIsol_t& et = m_etIsolations[HepMC::barcode(genParticle)];
   for ( std::size_t i = 0, iMax = std::min<std::size_t>( etIsols.size(), TruthParticleParameters::NbrOfCones ); i != iMax;++i ) {
     et[i] = etIsols[i];
   }
  
   return;
 }

◆ setEtIsol() [3/3]

void TruthEtIsolations::setEtIsol	(	const HepMC::ConstGenParticlePtr &	genParticle,
		const TruthParticleParameters::ConeSize	coneIdx,
		const double	etIsol
	)

Set the transverse energy isolation of a HepMC::GenParticle for a given Cone size.

Definition at line 127 of file TruthEtIsolations.cxx.

 {
   m_etIsolations[HepMC::barcode(genParticle)][coneIdx] = etIsol;
 }

◆ size()

std::size_t TruthEtIsolations::size ( ) const

inline

Return the number of HepMC::GenParticle for which Et isolations have been stored into this TruthEtIsolations container.

Definition at line 223 of file TruthEtIsolations.h.

224 { return m_etIsolations.size(); }

Friends And Related Function Documentation

◆ TruthEtIsolationsCnv_p1

friend class TruthEtIsolationsCnv_p1

friend

Definition at line 196 of file TruthEtIsolations.h.

Member Data Documentation

◆ m_dfltEtIsols

const EtIsol_t TruthEtIsolations::m_dfltEtIsols

staticprotected

Initial value:

= {
  {
    -999.*CLHEP::GeV, -999.*CLHEP::GeV, -999.*CLHEP::GeV, -999.*CLHEP::GeV,
    -999.*CLHEP::GeV, -999.*CLHEP::GeV, -999.*CLHEP::GeV, -999.*CLHEP::GeV
  }
}

The default Et isolation energy which is being returned when I don't know what to return.

That's ugly but for backward compatibility's sake... Next EDM :P

Definition at line 210 of file TruthEtIsolations.h.

◆ m_etIsolations

EtIsolMap_t TruthEtIsolations::m_etIsolations

protected

Holds transverse energy isolations for different isolation cones The key of this map is the barcode of the HepMC::GenParticle for which the Et isolations have been computed.

Definition at line 205 of file TruthEtIsolations.h.

◆ m_genEvtLink

GenEventLink_t TruthEtIsolations::m_genEvtLink

protected

ElementLink to the HepMC::GenEvent from which the Et isolations have been (or will be) computed

Definition at line 200 of file TruthEtIsolations.h.

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

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ EtIsol_t

◆ EtIsolMap_t

◆ GenEventLink_t

Constructor & Destructor Documentation

◆ TruthEtIsolations() [1/4]

◆ TruthEtIsolations() [2/4]

◆ TruthEtIsolations() [3/4]

◆ TruthEtIsolations() [4/4]

◆ ~TruthEtIsolations()

Member Function Documentation

◆ begin()

◆ end()

◆ etIsol() [1/2]

◆ etIsol() [2/2]

◆ etIsolations() [1/2]

◆ etIsolations() [2/2]

◆ genEventIdx()

◆ genEventName()

◆ hasEtIsol() [1/2]

◆ hasEtIsol() [2/2]

◆ operator=()

◆ setEtIsol() [1/3]

◆ setEtIsol() [2/3]

◆ setEtIsol() [3/3]

◆ size()

Friends And Related Function Documentation

◆ TruthEtIsolationsCnv_p1

Member Data Documentation

◆ m_dfltEtIsols

◆ m_etIsolations

◆ m_genEvtLink