Belle II Software  release-05-01-25
MCParticleTrajectory Class Reference

Class to save the full simulated trajectory of a particle. More...

#include <MCParticleTrajectory.h>

Inheritance diagram for MCParticleTrajectory:
Collaboration diagram for MCParticleTrajectory:

Public Types

typedef std::vector< MCTrajectoryPoint >::iterator iterator
 iterator definition to allow iteration
 
typedef std::vector< MCTrajectoryPoint >::const_iterator const_iterator
 const iterator definition to allow iteration
 

Public Member Functions

 MCParticleTrajectory ()
 Default constructor.
 
iterator begin ()
 return iterator to the first point
 
iterator end ()
 return iterator beyond the last point
 
const_iterator begin () const
 return const iterator to the first point
 
const_iterator end () const
 return const iterator beyond the last point
 
size_t size () const
 return number of points
 
bool empty () const
 return true if size()==0
 
const MCTrajectoryPointoperator[] (size_t index) const
 return a point
 
const MCTrajectoryPointfront () const
 return reference to the first point
 
const MCTrajectoryPointback () const
 return reference to the last point
 
void addPoint (float x, float y, float z, float px, float py, float pz)
 Add a point to the trajectory. More...
 
void simplify (float distanceTolerance)
 Simplify the trajectory using the Ramer-Douglas-Peuker algorithm. More...
 
void addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
 Add a relation from this object to another object (with caching). More...
 
void addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
 Add a relation from this object to another object (no caching, can be quite slow). More...
 
void copyRelations (const RelationsInterface< BASE > *sourceObj)
 Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights). More...
 
template<class TO >
RelationVector< TO > getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from this object to another store array. More...
 
template<class FROM >
RelationVector< FROM > getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from another store array to this object. More...
 
template<class T >
RelationVector< T > getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
 Get the relations between this object and another store array. More...
 
template<class TO >
TO * getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
 Get the object to which this object has a relation. More...
 
template<class FROM >
FROM * getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the object from which this object has a relation. More...
 
template<class T >
T * getRelated (const std::string &name="", const std::string &namedRelation="") const
 Get the object to or from which this object has a relation. More...
 
template<class TO >
std::pair< TO *, float > getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
 Get first related object & weight of relation pointing to an array. More...
 
template<class FROM >
std::pair< FROM *, float > getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
 Get first related object & weight of relation pointing from an array. More...
 
template<class T >
std::pair< T *, float > getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
 Get first related object & weight of relation pointing from/to an array. More...
 
virtual std::string getName () const
 Return a short name that describes this object, e.g. More...
 
virtual std::string getInfoHTML () const
 Return a short summary of this object's contents in HTML format. More...
 
std::string getInfo () const
 Return a short summary of this object's contents in raw text format. More...
 
std::string getArrayName () const
 Get name of array this object is stored in, or "" if not found.
 
int getArrayIndex () const
 Returns this object's array index (in StoreArray), or -1 if not found.
 

Protected Member Functions

TClonesArray * getArrayPointer () const
 Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).
 

Private Member Functions

 ClassDef (MCParticleTrajectory, 1)
 Needed to make the ROOT object storable.
 

Private Attributes

std::vector< MCTrajectoryPointm_points
 Collection of points along the trajectory.
 
DataStore::StoreEntrym_cacheDataStoreEntry
 Cache of the data store entry to which this object belongs.
 
int m_cacheArrayIndex
 Cache of the index in the TClonesArray to which this object belongs.
 

Detailed Description

Class to save the full simulated trajectory of a particle.

Definition at line 32 of file MCParticleTrajectory.h.

Member Function Documentation

◆ addPoint()

void addPoint ( float  x,
float  y,
float  z,
float  px,
float  py,
float  pz 
)
inline

Add a point to the trajectory.

Parameters
xx coordinate
yy coordinate
zz coordinate

Definition at line 64 of file MCParticleTrajectory.h.

68  :

◆ addRelationTo() [1/2]

void addRelationTo ( const RelationsInterface< BASE > *  object,
float  weight = 1.0,
const std::string &  namedRelation = "" 
) const
inlineinherited

Add a relation from this object to another object (with caching).

Parameters
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 144 of file RelationsObject.h.

◆ addRelationTo() [2/2]

void addRelationTo ( const TObject *  object,
float  weight = 1.0,
const std::string &  namedRelation = "" 
) const
inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 157 of file RelationsObject.h.

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > *  sourceObj)
inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 172 of file RelationsObject.h.

◆ getInfo()

std::string getInfo ( ) const
inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note
: You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 372 of file RelationsObject.h.

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const
inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();
See also
Particle::getInfoHTML() for a more complex example.
HTML for some utility functions.
Use getInfo() to get a raw text version of this output.

Reimplemented in TrackFitResult, TRGSummary, Track, SoftwareTriggerResult, Particle, RecoTrack, MCParticle, Cluster, and PIDLikelihood.

Definition at line 364 of file RelationsObject.h.

◆ getName()

virtual std::string getName ( ) const
inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in SpacePoint, Particle, and MCParticle.

Definition at line 346 of file RelationsObject.h.

◆ getRelated()

T* getRelated ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the object to or from which this object has a relation.

Template Parameters
TThe class of objects to or from which the relation points.
Parameters
nameThe name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
The first related object or a null pointer.

Definition at line 280 of file RelationsObject.h.

◆ getRelatedFrom()

FROM* getRelatedFrom ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the object from which this object has a relation.

Template Parameters
FROMThe class of objects from which the relation points.
Parameters
nameThe name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
The first related object or a null pointer.

Definition at line 265 of file RelationsObject.h.

◆ getRelatedFromWithWeight()

std::pair<FROM*, float> getRelatedFromWithWeight ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters
FROMThe class of objects from which the relation points.
Parameters
nameThe name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 316 of file RelationsObject.h.

◆ getRelatedTo()

TO* getRelatedTo ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the object to which this object has a relation.

Template Parameters
TOThe class of objects to which the relation points.
Parameters
nameThe name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
The first related object or a null pointer.

Definition at line 250 of file RelationsObject.h.

◆ getRelatedToWithWeight()

std::pair<TO*, float> getRelatedToWithWeight ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters
TOThe class of objects to which the relation points.
Parameters
nameThe name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 299 of file RelationsObject.h.

◆ getRelatedWithWeight()

std::pair<T*, float> getRelatedWithWeight ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters
TThe class of objects to or from which the relation points.
Parameters
nameThe name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 333 of file RelationsObject.h.

◆ getRelationsFrom()

RelationVector<FROM> getRelationsFrom ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the relations that point from another store array to this object.

Template Parameters
FROMThe class of objects from which the relations point.
Parameters
nameThe name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 214 of file RelationsObject.h.

◆ getRelationsTo()

RelationVector<TO> getRelationsTo ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the relations that point from this object to another store array.

Template Parameters
TOThe class of objects to which the relations point.
Parameters
nameThe name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 199 of file RelationsObject.h.

◆ getRelationsWith()

RelationVector<T> getRelationsWith ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters
TThe class of objects to or from which the relations point.
Parameters
nameThe name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 232 of file RelationsObject.h.

◆ simplify()

void simplify ( float  distanceTolerance)

Simplify the trajectory using the Ramer-Douglas-Peuker algorithm.

Parameters
distanceTolerancemaximum distance of the simplified path to the points of the original path

Definition at line 35 of file MCParticleTrajectory.cc.

36 {
37  // cannot simplify anything, return
38  if (distance_tolerance <= 0 || m_points.size() < 3) return;
39 
40  // stack with all segments to be investigated
41  std::stack<std::pair<iterator, iterator>> stack;
42  // push full trajectory on the stack
43  stack.push(make_pair(m_points.begin(), m_points.end() - 1));
44  // next free point: we always want the starting point so start at index 1
45  iterator nextFreePoint = m_points.begin() + 1;
46  // iterators used for the segment inspection
47  iterator firstPoint, splitPoint, finalPoint;
48  // segment direction and vector between segment start and mid point
49  TVector3 n, pa;
50  // investigate all segments until all fulfill the distance requirement
51  while (!stack.empty()) {
52  //Get first and last point
53  std::tie(firstPoint, finalPoint) = stack.top();
54  //Remove segment from stack
55  stack.pop();
56  //Direction of the segment
57  setVector(n, *firstPoint, *finalPoint, true);
58  //Calculate maximum distance of all intermediate points to the segment
59  double maxDistance(0);
60  for (auto nextPoint = firstPoint + 1; nextPoint != finalPoint; ++nextPoint) {
61  //vector from segment start (p) to point (a)
62  setVector(pa, *firstPoint, *nextPoint);
63  //3D distance between point a and line p + x*n
64  const double dist = (pa - (pa * n) * n).Mag();
65  //check if this is the maximum distance so far
66  if (dist > maxDistance) {
67  splitPoint = nextPoint;
68  maxDistance = dist;
69  }
70  }
71  //Are all points close enough? if not split the segment at the largest distance
72  if (maxDistance > distance_tolerance) {
73  //If we split in this order, all points will be in correct order since we
74  //use a stack: last thing put in is first thing to get out. So initially
75  //we inspect everything, if we divide we put in the second part and then
76  //the first and in the next round we take out the first and repeat. So
77  //effectively we look at all segments in an ordered way.
78  stack.push(make_pair(splitPoint, finalPoint));
79  stack.push(make_pair(firstPoint, splitPoint));
80  continue;
81  }
82  //Ok, all points close enough, add the final point to list of points. Due
83  //to the order in which we look at the points in a ordered way we can
84  //replace the points in place
85  *(nextFreePoint++) = *finalPoint;
86  }
87 
88  //Now delete all remaining elements
89  m_points.erase(nextFreePoint, end());
90 }

The documentation for this class was generated from the following files:
Belle2::MCParticleTrajectory::iterator
std::vector< MCTrajectoryPoint >::iterator iterator
iterator definition to allow iteration
Definition: MCParticleTrajectory.h:38
Belle2::HTML::getString
std::string getString(const TMatrixFBase &matrix, int precision=2, bool color=true)
get HTML table representing a matrix.
Definition: HTML.cc:18
Belle2::MCParticleTrajectory::end
iterator end()
return iterator beyond the last point
Definition: MCParticleTrajectory.h:44
Belle2::MCParticleTrajectory::m_points
std::vector< MCTrajectoryPoint > m_points
Collection of points along the trajectory.
Definition: MCParticleTrajectory.h:78