Belle II Software development
TOPTimeZero Class Reference

Class to store T0 information. More...

#include <TOPTimeZero.h>

Inheritance diagram for TOPTimeZero:
RelationsInterface< BASE >

Public Member Functions

 TOPTimeZero ()
 Default constructor.
 
 TOPTimeZero (int moduleID, double t0, double err, int numPhotons)
 Usefull constructor.
 
void setHistograms (const TH1F &chi2, const TH1F &pdf, const TH1F &hits)
 Sets histograms.
 
void setAssumedMass (double mass)
 Sets particle mass used in reconstruction.
 
void setInvalid ()
 Sets time zero to invalid.
 
void setMinChi2 (double minChi2)
 Sets chi2 value at minimum.
 
unsigned getModuleID () const
 Returns slot number used to determine t0.
 
double getTime () const
 Returns time zero.
 
double getError () const
 Returns time zero uncertainty.
 
double getMinChi2 () const
 Returns chi2 value at minimum.
 
int getNumPhotons () const
 Returns number of photons used to find minimum.
 
const TH1F & getChi2 () const
 Returns histogram of chi^2 versus t0 that was used to find minimum.
 
const TH1F & getPDF () const
 Returns histogram of PDF projected to time axis.
 
const TH1F & getHits () const
 Returns histogram of time distribution of hits.
 
double getAssumedMass () const
 Returns particle mass used in time zero reconstruction.
 
bool isValid () const
 Returns the status of time zero reconstruction.
 
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 (TOPTimeZero, 4)
 ClassDef.
 

Private Attributes

int m_moduleID = 0
 slot number (1-based)
 
float m_t0 = 0
 time zero in [ns]
 
float m_err = 0
 error on time zero [ns]
 
int m_numPhotons = 0
 number of photons
 
TH1F m_chi2
 chi^2 versus t0 used to find minimum
 
TH1F m_pdf
 PDF projected to time.
 
TH1F m_hits
 time distribution of hits
 
float m_assumedMass = 0
 particle mass used in reconstruction
 
bool m_valid = false
 status: true if time zero is successfully determined
 
float m_minChi2 = 0
 chi2 value at minimum
 
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 store T0 information.

Definition at line 24 of file TOPTimeZero.h.

Constructor & Destructor Documentation

◆ TOPTimeZero() [1/2]

TOPTimeZero ( )
inline

Default constructor.

Definition at line 30 of file TOPTimeZero.h.

31 {}

◆ TOPTimeZero() [2/2]

TOPTimeZero ( int  moduleID,
double  t0,
double  err,
int  numPhotons 
)
inline

Usefull constructor.

Parameters
moduleIDslot number, photon hits from this slot used to determine t0
t0value of t0
errestimated error on t0
numPhotonsnumber of photon hits used to find minimum

Definition at line 40 of file TOPTimeZero.h.

40 :
41 m_moduleID(moduleID), m_t0(t0), m_err(err), m_numPhotons(numPhotons), m_valid(true)
42 {}
float m_err
error on time zero [ns]
Definition: TOPTimeZero.h:138
float m_t0
time zero in [ns]
Definition: TOPTimeZero.h:137
int m_numPhotons
number of photons
Definition: TOPTimeZero.h:139
int m_moduleID
slot number (1-based)
Definition: TOPTimeZero.h:136
bool m_valid
status: true if time zero is successfully determined
Definition: TOPTimeZero.h:144

Member Function Documentation

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

◆ 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

◆ getAssumedMass()

double getAssumedMass ( ) const
inline

Returns particle mass used in time zero reconstruction.

Returns
particle mass

Definition at line 126 of file TOPTimeZero.h.

126{return m_assumedMass;}
float m_assumedMass
particle mass used in reconstruction
Definition: TOPTimeZero.h:143

◆ getChi2()

const TH1F & getChi2 ( ) const
inline

Returns histogram of chi^2 versus t0 that was used to find minimum.

Returns
1D histogram

Definition at line 108 of file TOPTimeZero.h.

108{return m_chi2;}
TH1F m_chi2
chi^2 versus t0 used to find minimum
Definition: TOPTimeZero.h:140

◆ getError()

double getError ( ) const
inline

Returns time zero uncertainty.

Returns
uncertainty [ns]

Definition at line 90 of file TOPTimeZero.h.

90{return m_err;}

◆ getHits()

const TH1F & getHits ( ) const
inline

Returns histogram of time distribution of hits.

Returns
1D histogram

Definition at line 120 of file TOPTimeZero.h.

120{return m_hits;}
TH1F m_hits
time distribution of hits
Definition: TOPTimeZero.h:142

◆ 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, TRGSummary, and RecoTrack.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getMinChi2()

double getMinChi2 ( ) const
inline

Returns chi2 value at minimum.

Returns
chi2 at minimum

Definition at line 96 of file TOPTimeZero.h.

96{return m_minChi2;}
float m_minChi2
chi2 value at minimum
Definition: TOPTimeZero.h:145

◆ getModuleID()

unsigned getModuleID ( ) const
inline

Returns slot number used to determine t0.

Returns
slot number (1-based)

Definition at line 78 of file TOPTimeZero.h.

78{return m_moduleID;}

◆ 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 ""; }

◆ getNumPhotons()

int getNumPhotons ( ) const
inline

Returns number of photons used to find minimum.

Returns
number of photons

Definition at line 102 of file TOPTimeZero.h.

102{return m_numPhotons;}

◆ getPDF()

const TH1F & getPDF ( ) const
inline

Returns histogram of PDF projected to time axis.

Returns
1D histogram

Definition at line 114 of file TOPTimeZero.h.

114{return m_pdf;}
TH1F m_pdf
PDF projected to time.
Definition: TOPTimeZero.h:141

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

◆ getTime()

double getTime ( ) const
inline

Returns time zero.

Returns
time zero [ns]

Definition at line 84 of file TOPTimeZero.h.

84{return m_t0;}

◆ isValid()

bool isValid ( ) const
inline

Returns the status of time zero reconstruction.

Returns
true if successfully determined

Definition at line 132 of file TOPTimeZero.h.

132{return m_valid;}

◆ setAssumedMass()

void setAssumedMass ( double  mass)
inline

Sets particle mass used in reconstruction.

Parameters
massparticle mass

Definition at line 61 of file TOPTimeZero.h.

61{m_assumedMass = mass;}

◆ setHistograms()

void setHistograms ( const TH1F &  chi2,
const TH1F &  pdf,
const TH1F &  hits 
)
inline

Sets histograms.

Parameters
chi2chi^2 versus t0 used to find minimum
pdfPDF projected to time axis
hitstime distribution of hits

Definition at line 50 of file TOPTimeZero.h.

51 {
52 m_chi2 = chi2;
53 m_pdf = pdf;
54 m_hits = hits;
55 }

◆ setInvalid()

void setInvalid ( )
inline

Sets time zero to invalid.

Usefull when time zero not successfully determined.

Definition at line 66 of file TOPTimeZero.h.

66{m_valid = false;}

◆ setMinChi2()

void setMinChi2 ( double  minChi2)
inline

Sets chi2 value at minimum.

Parameters
minChi2value at minimum

Definition at line 72 of file TOPTimeZero.h.

72{m_minChi2 = minChi2;}

Member Data Documentation

◆ m_assumedMass

float m_assumedMass = 0
private

particle mass used in reconstruction

Definition at line 143 of file TOPTimeZero.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_chi2

TH1F m_chi2
private

chi^2 versus t0 used to find minimum

Definition at line 140 of file TOPTimeZero.h.

◆ m_err

float m_err = 0
private

error on time zero [ns]

Definition at line 138 of file TOPTimeZero.h.

◆ m_hits

TH1F m_hits
private

time distribution of hits

Definition at line 142 of file TOPTimeZero.h.

◆ m_minChi2

float m_minChi2 = 0
private

chi2 value at minimum

Definition at line 145 of file TOPTimeZero.h.

◆ m_moduleID

int m_moduleID = 0
private

slot number (1-based)

Definition at line 136 of file TOPTimeZero.h.

◆ m_numPhotons

int m_numPhotons = 0
private

number of photons

Definition at line 139 of file TOPTimeZero.h.

◆ m_pdf

TH1F m_pdf
private

PDF projected to time.

Definition at line 141 of file TOPTimeZero.h.

◆ m_t0

float m_t0 = 0
private

time zero in [ns]

Definition at line 137 of file TOPTimeZero.h.

◆ m_valid

bool m_valid = false
private

status: true if time zero is successfully determined

Definition at line 144 of file TOPTimeZero.h.


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