Belle II Software development
KLMTriggerHit Class Reference

Store KLM TRG hit information as a ROOT object. More...

#include <KLMTriggerHit.h>

Inheritance diagram for KLMTriggerHit:
RelationsInterface< BASE >

Public Member Functions

 KLMTriggerHit ()
 Empty constructor for ROOT IO (needed to make the class storable)
 
 KLMTriggerHit (int section, int sector, int layer, int phiStrip, int zStrip)
 Constructor with initial values for a hit.
 
virtual ~KLMTriggerHit ()
 Destructor.
 
int getSection () const
 Get detector end.
 
int getSector () const
 Get sector number.
 
int getLayer () const
 Get layer number.
 
int getPhiStrip () const
 Get phi strip number.
 
int getZStrip () const
 Get z strip number.
 
double getX () const
 Get x coordinate.
 
double getY () const
 Get y coordinate.
 
double getZ () const
 Get z coordinate.
 
int getXInt () const
 Get x integer coordinate.
 
int getYInt () const
 Get y integer coordinate.
 
int getZInt () const
 Get z integer coordinate.
 
void setX (double x)
 Set x coordinate.
 
void setY (double y)
 Set y coordinate.
 
void setZ (double z)
 Set z coordinate.
 
void setXInt (int xInt)
 Set x integer coordinate.
 
void setYInt (int yInt)
 Set y integer coordinate.
 
void setZInt (int zInt)
 Set z integer coordinate.
 
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 (KLMTriggerHit, 3)
 Needed to make the ROOT object storable.
 

Private Attributes

int m_section
 section number
 
int m_sector
 sector number
 
int m_layer
 layer
 
int m_phiStrip
 phi channel number
 
int m_zStrip
 z channel number
 
double m_x
 x coordinate
 
double m_y
 y coordinate
 
double m_z
 z coordinate
 
int m_xInt
 x integer coordinate in 1/8 cm
 
int m_yInt
 y integer coordinate in 1/8 cm
 
int m_zInt
 z integer coordinate in 1/8 cm
 
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

Store KLM TRG hit information as a ROOT object.

Definition at line 20 of file KLMTriggerHit.h.

Constructor & Destructor Documentation

◆ KLMTriggerHit() [1/2]

KLMTriggerHit ( )
inline

Empty constructor for ROOT IO (needed to make the class storable)

Definition at line 24 of file KLMTriggerHit.h.

24 :
25 m_section(0),
26 m_sector(0),
27 m_layer(0),
28 m_phiStrip(0),
29 m_zStrip(0),
30 m_x(0.0),
31 m_y(0.0),
32 m_z(0.0),
33 m_xInt(0),
34 m_yInt(0),
35 m_zInt(0)
36 { }
int m_section
section number
int m_zStrip
z channel number
int m_xInt
x integer coordinate in 1/8 cm
double m_x
x coordinate
int m_zInt
z integer coordinate in 1/8 cm
int m_sector
sector number
int m_phiStrip
phi channel number
int m_yInt
y integer coordinate in 1/8 cm
double m_z
z coordinate
double m_y
y coordinate

◆ KLMTriggerHit() [2/2]

KLMTriggerHit ( int  section,
int  sector,
int  layer,
int  phiStrip,
int  zStrip 
)
inline

Constructor with initial values for a hit.

Parameters
sectiondetector end (forward=true and backward=false)
sectorsector number
layerlayer number
phiStripphi strip number
zStripz strip number

Definition at line 44 of file KLMTriggerHit.h.

44 :
45 m_section(section),
46 m_sector(sector),
47 m_layer(layer),
48 m_phiStrip(phiStrip),
49 m_zStrip(zStrip),
50 m_x(0.0),
51 m_y(0.0),
52 m_z(0.0),
53 m_xInt(0),
54 m_yInt(0),
55 m_zInt(0)
56 { }

◆ ~KLMTriggerHit()

virtual ~KLMTriggerHit ( )
inlinevirtual

Destructor.

Definition at line 59 of file KLMTriggerHit.h.

59{}

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

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

◆ getLayer()

int getLayer ( ) const
inline

Get layer number.

Returns
layer number of this strip (0..14)

Definition at line 73 of file KLMTriggerHit.h.

73{ return m_layer; }

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

◆ getPhiStrip()

int getPhiStrip ( ) const
inline

Get phi strip number.

Returns
phi strip number (0..63)

Definition at line 77 of file KLMTriggerHit.h.

77{ return m_phiStrip; }

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

◆ getSection()

int getSection ( ) const
inline

Get detector end.

Returns
detector end (forward=true and backward=false)

Definition at line 65 of file KLMTriggerHit.h.

65{ return m_section; }

◆ getSector()

int getSector ( ) const
inline

Get sector number.

Returns
sector number of the hit (0..7)

Definition at line 69 of file KLMTriggerHit.h.

69{ return m_sector; }

◆ getX()

double getX ( ) const
inline

Get x coordinate.

Returns
x coordinate of the hit

Definition at line 85 of file KLMTriggerHit.h.

85{ return m_x; }

◆ getXInt()

int getXInt ( ) const
inline

Get x integer coordinate.

Returns
x integer coordinate of the hit in 1/8 cm

Definition at line 97 of file KLMTriggerHit.h.

97{ return m_xInt; }

◆ getY()

double getY ( ) const
inline

Get y coordinate.

Returns
y coordinate of the hit

Definition at line 89 of file KLMTriggerHit.h.

89{ return m_y; }

◆ getYInt()

int getYInt ( ) const
inline

Get y integer coordinate.

Returns
y integer coordinate of the hit in 1/8 cm

Definition at line 101 of file KLMTriggerHit.h.

101{ return m_yInt; }

◆ getZ()

double getZ ( ) const
inline

Get z coordinate.

Returns
z coordinate of the hit

Definition at line 93 of file KLMTriggerHit.h.

93{ return m_z; }

◆ getZInt()

int getZInt ( ) const
inline

Get z integer coordinate.

Returns
z integer coordinate of the hit in 1/8 cm

Definition at line 105 of file KLMTriggerHit.h.

105{ return m_zInt; }

◆ getZStrip()

int getZStrip ( ) const
inline

Get z strip number.

Returns
z strip number (0..63)

Definition at line 81 of file KLMTriggerHit.h.

81{ return m_zStrip; }

◆ setX()

void setX ( double  x)
inline

Set x coordinate.

Parameters
xx coordinate of the hit

Definition at line 111 of file KLMTriggerHit.h.

111{ m_x = x; }

◆ setXInt()

void setXInt ( int  xInt)
inline

Set x integer coordinate.

Parameters
xIntx integer coordinate of the hit in 1/8 cm

Definition at line 123 of file KLMTriggerHit.h.

123{ m_xInt = xInt; }

◆ setY()

void setY ( double  y)
inline

Set y coordinate.

Parameters
yy coordinate of the hit

Definition at line 115 of file KLMTriggerHit.h.

115{ m_y = y; }

◆ setYInt()

void setYInt ( int  yInt)
inline

Set y integer coordinate.

Parameters
yInty integer coordinate of the hit in 1/8 cm

Definition at line 127 of file KLMTriggerHit.h.

127{ m_yInt = yInt; }

◆ setZ()

void setZ ( double  z)
inline

Set z coordinate.

Parameters
zz coordinate of the hit

Definition at line 119 of file KLMTriggerHit.h.

119{ m_z = z; }

◆ setZInt()

void setZInt ( int  zInt)
inline

Set z integer coordinate.

Parameters
zIntz integer coordinate of the hit in 1/8 cm

Definition at line 131 of file KLMTriggerHit.h.

131{ m_zInt = zInt; }

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_layer

int m_layer
private

layer

Definition at line 141 of file KLMTriggerHit.h.

◆ m_phiStrip

int m_phiStrip
private

phi channel number

Definition at line 144 of file KLMTriggerHit.h.

◆ m_section

int m_section
private

section number

Definition at line 135 of file KLMTriggerHit.h.

◆ m_sector

int m_sector
private

sector number

Definition at line 138 of file KLMTriggerHit.h.

◆ m_x

double m_x
private

x coordinate

Definition at line 150 of file KLMTriggerHit.h.

◆ m_xInt

int m_xInt
private

x integer coordinate in 1/8 cm

Definition at line 159 of file KLMTriggerHit.h.

◆ m_y

double m_y
private

y coordinate

Definition at line 153 of file KLMTriggerHit.h.

◆ m_yInt

int m_yInt
private

y integer coordinate in 1/8 cm

Definition at line 162 of file KLMTriggerHit.h.

◆ m_z

double m_z
private

z coordinate

Definition at line 156 of file KLMTriggerHit.h.

◆ m_zInt

int m_zInt
private

z integer coordinate in 1/8 cm

Definition at line 165 of file KLMTriggerHit.h.

◆ m_zStrip

int m_zStrip
private

z channel number

Definition at line 147 of file KLMTriggerHit.h.


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