Belle II Software development
CsiDigiHit Class Reference

Class to store Csi digitized hits (output of CsIDigitizer) relation to CsiHit filled in beast/csi/modules/src/CsIDigitizerModule.cc. More...

#include <CsiDigiHit.h>

Inheritance diagram for CsiDigiHit:
RelationsInterface< BASE >

Public Member Functions

 CsiDigiHit ()
 default constructor for ROOT
 
void setCellId (uint8_t CellId)
 Set Cell ID.
 
void setCharge (uint64_t charge)
 Set Integrated Charge.
 
void setTime (uint64_t time)
 Set Trigger Time.
 
uint8_t getCellId () const
 Get Cell ID.
 
uint32_t getCharge () const
 Get Integrated Charge.
 
uint32_t getTime () const
 Get Trigger Time.
 
double getTrueEdep () const
 Get true deposited energy.
 
void setTrueEdep (double edep)
 Set True Edep.
 
uint16_t getBaseline () const
 Get Baseline.
 
void setBaseline (uint16_t baseline)
 Set Baseline.
 
uint16_t getMaxVal () const
 Get Maximal Value.
 
void setMaxVal (uint16_t maxval)
 Set Maximal Value.
 
std::vector< uint16_t > * getWaveform ()
 Get Waveform array.
 
void setWaveform (std::vector< uint16_t > *waveform)
 Set Waveform Array.
 
std::vector< uint8_t > * getStatusBits ()
 Get Status bits array.
 
void setStatusBits (std::vector< uint8_t > *status)
 Set Status Bits Array.
 
void setPDG (int pdg)
 Set incoming particle PDG code.
 
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 (CsiDigiHit, 1)
 ClassDef.
 

Private Attributes

uint8_t m_CellId
 Cell ID.
 
uint16_t m_Baseline
 Baseline (pedestal) frozen during charge integration.
 
uint16_t m_MaxVal
 Maximal value.
 
uint32_t m_Charge
 Integrated Charge.
 
uint32_t m_Time
 Trigger Time index.
 
double m_TrueEdep
 True deposited energy per event-crystal.
 
int m_PDG
 PDG code of the initial particle.
 
std::vector< uint16_t > m_Waveform
 Saved waveform.
 
std::vector< uint8_t > m_StatusBits
 Saved waveform.
 
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 Csi digitized hits (output of CsIDigitizer) relation to CsiHit filled in beast/csi/modules/src/CsIDigitizerModule.cc.

Definition at line 26 of file CsiDigiHit.h.

Constructor & Destructor Documentation

◆ CsiDigiHit()

CsiDigiHit ( )
inline

default constructor for ROOT

Definition at line 29 of file CsiDigiHit.h.

30 {
31 m_CellId = 0;
32 m_Charge = 0;
33 m_Baseline = 0;
34 m_MaxVal = 0;
35 m_Time = 0;
36 m_TrueEdep = 0;
37 m_PDG = 0;
38 m_Waveform.clear();
39 m_StatusBits.clear();
40 }
uint16_t m_Baseline
Baseline (pedestal) frozen during charge integration.
Definition: CsiDigiHit.h:128
double m_TrueEdep
True deposited energy per event-crystal.
Definition: CsiDigiHit.h:132
int m_PDG
PDG code of the initial particle.
Definition: CsiDigiHit.h:133
std::vector< uint16_t > m_Waveform
Saved waveform.
Definition: CsiDigiHit.h:134
std::vector< uint8_t > m_StatusBits
Saved waveform.
Definition: CsiDigiHit.h:135
uint32_t m_Time
Trigger Time index.
Definition: CsiDigiHit.h:131
uint16_t m_MaxVal
Maximal value.
Definition: CsiDigiHit.h:129
uint8_t m_CellId
Cell ID.
Definition: CsiDigiHit.h:127
uint32_t m_Charge
Integrated Charge.
Definition: CsiDigiHit.h:130

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

◆ getBaseline()

uint16_t getBaseline ( ) const
inline

Get Baseline.

Returns
Baseline

Definition at line 87 of file CsiDigiHit.h.

87{ return m_Baseline; }

◆ getCellId()

uint8_t getCellId ( ) const
inline

Get Cell ID.

Returns
cell ID

Definition at line 61 of file CsiDigiHit.h.

61{ return m_CellId; }

◆ getCharge()

uint32_t getCharge ( ) const
inline

Get Integrated Charge.

Returns
Integrated Charge [ADC*sample]

Definition at line 67 of file CsiDigiHit.h.

67{ return m_Charge; }

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

◆ getMaxVal()

uint16_t getMaxVal ( ) const
inline

Get Maximal Value.

Definition at line 95 of file CsiDigiHit.h.

95{ return m_MaxVal; }

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

◆ getStatusBits()

std::vector< uint8_t > * getStatusBits ( )
inline

Get Status bits array.

Returns
A pointer to the std::vector containing the status

Definition at line 114 of file CsiDigiHit.h.

114{ return &m_StatusBits; }

◆ getTime()

uint32_t getTime ( ) const
inline

Get Trigger Time.

Returns
Trigger Time

Definition at line 72 of file CsiDigiHit.h.

72{ return m_Time; }

◆ getTrueEdep()

double getTrueEdep ( ) const
inline

Get true deposited energy.

Returns
deposited energy in the event in GeV

Definition at line 77 of file CsiDigiHit.h.

77{ return m_TrueEdep; }

◆ getWaveform()

std::vector< uint16_t > * getWaveform ( )
inline

Get Waveform array.

Returns
A pointer to the std::vector containing the waveform

Definition at line 105 of file CsiDigiHit.h.

105{ return &m_Waveform; }

◆ setBaseline()

void setBaseline ( uint16_t  baseline)
inline

Set Baseline.

Definition at line 91 of file CsiDigiHit.h.

91{ m_Baseline = baseline; }

◆ setCellId()

void setCellId ( uint8_t  CellId)
inline

Set Cell ID.

Definition at line 44 of file CsiDigiHit.h.

44{ m_CellId = CellId; }

◆ setCharge()

void setCharge ( uint64_t  charge)
inline

Set Integrated Charge.

Definition at line 48 of file CsiDigiHit.h.

48{ m_Charge = charge; }
double charge(int pdgCode)
Returns electric charge of a particle with given pdg code.
Definition: EvtPDLUtil.cc:44

◆ setMaxVal()

void setMaxVal ( uint16_t  maxval)
inline

Set Maximal Value.

Definition at line 99 of file CsiDigiHit.h.

99{ m_MaxVal = maxval; }

◆ setPDG()

void setPDG ( int  pdg)
inline

Set incoming particle PDG code.

Definition at line 123 of file CsiDigiHit.h.

123{m_PDG = pdg;}

◆ setStatusBits()

void setStatusBits ( std::vector< uint8_t > *  status)
inline

Set Status Bits Array.

Definition at line 118 of file CsiDigiHit.h.

118{ m_StatusBits = *status; }

◆ setTime()

void setTime ( uint64_t  time)
inline

Set Trigger Time.

Definition at line 53 of file CsiDigiHit.h.

53{ m_Time = time; }

◆ setTrueEdep()

void setTrueEdep ( double  edep)
inline

Set True Edep.

Definition at line 81 of file CsiDigiHit.h.

81{ m_TrueEdep = edep; }

◆ setWaveform()

void setWaveform ( std::vector< uint16_t > *  waveform)
inline

Set Waveform Array.

Definition at line 109 of file CsiDigiHit.h.

109{ m_Waveform = *waveform; }

Member Data Documentation

◆ m_Baseline

uint16_t m_Baseline
private

Baseline (pedestal) frozen during charge integration.

Definition at line 128 of file CsiDigiHit.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_CellId

uint8_t m_CellId
private

Cell ID.

Definition at line 127 of file CsiDigiHit.h.

◆ m_Charge

uint32_t m_Charge
private

Integrated Charge.

Definition at line 130 of file CsiDigiHit.h.

◆ m_MaxVal

uint16_t m_MaxVal
private

Maximal value.

Definition at line 129 of file CsiDigiHit.h.

◆ m_PDG

int m_PDG
private

PDG code of the initial particle.

Definition at line 133 of file CsiDigiHit.h.

◆ m_StatusBits

std::vector<uint8_t> m_StatusBits
private

Saved waveform.

Definition at line 135 of file CsiDigiHit.h.

◆ m_Time

uint32_t m_Time
private

Trigger Time index.

Definition at line 131 of file CsiDigiHit.h.

◆ m_TrueEdep

double m_TrueEdep
private

True deposited energy per event-crystal.

Definition at line 132 of file CsiDigiHit.h.

◆ m_Waveform

std::vector<uint16_t> m_Waveform
private

Saved waveform.

Definition at line 134 of file CsiDigiHit.h.


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