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

#include <MCParticleTrajectory.h>

Inheritance 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 MCTrajectoryPoint &	operator[] (size_t index) const
	return a point

const MCTrajectoryPoint &	front () const
	return reference to the first point

const MCTrajectoryPoint &	back () 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.

void	simplify (float distanceTolerance)
	Simplify the trajectory using the Ramer-Douglas-Peuker algorithm.

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).

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).

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

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.

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.

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.

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation.

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation.

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.

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.

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.

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.

virtual std::string	getName () const
	Return a short name that describes this object, e.g.

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format.

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format.

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< MCTrajectoryPoint >	m_points
	Collection of points along the trajectory.

DataStore::StoreEntry *	m_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 21 of file MCParticleTrajectory.h.

Member Typedef Documentation

◆ const_iterator

typedef std::vector<MCTrajectoryPoint>::const_iterator const_iterator

const iterator definition to allow iteration

Definition at line 29 of file MCParticleTrajectory.h.

◆ iterator

typedef std::vector<MCTrajectoryPoint>::iterator iterator

iterator definition to allow iteration

Definition at line 27 of file MCParticleTrajectory.h.

Constructor & Destructor Documentation

◆ MCParticleTrajectory()

MCParticleTrajectory ( )

inline

Default constructor.

Definition at line 24 of file MCParticleTrajectory.h.

24: RelationsObject(), m_points() {}

Belle2::MCParticleTrajectory::m_points

std::vector< MCTrajectoryPoint > m_points

Collection of points along the trajectory.

Definition: MCParticleTrajectory.h:70

Belle2::RelationsObject

RelationsInterface< TObject > RelationsObject

Provides interface for getting/adding relations to objects in StoreArrays.

Definition: RelationsObject.h:441

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

x	x coordinate of position
y	y coordinate of position
z	z coordinate of position
px	x coordinate of momentum
py	y coordinate of momentum
pz	z coordinate of momentum

Definition at line 56 of file MCParticleTrajectory.h.

    {
      //Reserve a decent amount of space to avoid lots of relocations
      m_points.emplace_back(x, y, z, px, py, pz);
    }

◆ 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

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

◆ 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

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

◆ back()

const MCTrajectoryPoint & back ( ) const

inline

return reference to the last point

Definition at line 47 of file MCParticleTrajectory.h.

47{ return m_points.back(); }

◆ begin() [1/2]

iterator begin ( )

inline

return iterator to the first point

Definition at line 31 of file MCParticleTrajectory.h.

31{ return m_points.begin(); }

◆ begin() [2/2]

const_iterator begin ( ) const

inline

return const iterator to the first point

Definition at line 35 of file MCParticleTrajectory.h.

35{ return m_points.begin(); }

◆ 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 170 of file RelationsObject.h.

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

◆ empty()

bool empty ( ) const

inline

return true if size()==0

Definition at line 41 of file MCParticleTrajectory.h.

41{ return m_points.empty(); }

◆ end() [1/2]

iterator end ( )

inline

return iterator beyond the last point

Definition at line 33 of file MCParticleTrajectory.h.

33{ return m_points.end(); }

◆ end() [2/2]

const_iterator end ( ) const

inline

return const iterator beyond the last point

Definition at line 37 of file MCParticleTrajectory.h.

37{ return m_points.end(); }

◆ front()

const MCTrajectoryPoint & front ( ) const

inline

return reference to the first point

Definition at line 45 of file MCParticleTrajectory.h.

45{ return m_points.front(); }

◆ getArrayIndex()

int getArrayIndex ( ) const

inlineinherited

Returns this object's array index (in StoreArray), or -1 if not found.

Definition at line 385 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

◆ getArrayName()

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

◆ getArrayPointer()

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

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

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

◆ 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 370 of file RelationsObject.h.

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

◆ 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 Particle, Cluster, MCParticle, PIDLikelihood, SoftwareTriggerResult, Track, TrackFitResult, TRGSummary, and RecoTrack.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in Particle, MCParticle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ 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

T	The class of objects to or from which the relation points.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

◆ 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

FROM	The class of objects from which the relation points.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

◆ 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

FROM	The class of objects from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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 314 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

◆ 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

TO	The class of objects to which the relation points.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

◆ 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

TO	The class of objects to which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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 297 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

◆ 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

T	The class of objects to or from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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 331 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

◆ 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

FROM	The class of objects from which the relations point.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

◆ 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

TO	The class of objects to which the relations point.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

◆ 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

T	The class of objects to or from which the relations point.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

◆ operator[]()

const MCTrajectoryPoint & operator[] ( size_t index ) const

inline

return a point

Definition at line 43 of file MCParticleTrajectory.h.

43{ return m_points[index]; }

◆ simplify()

void simplify ( float distanceTolerance )

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

Parameters

distanceTolerance maximum distance of the simplified path to the points of the original path

Definition at line 33 of file MCParticleTrajectory.cc.

{
  // cannot simplify anything, return
  if (distance_tolerance <= 0 || m_points.size() < 3) return;
 
  // stack with all segments to be investigated
  std::stack<std::pair<iterator, iterator>> stack;
  // push full trajectory on the stack
  stack.push(make_pair(m_points.begin(), m_points.end() - 1));
  // next free point: we always want the starting point so start at index 1
  iterator nextFreePoint = m_points.begin() + 1;
  // iterators used for the segment inspection
  iterator firstPoint, splitPoint, finalPoint;
  // segment direction and vector between segment start and mid point
  ROOT::Math::XYZVector n, pa;
  // investigate all segments until all fulfill the distance requirement
  while (!stack.empty()) {
    //Get first and last point
    std::tie(firstPoint, finalPoint) = stack.top();
    //Remove segment from stack
    stack.pop();
    //Direction of the segment
    setVector(n, *firstPoint, *finalPoint, true);
    //Calculate maximum distance of all intermediate points to the segment
    double maxDistance(0);
    for (auto nextPoint = firstPoint + 1; nextPoint != finalPoint; ++nextPoint) {
      //vector from segment start (p) to point (a)
      setVector(pa, *firstPoint, *nextPoint);
      //3D distance between point a and line p + x*n
      const double dist = (pa - (pa.Dot(n)) * n).R();
      //check if this is the maximum distance so far
      if (dist > maxDistance) {
        splitPoint = nextPoint;
        maxDistance = dist;
      }
    }
    //Are all points close enough? if not split the segment at the largest distance
    if (maxDistance > distance_tolerance) {
      //If we split in this order, all points will be in correct order since we
      //use a stack: last thing put in is first thing to get out. So initially
      //we inspect everything, if we divide we put in the second part and then
      //the first and in the next round we take out the first and repeat. So
      //effectively we look at all segments in an ordered way.
      stack.push(make_pair(splitPoint, finalPoint));
      stack.push(make_pair(firstPoint, splitPoint));
      continue;
    }
    //Ok, all points close enough, add the final point to list of points. Due
    //to the order in which we look at the points in a ordered way we can
    //replace the points in place
    *(nextFreePoint++) = *finalPoint;
  }
 
  //Now delete all remaining elements
  m_points.erase(nextFreePoint, end());
}

◆ size()

size_t size ( ) const

inline

return number of points

Definition at line 39 of file MCParticleTrajectory.h.

39{ return m_points.size(); }

Member Data Documentation

◆ m_cacheArrayIndex

int m_cacheArrayIndex

mutableprivateinherited

Cache of the index in the TClonesArray to which this object belongs.

Definition at line 432 of file RelationsObject.h.

◆ m_cacheDataStoreEntry

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

◆ m_points

std::vector<MCTrajectoryPoint> m_points

private

Collection of points along the trajectory.

Definition at line 70 of file MCParticleTrajectory.h.

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

simulation/dataobjects/include/MCParticleTrajectory.h
simulation/dataobjects/src/MCParticleTrajectory.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ MCParticleTrajectory()

Member Function Documentation

◆ addPoint()

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ back()

◆ begin() [1/2]

◆ begin() [2/2]

◆ copyRelations()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ front()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ operator[]()

◆ simplify()

◆ size()

Member Data Documentation

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_points