xAOD::CompositeParticle_v1 Class Reference

Description of a composite particle, i.e. More...

#include <CompositeParticle_v1.h>

Inheritance diagram for xAOD::CompositeParticle_v1:

Collaboration diagram for xAOD::CompositeParticle_v1:

Classes
struct	MT
	Define the enumeration of calculation methods for the transverse mass. More...

Public Member Functions
	CompositeParticle_v1 ()
	Default constructor.
void	toPersistent ()
	Function preparing the object to be persistified.
Functions implementing additional 4-momentum properties
double	px () const
	Get the px momentum component of the particle.
double	py () const
	Get the py momentum component of the particle.
double	pz () const
	Get the pz momentum component of the particle.
double	et () const
	The transverse energy ( \(e_T\)) of the particle.
void	setP4 (const FourMom_t &vec)
	Set the 4-vec.
void	setPxPyPzE (double px, double py, double pz, double e)
	Set the 4-vec.
void	setPx (double px)
	Set the x-component of the momentum.
void	setPy (double py)
	Set the y-component of the momentum.
void	setPz (double pz)
	Set the z-component of the momentum.
void	setE (double e)
	Set the energy.
Functions implementing other particly-type properties
bool	hasCharge () const
	Check if this composite particle has its charge set.
float	charge () const
	Return the electric charge.
void	setCharge (float charge)
	Set the electric charge.
bool	hasPdgId () const
	Check if this composite particle has its charge set.
int	pdgId () const
	Return the PDG identifier.
void	setPdgId (int pdgID)
	Set the PDG identifier.
Functions returning variables that are calculated from 4-momentum
information from constituents. The 4-momentum is calculated as the sum of 4-momenta of all the constituent particles whos indices are given in the vector. If one of the indices is -1, then missingET will also be used with pz=0 and E=sqrt(mpx*mpx + mpy*mpy).
FourMom_t	p4 (const std::vector< int > &partIndices) const
	The total 4-momentum.
FourMom_t	p4 (int partIndexA, int partIndexB) const
	Get the four-momentum with two indices.
FourMom_t	p4 (int partIndexA, int partIndexB, int partIndexC) const
	Get the four-momentum with three indices.
FourMom_t	p4 (int partIndexA, int partIndexB, int partIndexC, int partIndexD) const
	Get the four-momentum with four indices.
double	pt (const std::vector< int > &partIndices) const
	The transverse momentum ( \(p_T\)).
double	eta (const std::vector< int > &partIndices) const
	The pseudorapidity ( \(\eta\)).
double	phi (const std::vector< int > &partIndices) const
	The azimuthal angle ( \(\phi\)).
double	m (const std::vector< int > &partIndices) const
	The invariant mass.
double	p (const std::vector< int > &partIndices) const
	The total 3-momentum.
double	e (const std::vector< int > &partIndices) const
	The total energy.
double	rapidity (const std::vector< int > &partIndices) const
	The true rapidity (y).
double	px (const std::vector< int > &partIndices) const
	Get the px momentum component.
double	py (const std::vector< int > &partIndices) const
	Get the py momentum component.
double	pz (const std::vector< int > &partIndices) const
	Get the pz momentum component.
double	et (const std::vector< int > &partIndices) const
	The transverse energy ( \(e_T\)) Note that this differs from ( \(p_T\)) for massive particles.
double	mt (const std::vector< int > &partIndices, MT::Method method=MT::DEFAULT) const
	Get the transverse mass.
double	mt (int partIndexA, int partIndexB=-2, MT::Method method=MT::DEFAULT) const
	Get the transverse mass with only one constituent particle.
Functions implementing handling of constituents
void	addPart (const xAOD::IParticle *part, bool updateFourMom=true)
	Add a particle as an additional constituent.
void	addPart (const xAOD::IParticleLink &partLink, bool updateFourMom=true)
	Add a particle as an additional constituent.
void	addParts (const xAOD::IParticleLinkContainer &partLinkCont, bool updateFourMom=true)
	Add many constituents at the same time Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true.
void	removePart (const xAOD::IParticle *part, bool updateFourMom=true)
	Remove a particle as a constituent from this CompostiteParticle.
void	removePart (const xAOD::IParticleLink &partLink, bool updateFourMom=true)
	Remove a particle as a constituent from this CompostiteParticle.
const xAOD::MissingET *	missingET () const
	Get the MissingET object that is associated with this CompositeParticle.
void	setMissingET (const xAOD::MissingET *met, bool updateFourMom=true)
	Set the MissingET for this CompositeParticle.
void	removeMissingET (bool updateFourMom=true)
	Remove the existing MissingET object from this CompositeParticle.
bool	contains (const xAOD::MissingET *met) const
	Check if a given xAOD::MissingET object is part of this CompositeParticle.
bool	contains (const xAOD::IParticle *part) const
	Check if a given xAOD::IParticle is a constituent.
bool	contains (const xAOD::IParticleLink &partLink) const
	Check if a given xAOD::IParticle is a constituent.
std::size_t	nParts () const
	Number of constituent particles.
std::size_t	nCompParts () const
	Number of constituent CompositeParticles.
std::size_t	nPhotons () const
	Number of constituent photons.
std::size_t	nTruthPhotons () const
	Number of constituent truth photons.
std::size_t	nElectrons () const
	Number of constituent electrons.
std::size_t	nTruthElectrons () const
	Number of constituent truth electrons.
std::size_t	nMuons () const
	Number of constituent muons.
std::size_t	nTruthMuons () const
	Number of constituent truth muons.
std::size_t	nTaus () const
	Number of constituent taus.
std::size_t	nTruthTaus () const
	Number of constituent truth taus.
std::size_t	nLeptons () const
	Number of constituent leptons (electrons, muons, and taus).
std::size_t	nTruthLeptons () const
	Number of constituent truth leptons (truth electrons, truth muons, and truth taus).
std::size_t	nJets () const
	Number of constituent jets.
std::size_t	nTruthParts () const
	Number of constituent xAOD::TruthParticles.
const xAOD::IParticle *	part (std::size_t index=0) const
	Get the constituent IParticle number i.
const xAOD::IParticleLink &	partLink (std::size_t index=0) const
	Get the constituent IParticle number i as an ElementLink.
const xAOD::IParticleLinkContainer &	partLinks () const
	Get all constituents in one go.
template<typename CONTTYPE>
ConstDataVector< CONTTYPE > *	parts () const
	Method to return a DataVector<T>, e.g., a MuonContainer, for all the constituent particles, e.g., of type xAOD::Muon, that this CompositeParticle has.
xAOD::CompositeParticle_v1 *	compPart (const std::vector< int > &partIndices, const std::vector< int > &otherPartIndices=std::vector< int >{}, bool updateFourMom=true) const
	Get a CompositeParticle that is build on the fly from the constituent particles associated to the indices given (missingET is at index=-1).
xAOD::CompositeParticle_v1 *	compPart (int partIndexA, int partIndexB, int partIndexC=-2, bool updateFourMom=true) const
	Get a CompositeParticle that is build on the fly from the constituent particles associated to the indices given (missingET is at index=-1).
const xAOD::CompositeParticle_v1 *	compPart (std::size_t index=0) const
	Get the constituent number i as a CompositeParticle.
const xAOD::Photon *	photon (std::size_t index=0) const
	Get the constituent number i as a Photon.
const xAOD::Electron *	electron (std::size_t index=0) const
	Get the constituent number i as an Electron.
const xAOD::Muon *	muon (std::size_t index=0) const
	Get the constituent number i as an Muon.
const xAOD::TauJet *	tau (std::size_t index=0) const
	Get the constituent number i as a tau.
const xAOD::Jet *	jet (std::size_t index=0) const
	Get the constituent number i as a Jet.
const xAOD::TruthParticle *	truthPart (std::size_t index=0) const
	Get the constituent number i as a TruthParticle.
Functions implementing handling of other constituents. These
The constituent iterators are missing for the moment other particles are stored separetely from the main constituent particles. They will NOT be used to determine the four-momentum of this CompositeParticle. And they will NOT be used for determining the weight (and other properties) of this CompositeParticle. The main idea is that these other particles can be used for keeping track of, e.g., a third lepton to veto on, or sub-threshold jets.
void	addOtherPart (const xAOD::IParticle *part)
	Add a particle as an additional other constituent.
void	addOtherPart (const xAOD::IParticleLink &partLink)
	Add a particle as an additional other constituent.
void	addOtherParts (const xAOD::IParticleLinkContainer &partLinkCont)
	Add many other constituents at the same time.
void	removeOtherPart (const xAOD::IParticle *part)
	Remove a particle as an other constituent from this CompostiteParticle.
void	removeOtherPart (const xAOD::IParticleLink &partLink)
	Remove a particle as an other constituent from this CompostiteParticle.
bool	containsOther (const xAOD::IParticle *part) const
	Check if a given xAOD::IParticle is an other constituent.
bool	containsOther (const xAOD::IParticleLink &partLink) const
	Check if a given xAOD::IParticle is an other constituent.
std::size_t	nOtherParts () const
	Number of other constituent particles.
std::size_t	nOtherCompParts () const
	Number of other constituent CompositeParticles.
std::size_t	nOtherPhotons () const
	Number of other constituent photons.
std::size_t	nOtherTruthPhotons () const
	Number of other constituent truth photons.
std::size_t	nOtherElectrons () const
	Number of other constituent electrons.
std::size_t	nOtherTruthElectrons () const
	Number of other constituent truth electrons.
std::size_t	nOtherMuons () const
	Number of other constituent muons.
std::size_t	nOtherTruthMuons () const
	Number of other constituent truth muons.
std::size_t	nOtherTaus () const
	Number of other constituent taus.
std::size_t	nOtherTruthTaus () const
	Number of other constituent truth taus.
std::size_t	nOtherLeptons () const
	Number of other constituent leptons (electrons, muons, and taus).
std::size_t	nOtherTruthLeptons () const
	Number of other constituent truth leptons (truth electrons, truth muons, and truth taus).
std::size_t	nOtherJets () const
	Number of other constituent jets.
std::size_t	nOtherTruthParts () const
	Number of other constituent xAOD::TruthParticles.
const xAOD::IParticle *	otherPart (std::size_t index=0) const
	Get the other constituent IParticle number i.
const xAOD::IParticleLink &	otherPartLink (std::size_t index=0) const
	Get the other constituent IParticle number i as an ElementLink.
const xAOD::IParticleLinkContainer &	otherPartLinks () const
	Get all other constituents in one go.
const xAOD::CompositeParticle_v1 *	otherCompPart (std::size_t index=0) const
	Get the other constituent number i as a CompositeParticle.
const xAOD::Photon *	otherPhoton (std::size_t index=0) const
	Get the other constituent number i as a Photon.
const xAOD::Electron *	otherElectron (std::size_t index=0) const
	Get the other constituent number i as an Electron.
const xAOD::Muon *	otherMuon (std::size_t index=0) const
	Get the other constituent number i as an Muon.
const xAOD::TauJet *	otherTau (std::size_t index=0) const
	Get the other constituent number i as a tau.
const xAOD::Jet *	otherJet (std::size_t index=0) const
	Get the other constituent number i as a Jet.
const xAOD::TruthParticle *	otherTruthPart (std::size_t index=0) const
	Get the other constituent number i as a TruthParticle.
Functions implementing read-only access to auxdata (for python).
The constituent iterators are missing for the moment This specialization is needed since ROOT 6.02 doesn't yet support C++11 in the TFormula stuff with JIT compilation, see: https://sft.its.cern.ch/jira/browse/ROOT-5083
bool	getBool (const std::string &varName) const
	Access to get a variable of type bool (actually, it is stored using type char).
int	getInt (const std::string &varName) const
	Access to get a variable of type int.
unsigned int	getUInt (const std::string &varName) const
	Access to get a variable of type unsigned int.
float	getFloat (const std::string &varName) const
	Access to get a variable of type float.
double	getDouble (const std::string &varName) const
	Access to get a variable of type double.
Functions for getting and setting user properties
template<class T>
XAOD_AUXDATA_DEPRECATED T &	auxdata (const std::string &name, const std::string &clsname="")
	Fetch an aux data variable, as a non-const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED const T &	auxdata (const std::string &name, const std::string &clsname="") const
	Fetch an aux data variable, as a const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for reading or not.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for writing or not.

Protected Member Functions
void	setPartLinks (const xAOD::IParticleLinkContainer &constitLinks)
	Set all constituents in one go.
void	setOtherPartLinks (const xAOD::IParticleLinkContainer &otherPartLinks)
	Set all other constituents in one go.

Functions implementing the xAOD::IParticle interface
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
typedef ROOT::Math::LorentzVector< ROOT::Math::PxPyPzE4D< double > >	GenVecFourMom_t
	Base 4 Momentum type (GenVector).
virtual double	pt () const
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const
	The azimuthal angle ( \(\phi\)) of the particle.
virtual double	m () const
	The invariant mass of the particle.
virtual double	e () const
	The total energy of the particle.
virtual double	rapidity () const
	The true rapidity (y) of the particle.
virtual FourMom_t	p4 () const
	The full 4-momentum of the particle.
GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : GenVector form Note: can be slower than just p4 for this class; added for consistency.
virtual Type::ObjectType	type () const
	The type of the object as a simple enumeration.

Functions returning variables that are calculated from
information from constituents (not only using their 4-momenta).
float	weight (const std::vector< std::string > &varNames, const std::vector< int > &partIndices={}) const
	Get the weight for this xAOD::CompositeParticle by providing a vector of variable names that will be looked for.
float	weight (const std::string &varNameA) const
	Get the weight for this xAOD::CompositeParticle.
float	weight (const std::string &varNameA, const std::string &varNameB) const
float	weight (const std::string &varNameA, const std::string &varNameB, const std::string &varNameC) const
float	weight (const std::string &varNameA, const std::string &varNameB, const std::string &varNameC, const std::string &varNameD) const
float	weight (const std::string &varNameA, const std::string &varNameB, const std::string &varNameC, const std::string &varNameD, const std::string &varNameE) const
float	weightHelper (const xAOD::IParticle *part, const xAOD::IParticle::ConstAccessor< float > &varAcc) const
	This is a private helper method to calculate the weight.

Detailed Description

Description of a composite particle, i.e.

a particle that is composed out of several other particles/objects, e.g., a Z boson that consists out of two muons.

Author

Karsten Koeneke karst.nosp@m.en.k.nosp@m.oenek.nosp@m.e@ce.nosp@m.rn.ch

Revision

696023

Date

2015-09-21 19:09:08 +0200 (Mon, 21 Sep 2015)

Definition at line 45 of file CompositeParticle_v1.h.

Member Typedef Documentation

FourMom_t

typedef IParticle::FourMom_t xAOD::CompositeParticle_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 68 of file CompositeParticle_v1.h.

GenVecFourMom_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PxPyPzE4D<double> > xAOD::CompositeParticle_v1::GenVecFourMom_t

Base 4 Momentum type (GenVector).

Definition at line 74 of file CompositeParticle_v1.h.

Constructor & Destructor Documentation

CompositeParticle_v1()

xAOD::CompositeParticle_v1::CompositeParticle_v1

(

)

Default constructor.

Definition at line 27 of file CompositeParticle_v1.cxx.

    : IParticle() {
  }

Member Function Documentation

addOtherPart() [1/2]

void xAOD::CompositeParticle_v1::addOtherPart

(

const xAOD::IParticle *

part

)

Add a particle as an additional other constituent.

addOtherPart() [2/2]

void xAOD::CompositeParticle_v1::addOtherPart

(

const xAOD::IParticleLink &

partLink

)

Add a particle as an additional other constituent.

Definition at line 901 of file CompositeParticle_v1.cxx.

                                                                    {
    // Check if we have a valid ElementLink
    if ( ! partLink.isValid() ) {
      // This should not be... throw an error.
      throw std::runtime_error("Got an invalid ElementLink when adding constituent!");
    }
    xAOD::IParticleLinkContainer& otherPartLinks = otherPartLinksAcc( *this );
 
    // Add the given ElementLink as a constituent of this composite particle
    otherPartLinks.push_back( partLink );
    return;
  }

addOtherParts()

void xAOD::CompositeParticle_v1::addOtherParts

(

const xAOD::IParticleLinkContainer &

partLinkCont

)

Add many other constituents at the same time.

Definition at line 916 of file CompositeParticle_v1.cxx.

                                                                                      {
    for ( xAOD::IParticleLinkContainer::const_iterator
            constitItr = partLinkCont.begin(),
            constitItrEnd = partLinkCont.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      this->addOtherPart( currentLink );
    }
    return;
  }

addPart() [1/2]

void xAOD::CompositeParticle_v1::addPart	(	const xAOD::IParticle *	part,
		bool	updateFourMom = true )

Add a particle as an additional constituent.

Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true.

addPart() [2/2]

void xAOD::CompositeParticle_v1::addPart	(	const xAOD::IParticleLink &	partLink,
		bool	updateFourMom = true )

Add a particle as an additional constituent.

Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true.

Definition at line 499 of file CompositeParticle_v1.cxx.

                                                                                   {
    // Check if we have a valid ElementLink
    if ( ! partLink.isValid() ) {
      // This should not be... throw an error.
      throw std::runtime_error("Got an invalid ElementLink when adding constituent!");
    }
    xAOD::IParticleLinkContainer& constitLinks = partLinksAcc( *this );
 
    // Update the four-momentum of this composite particle, if requested
    if ( updateFourMom ) {
      this->setP4( this->p4() + (*partLink)->p4() );
      // Cannot add charge automatically as this is NOT part of the xAOD::IParticle interface
      //this->setCharge( this->charge() + (*partLink)->charge() );
    }
 
    // Add the given ElementLink as a constituent of this composite particle
    constitLinks.push_back( partLink );
    return;
  }

addParts()

void xAOD::CompositeParticle_v1::addParts	(	const xAOD::IParticleLinkContainer &	partLinkCont,
		bool	updateFourMom = true )

Add many constituents at the same time Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true.

Definition at line 521 of file CompositeParticle_v1.cxx.

                                                        {
    for ( xAOD::IParticleLinkContainer::const_iterator
            constitItr = partLinkCont.begin(),
            constitItrEnd = partLinkCont.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      this->addPart( currentLink, updateFourMom );
    }
    return;
  }

auxdata() [1/2]

template<class T>

XAOD_AUXDATA_DEPRECATED T & xAOD::IParticle::auxdata ( const std::string & name, const std::string & clsname = "" )

inlineinherited

Fetch an aux data variable, as a non-const reference.

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A modifiable reference to the decoration

Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                {
 
         return SG::Accessor< T >(name, clsname)(*this);
      }

auxdata() [2/2]

template<class T>

XAOD_AUXDATA_DEPRECATED const T & xAOD::IParticle::auxdata ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns

A constant reference to the decoration

Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
        
         return SG::ConstAccessor< T >( name, clsname )( *this );
      }

charge()

float xAOD::CompositeParticle_v1::charge

(

)

const

Return the electric charge.

Definition at line 182 of file CompositeParticle_v1.cxx.

                                           {
    if ( chargeAcc.isAvailable(*this) ) {
      // If we have stored the charge with this CompositeParticle, just use it.
      return chargeAcc(*this);
    }
    else {
      // Otherwise, try to re-calculate it from the constituents
      float charge = 0.0;
      // Sum up the charges of all constituents, if all have it
      std::size_t nParts = this->nParts();
      for ( std::size_t i=0; i<nParts; ++i ) {
        const xAOD::IParticle* part = this->part(i);
        if (!part) {
          throw std::runtime_error("Got a zero pointer to an xAOD::IParticle!");
        }
        if ( chargeAcc.isAvailable(*part) ) {
          charge += chargeAcc(*part);
        }
        else if ( part->type() != xAOD::Type::CompositeParticle ) {
          // We have an electron
          const xAOD::CompositeParticle_v1* compPart = static_cast<const xAOD::CompositeParticle_v1*>(part);
          charge += compPart->charge();
        }
      } // End: loop over all constituent particles
      return charge;
    }
  }

compPart() [1/3]

xAOD::CompositeParticle_v1 * xAOD::CompositeParticle_v1::compPart	(	const std::vector< int > &	partIndices,
		const std::vector< int > &	otherPartIndices = std::vector< int >{},
		bool	updateFourMom = true ) const

Get a CompositeParticle that is build on the fly from the constituent particles associated to the indices given (missingET is at index=-1).

If the second list of idices is given, also the "other" particles will be used in building this CompositeParticle.

compPart() [2/3]

xAOD::CompositeParticle_v1 * xAOD::CompositeParticle_v1::compPart ( int partIndexA, int partIndexB, int partIndexC = -2, bool updateFourMom = true ) const

inline

Get a CompositeParticle that is build on the fly from the constituent particles associated to the indices given (missingET is at index=-1).

This specialization to the above method is needed since ROOT 6.02 doesn't yet support C++11 in the TFormula stuff with JIT compilation, see: https://sft.its.cern.ch/jira/browse/ROOT-5083

Definition at line 418 of file CompositeParticle_v1.h.

                                                                        {
      if ( partIndexC==-2 ) {
        return this->compPart( std::vector<int>{partIndexA, partIndexB}, std::vector<int>{}, updateFourMom );
      }
      return this->compPart( std::vector<int>{partIndexA, partIndexB, partIndexC}, std::vector<int>{}, updateFourMom );
    }

compPart() [3/3]

const xAOD::CompositeParticle_v1 * xAOD::CompositeParticle_v1::compPart ( std::size_t index = 0 ) const

inline

Get the constituent number i as a CompositeParticle.

If the cast to CompositeParticle fails for a constituent, a null pointer is returned.

Definition at line 642 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->part(index);
  if ( ipart->type() != xAOD::Type::CompositeParticle ){ return 0; }
  return static_cast<const xAOD::CompositeParticle_v1*>(ipart);
}

contains() [1/3]

bool xAOD::CompositeParticle_v1::contains

(

const xAOD::IParticle *

part

)

const

Check if a given xAOD::IParticle is a constituent.

Definition at line 687 of file CompositeParticle_v1.cxx.

                                                                  {
    const xAOD::IParticleLinkContainer& constitLinks = this->partLinks();
    for ( xAOD::IParticleLinkContainer::const_iterator
            constitItr = constitLinks.begin(),
            constitItrEnd = constitLinks.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      if ( ! currentLink.isValid() ) continue;
      const xAOD::IParticle* currentPart = *currentLink;
      if ( part == currentPart ) {
        return true;
      }
    }
    return false;
  }

contains() [2/3]

bool xAOD::CompositeParticle_v1::contains

(

const xAOD::IParticleLink &

partLink

)

const

Check if a given xAOD::IParticle is a constituent.

Definition at line 706 of file CompositeParticle_v1.cxx.

                                                                          {
    const xAOD::IParticleLinkContainer& constitLinks = this->partLinks();
    for ( xAOD::IParticleLinkContainer::const_iterator
            constitItr = constitLinks.begin(),
            constitItrEnd = constitLinks.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      if ( partLink == currentLink ) {
        return true;
      }
    }
    return false;
  }

contains() [3/3]

bool xAOD::CompositeParticle_v1::contains

(

const xAOD::MissingET *

met

)

const

Check if a given xAOD::MissingET object is part of this CompositeParticle.

Definition at line 660 of file CompositeParticle_v1.cxx.

                                                                 {
    const ElementLink<xAOD::MissingETContainer>& metLink = metLinkAcc(*this);
    // Check if we have a valid ElementLink. If not, return false. This is
    // because the given met that we check against obviously exists, meaning
    // that if it would be the same, the ElementLink should have been valid.
    if ( ! metLink.isValid() ) {
      return false;
    }
    const xAOD::MissingET* thisMet = *metLink;
 
    // Check if the pointers are equal
    if ( thisMet == met ) {
      return true;
    }
 
    // Use the MissingET == operator
    if ( (*thisMet) == (*met) ) {
      return true;
    }
 
    // Otherwise, return false
    return false;
  }

containsOther() [1/2]

bool xAOD::CompositeParticle_v1::containsOther

(

const xAOD::IParticle *

part

)

const

Check if a given xAOD::IParticle is an other constituent.

Definition at line 975 of file CompositeParticle_v1.cxx.

                                                                       {
    const xAOD::IParticleLinkContainer& otherPartLinks = this->otherPartLinks();
    for ( xAOD::IParticleLinkContainer::const_iterator
            constitItr = otherPartLinks.begin(),
            constitItrEnd = otherPartLinks.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      if ( ! currentLink.isValid() ) continue;
      const xAOD::IParticle* currentPart = *currentLink;
      if ( part == currentPart ) {
        return true;
      }
    }
    return false;
  }

containsOther() [2/2]

bool xAOD::CompositeParticle_v1::containsOther

(

const xAOD::IParticleLink &

partLink

)

const

Check if a given xAOD::IParticle is an other constituent.

Definition at line 994 of file CompositeParticle_v1.cxx.

                                                                               {
    const xAOD::IParticleLinkContainer& otherPartLinks = this->otherPartLinks();
    for ( xAOD::IParticleLinkContainer::const_iterator
            constitItr = otherPartLinks.begin(),
            constitItrEnd = otherPartLinks.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      if ( partLink == currentLink ) {
        return true;
      }
    }
    return false;
  }

e() [1/2]

double xAOD::CompositeParticle_v1::e ( ) const

virtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 107 of file CompositeParticle_v1.cxx.

                                       {
    return p4().E();
  }

e() [2/2]

double xAOD::CompositeParticle_v1::e

(

const std::vector< int > &

partIndices

)

const

The total energy.

electron()

const xAOD::Electron * xAOD::CompositeParticle_v1::electron ( std::size_t index = 0 ) const

inline

Get the constituent number i as an Electron.

If the cast to Electron fails for a constituent, a null pointer is returned.

Definition at line 662 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->part(index);
  if ( ipart->type() != xAOD::Type::Electron ){ return 0; }
  return static_cast<const xAOD::Electron*>(ipart);
}

et() [1/2]

double xAOD::CompositeParticle_v1::et

(

)

const

The transverse energy ( \(e_T\)) of the particle.

Note that this differs from ( \(p_T\)) for massive particles.

Definition at line 127 of file CompositeParticle_v1.cxx.

                                        {
    return p4().Et();
  }

et() [2/2]

double xAOD::CompositeParticle_v1::et

(

const std::vector< int > &

partIndices

)

const

The transverse energy ( \(e_T\)) Note that this differs from ( \(p_T\)) for massive particles.

eta() [1/2]

double xAOD::CompositeParticle_v1::eta ( ) const

virtual

The pseudorapidity ( \(\eta\)) of the particle.

Implements xAOD::IParticle.

Definition at line 48 of file CompositeParticle_v1.cxx.

                                         {
    return p4().Eta();
  }

eta() [2/2]

double xAOD::CompositeParticle_v1::eta

(

const std::vector< int > &

partIndices

)

const

The pseudorapidity ( \(\eta\)).

genvecP4()

CompositeParticle_v1::GenVecFourMom_t xAOD::CompositeParticle_v1::genvecP4

(

)

const

The full 4-momentum of the particle : GenVector form Note: can be slower than just p4 for this class; added for consistency.

Definition at line 83 of file CompositeParticle_v1.cxx.

                                                                           {
    if ( accPx.isAvailable(*this) && accPy.isAvailable(*this)
     && accPz.isAvailable(*this) && accE.isAvailable(*this) ) {
      // We have everything stored with this CompositeParticle. Just use it.
      const double px = static_cast<double>(accPx(*this));
      const double py = static_cast<double>(accPy(*this));
      const double pz = static_cast<double>(accPz(*this));
      const double e  = static_cast<double>(accE(*this));
      return GenVecFourMom_t( px, py, pz, e );
    }
    else {
      // Not everything is stored, we need to re-calculate the p4 based on the constituents.
      // Create an empty vector such that the subsequent call will use all constituents.
      const std::vector<int> partIndices;
      FourMom_t fourmom = p4(partIndices);
      return GenVecFourMom_t(fourmom.Px(), fourmom.Py(), fourmom.Pz(), fourmom.E());
    }
  }

getBool()

bool xAOD::CompositeParticle_v1::getBool ( const std::string & varName ) const

inline

Access to get a variable of type bool (actually, it is stored using type char).

Definition at line 589 of file CompositeParticle_v1.h.

                                                          {
      return SG::ConstAccessor<bool>(varName)(*this);
    }

getDouble()

double xAOD::CompositeParticle_v1::getDouble ( const std::string & varName ) const

inline

Access to get a variable of type double.

Definition at line 609 of file CompositeParticle_v1.h.

                                                              {
      return SG::ConstAccessor<double>(varName)(*this);
    }

getFloat()

float xAOD::CompositeParticle_v1::getFloat ( const std::string & varName ) const

inline

Access to get a variable of type float.

Definition at line 604 of file CompositeParticle_v1.h.

                                                            {
      return SG::ConstAccessor<float>(varName)(*this);
    }

getInt()

int xAOD::CompositeParticle_v1::getInt ( const std::string & varName ) const

inline

Access to get a variable of type int.

Definition at line 594 of file CompositeParticle_v1.h.

                                                        {
      return SG::ConstAccessor<int>(varName)(*this);
    }

getUInt()

unsigned int xAOD::CompositeParticle_v1::getUInt ( const std::string & varName ) const

inline

Access to get a variable of type unsigned int.

Definition at line 599 of file CompositeParticle_v1.h.

                                                                  {
      return SG::ConstAccessor<unsigned int>(varName)(*this);
    }

hasCharge()

setPy setE bool xAOD::CompositeParticle_v1::hasCharge

(

)

const

Check if this composite particle has its charge set.

Definition at line 177 of file CompositeParticle_v1.cxx.

                                             {
    return chargeAcc.isAvailable( *this );
  }

hasPdgId()

bool xAOD::CompositeParticle_v1::hasPdgId

(

)

const

Check if this composite particle has its charge set.

Definition at line 217 of file CompositeParticle_v1.cxx.

                                            {
    return pdgAcc.isAvailable( *this );
  }

isAvailable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration exists or not

Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
 
         return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
      }

isAvailableWritable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable ( const std::string & name, const std::string & clsname = "" ) const

inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns

Whether the decoration is possible to set

Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                    {
 
         return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
      }

jet()

const xAOD::Jet * xAOD::CompositeParticle_v1::jet ( std::size_t index = 0 ) const

inline

Get the constituent number i as a Jet.

If the cast to Jet fails for a constituent, a null pointer is returned.

Definition at line 692 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->part(index);
  if ( ipart->type() != xAOD::Type::Jet ){ return 0; }
  return static_cast<const xAOD::Jet*>(ipart);
}

m() [1/2]

double xAOD::CompositeParticle_v1::m ( ) const

virtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 56 of file CompositeParticle_v1.cxx.

                                       {
    return p4().M();
  }

m() [2/2]

double xAOD::CompositeParticle_v1::m

(

const std::vector< int > &

partIndices

)

const

The invariant mass.

missingET()

const xAOD::MissingET * xAOD::CompositeParticle_v1::missingET

(

)

const

Get the MissingET object that is associated with this CompositeParticle.

If no (valid) MissingET object is associated with this CompositeParticle, a null pointer will be returned

Definition at line 593 of file CompositeParticle_v1.cxx.

                                        {
    if ( !(metLinkAcc.isAvailable(*this)) ) {
      return nullptr;
    }
    const ElementLink<xAOD::MissingETContainer>& metLink = metLinkAcc(*this);
    // Check if we have a valid ElementLink
    if ( ! metLink.isValid() ) {
      return nullptr;
    }
    return *metLink;
  }

mt() [1/2]

double xAOD::CompositeParticle_v1::mt	(	const std::vector< int > &	partIndices,
		MT::Method	method = MT::DEFAULT ) const

Get the transverse mass.

Specify which calculation method to use as an optional additional argument.

mt() [2/2]

double xAOD::CompositeParticle_v1::mt ( int partIndexA, int partIndexB = -2, MT::Method method = MT::DEFAULT ) const

inline

Get the transverse mass with only one constituent particle.

Specify which calculation method to use as an optional additional argument. This specialization to the above method is needed since ROOT 6.02 doesn't yet support C++11 in the TFormula stuff with JIT compilation, see: https://sft.its.cern.ch/jira/browse/ROOT-5083

Definition at line 205 of file CompositeParticle_v1.h.

                                                                                       {
      if ( partIndexB==-2 ) {
        return this->mt( std::vector<int>{partIndexA}, method );
      }
      return this->mt( std::vector<int>{partIndexA, partIndexB}, method );
    }

muon()

const xAOD::Muon * xAOD::CompositeParticle_v1::muon ( std::size_t index = 0 ) const

inline

Get the constituent number i as an Muon.

If the cast to Muon fails for a constituent, a null pointer is returned.

Definition at line 672 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->part(index);
  if ( ipart->type() != xAOD::Type::Muon ){ return 0; }
  return static_cast<const xAOD::Muon*>(ipart);
}

nCompParts()

std::size_t xAOD::CompositeParticle_v1::nCompParts

(

)

const

Number of constituent CompositeParticles.

nElectrons()

std::size_t xAOD::CompositeParticle_v1::nElectrons

(

)

const

Number of constituent electrons.

nJets()

std::size_t xAOD::CompositeParticle_v1::nJets

(

)

const

Number of constituent jets.

nLeptons()

std::size_t xAOD::CompositeParticle_v1::nLeptons

(

)

const

Number of constituent leptons (electrons, muons, and taus).

Definition at line 750 of file CompositeParticle_v1.cxx.

                                                 {
    return this->nElectrons() + this->nMuons() + this->nTaus();
  }

nMuons()

std::size_t xAOD::CompositeParticle_v1::nMuons

(

)

const

Number of constituent muons.

nOtherCompParts()

std::size_t xAOD::CompositeParticle_v1::nOtherCompParts

(

)

const

Number of other constituent CompositeParticles.

nOtherElectrons()

std::size_t xAOD::CompositeParticle_v1::nOtherElectrons

(

)

const

Number of other constituent electrons.

nOtherJets()

std::size_t xAOD::CompositeParticle_v1::nOtherJets

(

)

const

Number of other constituent jets.

nOtherLeptons()

std::size_t xAOD::CompositeParticle_v1::nOtherLeptons

(

)

const

Number of other constituent leptons (electrons, muons, and taus).

Definition at line 1038 of file CompositeParticle_v1.cxx.

                                                      {
    return this->nOtherElectrons() + this->nOtherMuons() + this->nOtherTaus();
  }

nOtherMuons()

std::size_t xAOD::CompositeParticle_v1::nOtherMuons

(

)

const

Number of other constituent muons.

nOtherParts()

std::size_t xAOD::CompositeParticle_v1::nOtherParts

(

)

const

Number of other constituent particles.

Definition at line 1010 of file CompositeParticle_v1.cxx.

                                                    {
    if( otherPartLinksAcc.isAvailable( *this ) ) {
      return otherPartLinksAcc( *this ).size();
    }
    return 0;
  }

nOtherPhotons()

std::size_t xAOD::CompositeParticle_v1::nOtherPhotons

(

)

const

Number of other constituent photons.

nOtherTaus()

std::size_t xAOD::CompositeParticle_v1::nOtherTaus

(

)

const

Number of other constituent taus.

nOtherTruthElectrons()

std::size_t xAOD::CompositeParticle_v1::nOtherTruthElectrons

(

)

const

Number of other constituent truth electrons.

nOtherTruthLeptons()

std::size_t xAOD::CompositeParticle_v1::nOtherTruthLeptons

(

)

const

Number of other constituent truth leptons (truth electrons, truth muons, and truth taus).

Definition at line 1065 of file CompositeParticle_v1.cxx.

                                                           {
    return this->nOtherTruthElectrons() + this->nOtherTruthMuons() + this->nOtherTruthTaus();
  }

nOtherTruthMuons()

std::size_t xAOD::CompositeParticle_v1::nOtherTruthMuons

(

)

const

Number of other constituent truth muons.

nOtherTruthParts()

std::size_t xAOD::CompositeParticle_v1::nOtherTruthParts

(

)

const

Number of other constituent xAOD::TruthParticles.

nOtherTruthPhotons()

std::size_t xAOD::CompositeParticle_v1::nOtherTruthPhotons

(

)

const

Number of other constituent truth photons.

nOtherTruthTaus()

std::size_t xAOD::CompositeParticle_v1::nOtherTruthTaus

(

)

const

Number of other constituent truth taus.

nParts()

std::size_t xAOD::CompositeParticle_v1::nParts

(

)

const

Number of constituent particles.

Note that MissingET is NOT counted as a constituent in this context

Definition at line 722 of file CompositeParticle_v1.cxx.

                                               {
    if( partLinksAcc.isAvailable( *this ) ) {
      return partLinksAcc( *this ).size();
    }
    return 0;
  }

nPhotons()

std::size_t xAOD::CompositeParticle_v1::nPhotons

(

)

const

Number of constituent photons.

nTaus()

std::size_t xAOD::CompositeParticle_v1::nTaus

(

)

const

Number of constituent taus.

nTruthElectrons()

std::size_t xAOD::CompositeParticle_v1::nTruthElectrons

(

)

const

Number of constituent truth electrons.

nTruthLeptons()

std::size_t xAOD::CompositeParticle_v1::nTruthLeptons

(

)

const

Number of constituent truth leptons (truth electrons, truth muons, and truth taus).

Definition at line 777 of file CompositeParticle_v1.cxx.

                                                      {
    return this->nTruthElectrons() + this->nTruthMuons() + this->nTruthTaus();
  }

nTruthMuons()

std::size_t xAOD::CompositeParticle_v1::nTruthMuons

(

)

const

Number of constituent truth muons.

nTruthParts()

std::size_t xAOD::CompositeParticle_v1::nTruthParts

(

)

const

Number of constituent xAOD::TruthParticles.

nTruthPhotons()

std::size_t xAOD::CompositeParticle_v1::nTruthPhotons

(

)

const

Number of constituent truth photons.

nTruthTaus()

std::size_t xAOD::CompositeParticle_v1::nTruthTaus

(

)

const

Number of constituent truth taus.

otherCompPart()

const xAOD::CompositeParticle_v1 * xAOD::CompositeParticle_v1::otherCompPart ( std::size_t index = 0 ) const

inline

Get the other constituent number i as a CompositeParticle.

If the cast to CompositeParticle fails for a constituent, a null pointer is returned.

Definition at line 713 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->otherPart(index);
  if ( ipart->type() != xAOD::Type::CompositeParticle ){ return 0; }
  return static_cast<const xAOD::CompositeParticle_v1*>(ipart);
}

otherElectron()

const xAOD::Electron * xAOD::CompositeParticle_v1::otherElectron ( std::size_t index = 0 ) const

inline

Get the other constituent number i as an Electron.

If the cast to Electron fails for a constituent, a null pointer is returned.

Definition at line 733 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->otherPart(index);
  if ( ipart->type() != xAOD::Type::Electron ){ return 0; }
  return static_cast<const xAOD::Electron*>(ipart);
}

otherJet()

const xAOD::Jet * xAOD::CompositeParticle_v1::otherJet ( std::size_t index = 0 ) const

inline

Get the other constituent number i as a Jet.

If the cast to Jet fails for a constituent, a null pointer is returned.

Definition at line 763 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->otherPart(index);
  if ( ipart->type() != xAOD::Type::Jet ){ return 0; }
  return static_cast<const xAOD::Jet*>(ipart);
}

otherMuon()

const xAOD::Muon * xAOD::CompositeParticle_v1::otherMuon ( std::size_t index = 0 ) const

inline

Get the other constituent number i as an Muon.

If the cast to Muon fails for a constituent, a null pointer is returned.

Definition at line 743 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->otherPart(index);
  if ( ipart->type() != xAOD::Type::Muon ){ return 0; }
  return static_cast<const xAOD::Muon*>(ipart);
}

otherPart()

const xAOD::IParticle * xAOD::CompositeParticle_v1::otherPart

(

std::size_t

index = 0

)

const

Get the other constituent IParticle number i.

Definition at line 1071 of file CompositeParticle_v1.cxx.

                                                         {
    if ( index >= this->nOtherParts() ) {
       return nullptr;
    }
    const xAOD::IParticleLink & otherPartLink = this->otherPartLink( index );
    if ( ! otherPartLink.isValid() ) {
       return nullptr;
    }
    return *otherPartLink;
  }

otherPartLink()

const xAOD::IParticleLink & xAOD::CompositeParticle_v1::otherPartLink

(

std::size_t

index = 0

)

const

Get the other constituent IParticle number i as an ElementLink.

Definition at line 1084 of file CompositeParticle_v1.cxx.

                                                             {
    if ( index >= this->nOtherParts() ) {
       static const xAOD::IParticleLink dummy;
       return dummy;
    }
    return otherPartLinks()[ index ];
  }

otherPartLinks()

const xAOD::IParticleLinkContainer & xAOD::CompositeParticle_v1::otherPartLinks

(

)

const

Get all other constituents in one go.

otherPhoton()

const xAOD::Photon * xAOD::CompositeParticle_v1::otherPhoton ( std::size_t index = 0 ) const

inline

Get the other constituent number i as a Photon.

If the cast to Photon fails for a constituent, a null pointer is returned.

Definition at line 723 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->otherPart(index);
  if ( ipart->type() != xAOD::Type::Photon ){ return 0; }
  return static_cast<const xAOD::Photon*>(ipart);
}

otherTau()

const xAOD::TauJet * xAOD::CompositeParticle_v1::otherTau ( std::size_t index = 0 ) const

inline

Get the other constituent number i as a tau.

If the cast to tau fails for a constituent, a null pointer is returned.

Definition at line 753 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->otherPart(index);
  if ( ipart->type() != xAOD::Type::Tau ){ return 0; }
  return static_cast<const xAOD::TauJet*>(ipart);
}

otherTruthPart()

const xAOD::TruthParticle * xAOD::CompositeParticle_v1::otherTruthPart ( std::size_t index = 0 ) const

inline

Get the other constituent number i as a TruthParticle.

If the cast to TruthParticle fails for a constituent, a null pointer is returned.

Definition at line 773 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->otherPart(index);
  if ( ipart->type() != xAOD::Type::TruthParticle ){ return 0; }
  return static_cast<const xAOD::TruthParticle*>(ipart);
}

p()

double xAOD::CompositeParticle_v1::p

(

const std::vector< int > &

partIndices

)

const

The total 3-momentum.

p4() [1/5]

CompositeParticle_v1::FourMom_t xAOD::CompositeParticle_v1::p4 ( ) const

virtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 64 of file CompositeParticle_v1.cxx.

                                                               {
    if ( accPx.isAvailable(*this) && accPy.isAvailable(*this)
     && accPz.isAvailable(*this) && accE.isAvailable(*this) ) {
      // We have everything stored with this CompositeParticle. Just use it.
      const double px = static_cast<double>(accPx(*this));
      const double py = static_cast<double>(accPy(*this));
      const double pz = static_cast<double>(accPz(*this));
      const double e  = static_cast<double>(accE(*this));
      return FourMom_t( px, py, pz, e );
    }
    else {
      // Not everything is stored, we need to re-calculate the p4 based on the constituents.
      // Create an empty vector such that the subsequent call will use all constituents.
      const std::vector<int> partIndices;
      return p4( partIndices );
    }
  }

p4() [2/5]

FourMom_t xAOD::CompositeParticle_v1::p4

(

const std::vector< int > &

partIndices

)

const

The total 4-momentum.

p4() [3/5]

FourMom_t xAOD::CompositeParticle_v1::p4 ( int partIndexA, int partIndexB ) const

inline

Get the four-momentum with two indices.

This specialization to the above method is needed since ROOT 6.02 doesn't yet support C++11 in the TFormula stuff with JIT compilation, see: https://sft.its.cern.ch/jira/browse/ROOT-5083

Definition at line 149 of file CompositeParticle_v1.h.

                                                                {
      return this->p4( std::vector<int>{partIndexA, partIndexB} );
    }

p4() [4/5]

FourMom_t xAOD::CompositeParticle_v1::p4 ( int partIndexA, int partIndexB, int partIndexC ) const

inline

Get the four-momentum with three indices.

Definition at line 153 of file CompositeParticle_v1.h.

                                                                                {
      return this->p4( std::vector<int>{partIndexA, partIndexB, partIndexC} );
    }

p4() [5/5]

FourMom_t xAOD::CompositeParticle_v1::p4 ( int partIndexA, int partIndexB, int partIndexC, int partIndexD ) const

inline

Get the four-momentum with four indices.

Definition at line 157 of file CompositeParticle_v1.h.

                                                                                                {
      return this->p4( std::vector<int>{partIndexA, partIndexB, partIndexC, partIndexD} );
    }

part()

const xAOD::IParticle * xAOD::CompositeParticle_v1::part

(

std::size_t

index = 0

)

const

Get the constituent IParticle number i.

Definition at line 782 of file CompositeParticle_v1.cxx.

                                                    {
    if ( index >= this->nParts() ) {
       return nullptr;
    }
    const xAOD::IParticleLink & constitLink = partLink( index );
    if ( ! constitLink.isValid() ) {
       return nullptr;
    }
    return *constitLink;
  }

partLink()

const xAOD::IParticleLink & xAOD::CompositeParticle_v1::partLink

(

std::size_t

index = 0

)

const

Get the constituent IParticle number i as an ElementLink.

Definition at line 795 of file CompositeParticle_v1.cxx.

                                                        {
    if ( index >= this->nParts() ) {
       static const xAOD::IParticleLink dummy;
       return dummy;
    }
    return partLinks()[ index ];
  }

partLinks()

const xAOD::IParticleLinkContainer & xAOD::CompositeParticle_v1::partLinks

(

)

const

Get all constituents in one go.

parts()

template<typename CONTTYPE>

ConstDataVector< CONTTYPE > * xAOD::CompositeParticle_v1::parts

(

)

const

Method to return a DataVector<T>, e.g., a MuonContainer, for all the constituent particles, e.g., of type xAOD::Muon, that this CompositeParticle has.

This DataVector be a simple SG::VIEW_ELEMENTS container, i.e., it does NOT own the elements, e.g., muons, but has simple pointers to them. However, the user is still required to take care of its memory management by either recording it to StoreGate (and thus transfering ownership), or by deleting this view-container when done with it.

pdgId()

int xAOD::CompositeParticle_v1::pdgId

(

)

const

Return the PDG identifier.

phi() [1/2]

double xAOD::CompositeParticle_v1::phi ( ) const

virtual

The azimuthal angle ( \(\phi\)) of the particle.

Implements xAOD::IParticle.

Definition at line 52 of file CompositeParticle_v1.cxx.

                                         {
    return p4().Phi();
  }

phi() [2/2]

double xAOD::CompositeParticle_v1::phi

(

const std::vector< int > &

partIndices

)

const

The azimuthal angle ( \(\phi\)).

photon()

const xAOD::Photon * xAOD::CompositeParticle_v1::photon ( std::size_t index = 0 ) const

inline

Get the constituent number i as a Photon.

If the cast to Photon fails for a constituent, a null pointer is returned.

Definition at line 652 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->part(index);
  if ( ipart->type() != xAOD::Type::Photon ){ return 0; }
  return static_cast<const xAOD::Photon*>(ipart);
}

pt() [1/2]

double xAOD::CompositeParticle_v1::pt ( ) const

virtual

The transverse momentum ( \(p_T\)) of the particle.

Implements xAOD::IParticle.

Definition at line 44 of file CompositeParticle_v1.cxx.

                                        {
    return std::hypot( px(), py() );
  }

pt() [2/2]

double xAOD::CompositeParticle_v1::pt

(

const std::vector< int > &

partIndices

)

const

The transverse momentum ( \(p_T\)).

px() [1/2]

double xAOD::CompositeParticle_v1::px

(

)

const

Get the px momentum component of the particle.

Definition at line 112 of file CompositeParticle_v1.cxx.

                                        {
    return p4().Px();
  }

px() [2/2]

double xAOD::CompositeParticle_v1::px

(

const std::vector< int > &

partIndices

)

const

Get the px momentum component.

py() [1/2]

double xAOD::CompositeParticle_v1::py

(

)

const

Get the py momentum component of the particle.

Definition at line 117 of file CompositeParticle_v1.cxx.

                                        {
    return p4().Py();
  }

py() [2/2]

double xAOD::CompositeParticle_v1::py

(

const std::vector< int > &

partIndices

)

const

Get the py momentum component.

pz() [1/2]

double xAOD::CompositeParticle_v1::pz

(

)

const

Get the pz momentum component of the particle.

Definition at line 122 of file CompositeParticle_v1.cxx.

                                        {
    return p4().Pz();
  }

pz() [2/2]

double xAOD::CompositeParticle_v1::pz

(

const std::vector< int > &

partIndices

)

const

Get the pz momentum component.

rapidity() [1/2]

double xAOD::CompositeParticle_v1::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 60 of file CompositeParticle_v1.cxx.

                                              {
    return p4().Rapidity();
  }

rapidity() [2/2]

double xAOD::CompositeParticle_v1::rapidity

(

const std::vector< int > &

partIndices

)

const

The true rapidity (y).

removeMissingET()

void xAOD::CompositeParticle_v1::removeMissingET

(

bool

updateFourMom = true

)

Remove the existing MissingET object from this CompositeParticle.

Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true.

Definition at line 636 of file CompositeParticle_v1.cxx.

                                                            {
    const xAOD::MissingET* met = this->missingET();
    if ( !met ) {
      // There is no valid MissingET object assigned... nothing can done
      return;
    }
 
    // Update the four-momentum of this composite particle, if requested
    if ( updateFourMom ) {
      xAOD::IParticle::FourMom_t metP4;
      double metpx = met->mpx();
      double metpy = met->mpy();
      metP4.SetPxPyPzE( metpx, metpy, 0.0, std::sqrt(metpx*metpx + metpy*metpy) );
      this->setP4( this->p4() - metP4 );
    }
    // Assign an invalid ElementLink here
    metLinkAcc(*this) = ElementLink<xAOD::MissingETContainer>();
    return;
  }

removeOtherPart() [1/2]

void xAOD::CompositeParticle_v1::removeOtherPart

(

const xAOD::IParticle *

part

)

Remove a particle as an other constituent from this CompostiteParticle.

Definition at line 930 of file CompositeParticle_v1.cxx.

                                                                        {
    // Check if we have a valid pointer
    if ( !part ) {
      // This should not be... throw an error.
      throw std::runtime_error("Got a zero pointer to an xAOD::IParticle when adding constituent!");
    }
 
    // Add the ElementLink of the given particle and pass it on
    const std::size_t partIdx = part->index();
    const xAOD::IParticleContainer* partCont =
      static_cast<const xAOD::IParticleContainer*>(part->container());
    this->removeOtherPart( IParticleLink( *partCont, partIdx ) );
    return;
  }

removeOtherPart() [2/2]

void xAOD::CompositeParticle_v1::removeOtherPart

(

const xAOD::IParticleLink &

partLink

)

Remove a particle as an other constituent from this CompostiteParticle.

Definition at line 948 of file CompositeParticle_v1.cxx.

                                                                           {
    // Check if we have a valid ElementLink
    if ( ! partLink.isValid() ) {
      // This should not be... throw an error.
      throw std::runtime_error("Got an invalid ElementLink when adding constituent!");
    }
    xAOD::IParticleLinkContainer& otherPartLinks = otherPartLinksAcc( *this );
 
    // Find the constituent particle that should be removed
    for ( xAOD::IParticleLinkContainer::iterator
            constitItr = otherPartLinks.begin(),
            constitItrEnd = otherPartLinks.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      if ( partLink == currentLink ) {
        // Remove the found link
        otherPartLinks.erase( constitItr );
        return;
      }
    }
    return;
  }

removePart() [1/2]

void xAOD::CompositeParticle_v1::removePart	(	const xAOD::IParticle *	part,
		bool	updateFourMom = true )

Remove a particle as a constituent from this CompostiteParticle.

Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true. If the given IParticle is not already a constituent of this CompositeParticle, nothing happens

Definition at line 536 of file CompositeParticle_v1.cxx.

                                                              {
    // Check if we have a valid pointer
    if ( !part ) {
      // This should not be... throw an error.
      throw std::runtime_error("Got a zero pointer to an xAOD::IParticle when adding constituent!");
    }
 
    // Add the ElementLink of the given particle and pass it on
    const std::size_t partIdx = part->index();
    const xAOD::IParticleContainer* partCont =
      static_cast<const xAOD::IParticleContainer*>(part->container());
    this->removePart( IParticleLink( *partCont, partIdx ), updateFourMom );
    return;
  }

removePart() [2/2]

void xAOD::CompositeParticle_v1::removePart	(	const xAOD::IParticleLink &	partLink,
		bool	updateFourMom = true )

Remove a particle as a constituent from this CompostiteParticle.

Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true. If the given IParticle is not already a constituent of this CompositeParticle, nothing happens

Definition at line 555 of file CompositeParticle_v1.cxx.

                                                         {
    // Check if we have a valid ElementLink
    if ( ! partLink.isValid() ) {
      // This should not be... throw an error.
      throw std::runtime_error("Got an invalid ElementLink when adding constituent!");
    }
    xAOD::IParticleLinkContainer& constitLinks = partLinksAcc( *this );
 
    // Find the constituent particle that should be removed
    for ( xAOD::IParticleLinkContainer::iterator
            constitItr = constitLinks.begin(),
            constitItrEnd = constitLinks.end();
          constitItr != constitItrEnd;
          ++constitItr ) {
      const xAOD::IParticleLink& currentLink = *constitItr;
      if ( partLink == currentLink ) {
        // Update the four-momentum of this composite particle, if requested
        if ( updateFourMom ) {
          this->setP4( this->p4() - (*partLink)->p4() );
          // Cannot add charge automatically as this is NOT part of the xAOD::IParticle interface
          //this->setCharge( this->charge() - (*partLink)->charge() );
        }
 
        // Remove the found link
        constitLinks.erase( constitItr );
        return;
      }
    }
    return;
  }

setCharge()

void xAOD::CompositeParticle_v1::setCharge

(

float

charge

)

Set the electric charge.

Definition at line 211 of file CompositeParticle_v1.cxx.

                                                     {
    chargeAcc(*this) = charge;
    return;
  }

setE()

void xAOD::CompositeParticle_v1::setE

(

double

e

)

Set the energy.

setMissingET()

void xAOD::CompositeParticle_v1::setMissingET	(	const xAOD::MissingET *	met,
		bool	updateFourMom = true )

Set the MissingET for this CompositeParticle.

Note that the 4-momentum of this CompositeParticle will be updated accordingly, if updateFourMom=true.

Definition at line 608 of file CompositeParticle_v1.cxx.

                                                           {
    // Check if we have a valid pointer
    if ( !met ) {
      // This should not be... throw an error.
      throw std::runtime_error("Got a zero pointer to xAOD::MissingET when adding it!");
    }
 
    // Update the four-momentum of this composite particle, if requested
    if ( updateFourMom ) {
      xAOD::IParticle::FourMom_t metP4;
      double metpx = met->mpx();
      double metpy = met->mpy();
      metP4.SetPxPyPzE( metpx, metpy, 0.0, std::sqrt(metpx*metpx + metpy*metpy) );
      this->setP4( this->p4() + metP4 );
    }
 
    // Add the given ElementLink as a constituent of this composite particle
    const std::size_t metIdx = met->index();
    const xAOD::MissingETContainer* metCont =
      static_cast<const xAOD::MissingETContainer*>(met->container());
    metLinkAcc(*this) = ElementLink<xAOD::MissingETContainer>( *metCont, metIdx );
    return;
  }

setOtherPartLinks()

void xAOD::CompositeParticle_v1::setOtherPartLinks ( const xAOD::IParticleLinkContainer & otherPartLinks )

protected

Set all other constituents in one go.

setP4()

void xAOD::CompositeParticle_v1::setP4

(

const FourMom_t &

vec

)

Set the 4-vec.

Definition at line 132 of file CompositeParticle_v1.cxx.

                                                         {
    accPx( *this ) = static_cast<float>(vec.Px());
    accPy( *this ) = static_cast<float>(vec.Py());
    accPz( *this ) = static_cast<float>(vec.Pz());
    accE( *this )  = static_cast<float>(vec.E());
  }

setPartLinks()

void xAOD::CompositeParticle_v1::setPartLinks ( const xAOD::IParticleLinkContainer & constitLinks )

protected

Set all constituents in one go.

Warning: This is meant for usage internal to this class only because no addition of the constituent properties will be done!

setPdgId()

void xAOD::CompositeParticle_v1::setPdgId

(

int

pdgID

)

Set the PDG identifier.

setPx()

void xAOD::CompositeParticle_v1::setPx

(

double

px

)

Set the x-component of the momentum.

setPxPyPzE()

void xAOD::CompositeParticle_v1::setPxPyPzE	(	double	px,
		double	py,
		double	pz,
		double	e )

Set the 4-vec.

Definition at line 140 of file CompositeParticle_v1.cxx.

                                                    {
    static const Accessor< float > acc1( "px" );
    acc1( *this ) = (float)px;
    static const Accessor< float > acc2( "py" );
    acc2( *this ) = (float)py;
    static const Accessor< float > acc3( "pz" );
    acc3( *this ) = (float)pz;
    static const Accessor< float > acc4( "e" );
    acc4( *this ) = (float)e;
  }

setPy()

void xAOD::CompositeParticle_v1::setPy

(

double

py

)

Set the y-component of the momentum.

setPz()

void xAOD::CompositeParticle_v1::setPz

(

double

pz

)

Set the z-component of the momentum.

tau()

const xAOD::TauJet * xAOD::CompositeParticle_v1::tau ( std::size_t index = 0 ) const

inline

Get the constituent number i as a tau.

If the cast to tau fails for a constituent, a null pointer is returned.

Definition at line 682 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->part(index);
  if ( ipart->type() != xAOD::Type::Tau ){ return 0; }
  return static_cast<const xAOD::TauJet*>(ipart);
}

toPersistent()

void xAOD::CompositeParticle_v1::toPersistent

(

)

Function preparing the object to be persistified.

truthPart()

const xAOD::TruthParticle * xAOD::CompositeParticle_v1::truthPart ( std::size_t index = 0 ) const

inline

Get the constituent number i as a TruthParticle.

If the cast to TruthParticle fails for a constituent, a null pointer is returned.

Definition at line 702 of file CompositeParticle_v1.h.

{
  const xAOD::IParticle* ipart = this->part(index);
  if ( ipart->type() != xAOD::Type::TruthParticle ){ return 0; }
  return static_cast<const xAOD::TruthParticle*>(ipart);
}

type()

Type::ObjectType xAOD::CompositeParticle_v1::type ( ) const

virtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 102 of file CompositeParticle_v1.cxx.

                                                  {
    return Type::CompositeParticle;
  }

weight() [1/6]

float xAOD::CompositeParticle_v1::weight ( const std::string & varNameA ) const

inline

Get the weight for this xAOD::CompositeParticle.

This specialization to the above method is needed since ROOT 6.02 doesn't yet support C++11 in the TFormula stuff with JIT compilation, see: https://sft.its.cern.ch/jira/browse/ROOT-5083

Definition at line 239 of file CompositeParticle_v1.h.

                                                           {
      return this->weight( std::vector<std::string>{varNameA} );
    }

weight() [2/6]

float xAOD::CompositeParticle_v1::weight ( const std::string & varNameA, const std::string & varNameB ) const

inline

Definition at line 242 of file CompositeParticle_v1.h.

                                                           {
      return this->weight( std::vector<std::string>{varNameA,varNameB} );
    }

weight() [3/6]

float xAOD::CompositeParticle_v1::weight ( const std::string & varNameA, const std::string & varNameB, const std::string & varNameC ) const

inline

Definition at line 246 of file CompositeParticle_v1.h.

                                                           {
      return this->weight( std::vector<std::string>{varNameA,varNameB,varNameC} );
    }

weight() [4/6]

float xAOD::CompositeParticle_v1::weight ( const std::string & varNameA, const std::string & varNameB, const std::string & varNameC, const std::string & varNameD ) const

inline

Definition at line 251 of file CompositeParticle_v1.h.

                                                           {
      return this->weight( std::vector<std::string>{varNameA,varNameB,varNameC,varNameD} );
    }

weight() [5/6]

float xAOD::CompositeParticle_v1::weight ( const std::string & varNameA, const std::string & varNameB, const std::string & varNameC, const std::string & varNameD, const std::string & varNameE ) const

inline

Definition at line 257 of file CompositeParticle_v1.h.

                                                           {
      return this->weight( std::vector<std::string>{varNameA,varNameB,varNameC,varNameD,varNameE} );
    }

weight() [6/6]

float xAOD::CompositeParticle_v1::weight	(	const std::vector< std::string > &	varNames,
		const std::vector< int > &	partIndices = {} ) const

Get the weight for this xAOD::CompositeParticle by providing a vector of variable names that will be looked for.

These variables, if found, are assumed to be of type float and to hold a multiplicative weight variable. If a given variable name is not found for this xAOD::CompositeParticle, then, the whole constituent tree will be searched for iteratively. The same variable name can be found and used for several constituents. But if a xAOD::CompositeParticle has that variable, the iterative search will not look into the constituents of that xAOD::CompositeParticle. The second, optional, argument is a list of indices such that one can restrict the variable name search to only the given constituent particles.

weightHelper()

float xAOD::CompositeParticle_v1::weightHelper ( const xAOD::IParticle * part, const xAOD::IParticle::ConstAccessor< float > & varAcc ) const

private

This is a private helper method to calculate the weight.

---

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

• CompositeParticle_v1.h
• CompositeParticle_v1.cxx