Belle II Software light-2406-ragdoll
EventKinematics Class Reference

Class for collecting variables related to the global kinematics of the event. More...

#include <EventKinematics.h>

Inheritance diagram for EventKinematics:
Collaboration diagram for EventKinematics:

Public Member Functions

 EventKinematics (bool builtFromMC=false)
 Default constructor.
 
void addMissingMomentum (const ROOT::Math::XYZVector &missingMomentum)
 Add the missing momentum vector in lab.
 
void addMissingMomentumCMS (const ROOT::Math::XYZVector &missingMomentumCMS)
 Add the missing momentum vector in CMS.
 
void addMissingEnergyCMS (float missingEnergyCMS)
 Add missing energy in CMS.
 
void addMissingMass2 (float missingMass2)
 Add missing mass squared.
 
void addVisibleEnergyCMS (float visibleEnergyCMS)
 Add visible energy of the event in CMS.
 
void addTotalPhotonsEnergy (float totalPhotonsEnergy)
 Add total energy of photons in the event.
 
ROOT::Math::XYZVector getMissingMomentum (void) const
 Get missing momentum vector in lab.
 
ROOT::Math::XYZVector getMissingMomentumCMS (void) const
 Get missing momentum vector in CMS.
 
float getMissingEnergyCMS (void) const
 Get missing energy in CMS.
 
float getMissingMass2 (void) const
 Get missing mass squared.
 
float getVisibleEnergyCMS (void) const
 Get visible energy of the event.
 
float getTotalPhotonsEnergy (void) const
 Get total energy of photons in the event.
 
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 (RelationsInterface, 0)
 defines interface for accessing relations of objects in StoreArray.
 

Private Attributes

ROOT::Math::XYZVector m_missingMomentum
 Missing momentum of the event in lab.
 
ROOT::Math::XYZVector m_missingMomentumCMS
 Missing momentum of the event in CMS.
 
float m_missingEnergyCMS
 Missing energy of the event in CMS

 
float m_missingMass2
 Missing mass squared computed from m_missingMomentumCMS and m_missingEnergyCMS.
 
float m_visibleEnergyCMS
 Visible energy of the event in CMS

 
float m_photonsEnergy
 Total energy of photons in lab.
 
bool m_builtFromMC
 Is from MC switch.
 
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 for collecting variables related to the global kinematics of the event.

Mainly used to compute the missing momentum/energy/mass of qqbar continuum and tau-taubar events.

Definition at line 28 of file EventKinematics.h.

Constructor & Destructor Documentation

◆ EventKinematics()

EventKinematics ( bool  builtFromMC = false)
inline

Default constructor.

All private members are set to 0.

Definition at line 36 of file EventKinematics.h.

36 : m_missingMomentum(0.0, 0.0, 0.0), m_missingMomentumCMS(0.0, 0.0, 0.0),
ROOT::Math::XYZVector m_missingMomentum
Missing momentum of the event in lab.
float m_photonsEnergy
Total energy of photons in lab.
bool m_builtFromMC
Is from MC switch.
ROOT::Math::XYZVector m_missingMomentumCMS
Missing momentum of the event in CMS.
float m_missingEnergyCMS
Missing energy of the event in CMS
float m_missingMass2
Missing mass squared computed from m_missingMomentumCMS and m_missingEnergyCMS.
float m_visibleEnergyCMS
Visible energy of the event in CMS

Member Function Documentation

◆ addMissingEnergyCMS()

void addMissingEnergyCMS ( float  missingEnergyCMS)

Add missing energy in CMS.

Parameters
missingEnergyCMSmissing energy

Definition at line 23 of file EventKinematics.cc.

24{
25 m_missingEnergyCMS = missingEnergyCMS;
26}

◆ addMissingMass2()

void addMissingMass2 ( float  missingMass2)

Add missing mass squared.

Parameters
missingMass2missing mass squared

Definition at line 28 of file EventKinematics.cc.

29{
30 m_missingMass2 = missingMass2;
31}

◆ addMissingMomentum()

void addMissingMomentum ( const ROOT::Math::XYZVector &  missingMomentum)

Add the missing momentum vector in lab.

Parameters
missingMomentummissing momentum vector

Definition at line 13 of file EventKinematics.cc.

14{
15 m_missingMomentum = missingMomentum;
16}

◆ addMissingMomentumCMS()

void addMissingMomentumCMS ( const ROOT::Math::XYZVector &  missingMomentumCMS)

Add the missing momentum vector in CMS.

Parameters
missingMomentumCMSmissing momentum vector

Definition at line 18 of file EventKinematics.cc.

19{
20 m_missingMomentumCMS = missingMomentumCMS;
21}

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

143 {
144 if (object)
146 object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
147 }
void addRelation(const TObject *fromObject, StoreEntry *&fromEntry, int &fromIndex, const TObject *toObject, StoreEntry *&toEntry, int &toIndex, float weight, const std::string &namedRelation)
Add a relation from an object in a store array to another object in a store array.
Definition: DataStore.cc:492
static DataStore & Instance()
Instance of singleton Store.
Definition: DataStore.cc:54
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.

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

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

◆ addTotalPhotonsEnergy()

void addTotalPhotonsEnergy ( float  totalPhotonsEnergy)

Add total energy of photons in the event.

Parameters
totalPhotonsEnergytotal photon energy

Definition at line 38 of file EventKinematics.cc.

39{
40 m_photonsEnergy = totalPhotonsEnergy;
41}

◆ addVisibleEnergyCMS()

void addVisibleEnergyCMS ( float  visibleEnergyCMS)

Add visible energy of the event in CMS.

Parameters
visibleEnergyCMSvisible energy

Definition at line 33 of file EventKinematics.cc.

34{
35 m_visibleEnergyCMS = visibleEnergyCMS;
36}

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

171 {
172 if (!sourceObj)
173 return;
174 auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
175 for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
176 fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
177 }
178
179 auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
180 for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
181 this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
182 }
183 }
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).

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

386 {
388 return m_cacheArrayIndex;
389 }
bool findStoreEntry(const TObject *object, StoreEntry *&entry, int &index)
Find an object in an array in the data store.
Definition: DataStore.cc:398

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

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

419 {
422 return nullptr;
424 }
TClonesArray * getPtrAsArray() const
Return ptr cast to TClonesArray.
Definition: StoreEntry.cc:83

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

371 {
373 }
virtual std::string getInfoHTML() const
Return a short summary of this object's contents in HTML format.
std::string htmlToPlainText(const std::string &html)
See RelationsObject::getInfo()

◆ 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();
std::string getString(const TMatrixFBase &matrix, int precision=2, bool color=true)
get HTML table representing a matrix.
Definition: HTML.cc:24
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, and TRGSummary.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getMissingEnergyCMS()

float getMissingEnergyCMS ( void  ) const
inline

Get missing energy in CMS.

Returns
Float missing energy

Definition at line 111 of file EventKinematics.h.

112 {
113 return m_missingEnergyCMS;
114 }

◆ getMissingMass2()

float getMissingMass2 ( void  ) const
inline

Get missing mass squared.

Returns
Float missing mass squared

Definition at line 121 of file EventKinematics.h.

122 {
123 return m_missingMass2;
124 }

◆ getMissingMomentum()

ROOT::Math::XYZVector getMissingMomentum ( void  ) const
inline

Get missing momentum vector in lab.

Returns
XYZVector missing momentum

Definition at line 91 of file EventKinematics.h.

92 {
93 return m_missingMomentum;
94 }

◆ getMissingMomentumCMS()

ROOT::Math::XYZVector getMissingMomentumCMS ( void  ) const
inline

Get missing momentum vector in CMS.

Returns
XYZVector missing momentum

Definition at line 101 of file EventKinematics.h.

102 {
104 }

◆ getName()

virtual std::string getName ( ) const
inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in Particle, and MCParticle.

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

279 {
281 T::Class(), name, namedRelation).object);
282 }
@ c_BothSides
Combination of c_FromSide and c_ToSide.
Definition: DataStore.h:79
Belle2::RelationEntry getRelationWith(ESearchSide searchSide, const TObject *object, StoreEntry *&entry, int &index, const TClass *withClass, const std::string &withName, const std::string &namedRelation)
Get the first relation between an object and another object in a store array.
Definition: DataStore.cc:597
TObject * object
Pointer to the object.
Definition: RelationEntry.h:32

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

264 {
266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
267 }
@ c_FromSide
Return relations/objects pointed from (to a given object).
Definition: DataStore.h:77

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

316 {
318 FROM::Class(), name, namedRelation);
319 return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
320 }

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

249 {
251 TO::Class(), name, namedRelation).object);
252 }
@ c_ToSide
Return relations/objects pointed to (from a given object).
Definition: DataStore.h:78

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

299 {
301 TO::Class(), name, namedRelation);
302 return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
303 }

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

333 {
335 T::Class(), name, namedRelation);
336 return std::make_pair(static_cast<T*>(entry.object), entry.weight);
337 }

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

214 {
216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));
217 }
RelationVector< T > getRelationsWith(const std::string &name="", const std::string &namedRelation="") const
Get the relations between this object and another store array.

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

198 {
200 m_cacheArrayIndex, TO::Class(), name, namedRelation));
201 }

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

231 {
233 m_cacheArrayIndex, T::Class(), name, namedRelation));
234 }

◆ getTotalPhotonsEnergy()

float getTotalPhotonsEnergy ( void  ) const
inline

Get total energy of photons in the event.

Returns
Float total energy of photons

Definition at line 141 of file EventKinematics.h.

142 {
143 return m_photonsEnergy;
144 }

◆ getVisibleEnergyCMS()

float getVisibleEnergyCMS ( void  ) const
inline

Get visible energy of the event.

Returns
Float visible energy

Definition at line 131 of file EventKinematics.h.

132 {
133 return m_visibleEnergyCMS;
134 }

Member Data Documentation

◆ m_builtFromMC

bool m_builtFromMC
private

Is from MC switch.

Definition at line 161 of file EventKinematics.h.

◆ 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_missingEnergyCMS

float m_missingEnergyCMS
private

Missing energy of the event in CMS

Definition at line 154 of file EventKinematics.h.

◆ m_missingMass2

float m_missingMass2
private

Missing mass squared computed from m_missingMomentumCMS and m_missingEnergyCMS.

Definition at line 155 of file EventKinematics.h.

◆ m_missingMomentum

ROOT::Math::XYZVector m_missingMomentum
private

Missing momentum of the event in lab.

Definition at line 151 of file EventKinematics.h.

◆ m_missingMomentumCMS

ROOT::Math::XYZVector m_missingMomentumCMS
private

Missing momentum of the event in CMS.

Definition at line 152 of file EventKinematics.h.

◆ m_photonsEnergy

float m_photonsEnergy
private

Total energy of photons in lab.

Definition at line 159 of file EventKinematics.h.

◆ m_visibleEnergyCMS

float m_visibleEnergyCMS
private

Visible energy of the event in CMS

Definition at line 157 of file EventKinematics.h.


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