Belle II Software development
TOPProductionHitDebug Class Reference

Class to store debugging information about the hit headers in the TOP production debugging raw data format. More...

#include <TOPProductionHitDebug.h>

Inheritance diagram for TOPProductionHitDebug:
RelationsInterface< BASE >

Public Member Functions

 TOPProductionHitDebug ()
 Default constructor.
 
 TOPProductionHitDebug (bool hasWaveform, bool isOnHeap, unsigned short logicWindow, unsigned short physicalWindow, bool isWindowStraddle=false, bool isOnHeapStraddle=false, unsigned short logicWindowStraddle=0, unsigned short physicalWindowStraddle=0)
 Full constructor.
 
bool hasWaveform () const
 Returns hasWaveform flag.
 
bool isOnHeap () const
 Returns isOnHeap flag.
 
unsigned short getLogicWindow () const
 Returns logic window address.
 
unsigned short getPhysicalWindow () const
 Returns physical window address.
 
bool isWindowStraddle () const
 Returns isWindowStraddle flag showing if the hit was extracted from a window-straddling waveform.
 
bool isOnHeapStraddle () const
 Returns isOnHeap flag for straddled window.
 
unsigned short getLogicWindowStraddle () const
 Returns logic window address for straddled window.
 
unsigned short getPhysicalWindowStraddle () const
 Returns physical window address for straddled window.
 
void appendExtraWord (unsigned int extraWord)
 Appends extra word to vector of additional event words.
 
std::vector< unsigned int > getExtraWords () const
 Returns additional event words.
 
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 (TOPProductionHitDebug, 1)
 ClassDef.
 

Private Attributes

bool m_hasWaveform = false
 hit header waveform flag
 
bool m_isOnHeap = false
 hit header heap flag
 
unsigned short m_logicWindow = 0
 hit header logic window
 
unsigned short m_physicalWindow = 0
 hit header heap window
 
bool m_isWindowStraddle = false
 hit is from window-straddling waveform segment flag
 
bool m_isOnHeapStraddle = false
 hit header heap flag for second half of waveform segment in case of straddling window
 
unsigned short m_logicWindowStraddle
 hit header logic window for second half of waveform segment in case of straddling window
 
unsigned short m_physicalWindowStraddle
 hit header heap window for second half of waveform segment in case of straddling window
 
std::vector< unsigned int > m_extraWords
 additional event words
 
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 debugging information about the hit headers in the TOP production debugging raw data format.

Access these through their relations to TOPRawDigits, otherwise there is no information which scrod/carrier/asic/channel they belong to.

Definition at line 23 of file TOPProductionHitDebug.h.

Constructor & Destructor Documentation

◆ TOPProductionHitDebug() [1/2]

Default constructor.

Definition at line 29 of file TOPProductionHitDebug.h.

30 {}

◆ TOPProductionHitDebug() [2/2]

TOPProductionHitDebug ( bool  hasWaveform,
bool  isOnHeap,
unsigned short  logicWindow,
unsigned short  physicalWindow,
bool  isWindowStraddle = false,
bool  isOnHeapStraddle = false,
unsigned short  logicWindowStraddle = 0,
unsigned short  physicalWindowStraddle = 0 
)
inline

Full constructor.

Parameters
hasWaveformhas waveform or not
isOnHeapis on heap or not
logicWindowlogic window
physicalWindowphysical window
isWindowStraddleis window straddle
isOnHeapStraddleis on heap straddle
logicWindowStraddlelogic window straddle
physicalWindowStraddlephysical window straddle

Definition at line 43 of file TOPProductionHitDebug.h.

50 :
53 m_logicWindow(logicWindow),
54 m_physicalWindow(physicalWindow),
57 m_logicWindowStraddle(logicWindowStraddle),
58 m_physicalWindowStraddle(physicalWindowStraddle)
59 {
60 m_extraWords.clear();
61 }
bool isOnHeapStraddle() const
Returns isOnHeap flag for straddled window.
unsigned short m_logicWindow
hit header logic window
unsigned short m_physicalWindow
hit header heap window
unsigned short m_logicWindowStraddle
hit header logic window for second half of waveform segment in case of straddling window
bool m_hasWaveform
hit header waveform flag
bool m_isOnHeapStraddle
hit header heap flag for second half of waveform segment in case of straddling window
bool hasWaveform() const
Returns hasWaveform flag.
std::vector< unsigned int > m_extraWords
additional event words
unsigned short m_physicalWindowStraddle
hit header heap window for second half of waveform segment in case of straddling window
bool isOnHeap() const
Returns isOnHeap flag.
bool isWindowStraddle() const
Returns isWindowStraddle flag showing if the hit was extracted from a window-straddling waveform.
bool m_isWindowStraddle
hit is from window-straddling waveform segment flag
bool m_isOnHeap
hit header heap flag

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 }

◆ appendExtraWord()

void appendExtraWord ( unsigned int  extraWord)
inline

Appends extra word to vector of additional event words.

Definition at line 118 of file TOPProductionHitDebug.h.

118{ m_extraWords.push_back(extraWord); }

◆ 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

◆ getExtraWords()

std::vector< unsigned int > getExtraWords ( ) const
inline

Returns additional event words.

Returns
extraWords

Definition at line 124 of file TOPProductionHitDebug.h.

124{ return m_extraWords; }

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

◆ getLogicWindow()

unsigned short getLogicWindow ( ) const
inline

Returns logic window address.

Returns
logic window

Definition at line 81 of file TOPProductionHitDebug.h.

81{ return m_logicWindow; }

◆ getLogicWindowStraddle()

unsigned short getLogicWindowStraddle ( ) const
inline

Returns logic window address for straddled window.

Returns
logicWindowStraddle

Definition at line 107 of file TOPProductionHitDebug.h.

107{ return m_logicWindowStraddle; }

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

◆ getPhysicalWindow()

unsigned short getPhysicalWindow ( ) const
inline

Returns physical window address.

Returns
physical window

Definition at line 87 of file TOPProductionHitDebug.h.

87{ return m_physicalWindow; }

◆ getPhysicalWindowStraddle()

unsigned short getPhysicalWindowStraddle ( ) const
inline

Returns physical window address for straddled window.

Returns
physical window

Definition at line 113 of file TOPProductionHitDebug.h.

113{ return m_physicalWindowStraddle; }

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

◆ hasWaveform()

bool hasWaveform ( ) const
inline

Returns hasWaveform flag.

Returns
hasWaveform

Definition at line 68 of file TOPProductionHitDebug.h.

68{ return m_hasWaveform; }

◆ isOnHeap()

bool isOnHeap ( ) const
inline

Returns isOnHeap flag.

Returns
isOnHeap

Definition at line 74 of file TOPProductionHitDebug.h.

74{ return m_isOnHeap; }

◆ isOnHeapStraddle()

bool isOnHeapStraddle ( ) const
inline

Returns isOnHeap flag for straddled window.

Returns
isOnHeapStraddle

Definition at line 100 of file TOPProductionHitDebug.h.

100{ return m_isOnHeapStraddle; }

◆ isWindowStraddle()

bool isWindowStraddle ( ) const
inline

Returns isWindowStraddle flag showing if the hit was extracted from a window-straddling waveform.

Returns
isWindowStraddle

Definition at line 93 of file TOPProductionHitDebug.h.

93{ return m_isWindowStraddle; }

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_extraWords

std::vector<unsigned int> m_extraWords
private

additional event words

Definition at line 139 of file TOPProductionHitDebug.h.

◆ m_hasWaveform

bool m_hasWaveform = false
private

hit header waveform flag

Definition at line 128 of file TOPProductionHitDebug.h.

◆ m_isOnHeap

bool m_isOnHeap = false
private

hit header heap flag

Definition at line 129 of file TOPProductionHitDebug.h.

◆ m_isOnHeapStraddle

bool m_isOnHeapStraddle = false
private

hit header heap flag for second half of waveform segment in case of straddling window

Definition at line 133 of file TOPProductionHitDebug.h.

◆ m_isWindowStraddle

bool m_isWindowStraddle = false
private

hit is from window-straddling waveform segment flag

Definition at line 132 of file TOPProductionHitDebug.h.

◆ m_logicWindow

unsigned short m_logicWindow = 0
private

hit header logic window

Definition at line 130 of file TOPProductionHitDebug.h.

◆ m_logicWindowStraddle

unsigned short m_logicWindowStraddle
private
Initial value:
=
0

hit header logic window for second half of waveform segment in case of straddling window

Definition at line 134 of file TOPProductionHitDebug.h.

◆ m_physicalWindow

unsigned short m_physicalWindow = 0
private

hit header heap window

Definition at line 131 of file TOPProductionHitDebug.h.

◆ m_physicalWindowStraddle

unsigned short m_physicalWindowStraddle
private
Initial value:
=
0

hit header heap window for second half of waveform segment in case of straddling window

Definition at line 136 of file TOPProductionHitDebug.h.


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