TIMBER  beta
Tree Interface for Making Binned Events with RDataFrame
Public Member Functions | List of all members
GenParticleTree Class Reference

C++ class. Constructs tree by adding particles. Establish relationships between particles (parent, child) and allows you to search for a chain of decays. More...

Public Member Functions

ParticleAddParticle (Particle particle)
 Add particle to tree. More...
 
template<class T >
ParticleAddParticle (int index, T p)
 Add particle to tree. More...
 
std::vector< std::vector< Particle * > > FindChain (std::string chainstring)
 Find a chain of decays in the tree. More...
 
 GenParticleTree (int nParticles)
 Construct a new GenParticleTree object. More...
 
std::vector< Particle * > GetChildren (Particle *particle)
 Get the list of child particles for a given particle in the tree. More...
 
ParticleGetParent (Particle *particle)
 Get the parent of the given particle in the tree. More...
 
std::vector< Particle * > GetParticles ()
 Get the list of particle objects. More...
 

Detailed Description

C++ class. Constructs tree by adding particles. Establish relationships between particles (parent, child) and allows you to search for a chain of decays.

Constructor & Destructor Documentation

◆ GenParticleTree()

GenParticleTree ( int  nParticles)

Construct a new GenParticleTree object.

Parameters
nParticles

Member Function Documentation

◆ AddParticle() [1/2]

Particle * AddParticle ( Particle  particle)

Add particle to tree.

Parameters
particle

◆ AddParticle() [2/2]

Particle* AddParticle ( int  index,
p 
)

Add particle to tree.

Template Parameters
TGenPartStruct
Parameters
indexIndex of the particle in the GenPart collection
pA GenPartStruct from TIMBER
Returns
Particle*

◆ FindChain()

std::vector< std::vector< Particle * > > FindChain ( std::string  chainstring)

Find a chain of decays in the tree.

Parameters
chainstring
Returns
std::vector<std::vector<Particle*>>

◆ GetChildren()

std::vector< Particle * > GetChildren ( Particle particle)

Get the list of child particles for a given particle in the tree.

Parameters
particle
Returns
std::vector<Particle>*

◆ GetParent()

Particle * GetParent ( Particle particle)

Get the parent of the given particle in the tree.

Parameters
particle
Returns
Particle*

◆ GetParticles()

std::vector<Particle*> GetParticles ( )

Get the list of particle objects.

Returns
std::vector<Particle*>

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