Belle II Software development
BKLMHit1d Class Reference

Store one reconstructed BKLM 1D hit as a ROOT object. More...

#include <BKLMHit1d.h>

Inheritance diagram for BKLMHit1d:
RelationsInterface< TObject >

Public Member Functions

 BKLMHit1d ()
 Empty constructor for ROOT IO (needed to make the class storable)
 
 BKLMHit1d (const std::vector< std::pair< const KLMDigit *, double > > &digitsWithTime)
 Constructor used in KLMReconstructor module.
 
 BKLMHit1d (const BKLMHit1d &)
 Copy constructor.
 
BKLMHit1doperator= (const BKLMHit1d &)
 Assignment operator.
 
 ~BKLMHit1d ()
 Destructor.
 
bool inRPC () const
 Determine whether this 1D hit is in RPC or scintillator.
 
int getSection () const
 Get section number.
 
int getSector () const
 Get sector number.
 
int getLayer () const
 Get layer number.
 
int getPlane () const
 Get plane number.
 
bool isPhiReadout () const
 Get readout coordinate.
 
int getStripMin () const
 Get lowest strip number of this 1D hit.
 
int getStripMax () const
 Get highest strip number of this 1D hit.
 
double getStripAve () const
 Get average strip number.
 
int getModuleID () const
 Get detector-module identifier.
 
float getTime () const
 Get reconstructed hit time.
 
void setTime (double time)
 Set reconstructed hit time.
 
float getEnergyDeposit () const
 Get energy deposition.
 
void addRelationTo (const RelationsInterface< TObject > *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 addRelationTo (const RelationsInterface< TObject > *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< TObject > *sourceObj)
 Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).
 
void copyRelations (const RelationsInterface< TObject > *sourceObj)
 Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).
 
RelationVector< TO > getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from this object to another store array.
 
RelationVector< TO > getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from this object to another store array.
 
RelationVector< FROM > getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from another store array to this object.
 
RelationVector< FROM > getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from another store array to this object.
 
RelationVector< T > getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
 Get the relations between this object and another store array.
 
RelationVector< T > getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
 Get the relations between this object and another store array.
 
TO * getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
 Get the object to which this object has a relation.
 
TO * getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
 Get the object to which this object has a relation.
 
FROM * getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the object from which this object has a relation.
 
FROM * getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the object from which this object has a relation.
 
T * getRelated (const std::string &name="", const std::string &namedRelation="") const
 Get the object to or from which this object has a relation.
 
T * getRelated (const std::string &name="", const std::string &namedRelation="") const
 Get the object to or from which this object has a relation.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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 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.
 
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 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.
 
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.
 
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).
 
TClonesArray * getArrayPointer () const
 Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).
 

Private Member Functions

 ClassDef (RelationsInterface, 0)
 defines interface for accessing relations of objects in StoreArray.
 
 ClassDef (RelationsInterface, 0)
 defines interface for accessing relations of objects in StoreArray.
 

Private Attributes

int m_ModuleID
 detector-module identifier
 
float m_Time
 reconstructed hit time (ns)
 
float m_EnergyDeposit
 reconstructed pulse height (MeV)
 
DataStore::StoreEntrym_cacheDataStoreEntry
 Cache of the data store entry to which this object belongs.
 
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.
 
int m_cacheArrayIndex
 Cache of the index in the TClonesArray to which this object belongs.
 

Detailed Description

Store one reconstructed BKLM 1D hit as a ROOT object.

Definition at line 30 of file BKLMHit1d.h.

Constructor & Destructor Documentation

◆ BKLMHit1d() [1/3]

BKLMHit1d ( )

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

Definition at line 25 of file BKLMHit1d.cc.

25 :
27 m_ModuleID(0),
28 m_Time(0.0),
30{
31}
float m_Time
reconstructed hit time (ns)
Definition BKLMHit1d.h:152
float m_EnergyDeposit
reconstructed pulse height (MeV)
Definition BKLMHit1d.h:155
int m_ModuleID
detector-module identifier
Definition BKLMHit1d.h:149
RelationsInterface< TObject > RelationsObject
Provides interface for getting/adding relations to objects in StoreArrays.

◆ BKLMHit1d() [2/3]

BKLMHit1d ( const std::vector< std::pair< const KLMDigit *, double > > & digitsWithTime)
explicit

Constructor used in KLMReconstructor module.

Parameters
digitsWithTimevector of pair of contiguous KLMDigits with time; the value passed in the pair is used as digit time instead of the value returned by KLMDigit::getTime()

Definition at line 33 of file BKLMHit1d.cc.

33 :
35 m_ModuleID(0),
36 m_Time(0.0),
38{
39 if (digitsWithTime.size() == 0) {
40 B2WARNING("Attempt to create a BKLMHit1d with no KLMDigits");
41 return;
42 }
43 int stripMin = INT_MAX;
44 int stripMax = INT_MIN;
45 const KLMDigit* bklmDigit = digitsWithTime.front().first;
46 if (bklmDigit->getSubdetector() != KLMElementNumbers::c_BKLM)
47 B2FATAL("Trying to construct a BKLMHit1d using KLMDigits from EKLM.");
53 for (const std::pair<const KLMDigit*, double>& digitWithTime : digitsWithTime) {
54 const KLMDigit* digit = digitWithTime.first;
55 double correctedTime = digitWithTime.second;
56 if (!(bklmDigit->getSection() == digit->getSection() &&
57 bklmDigit->getSector() == digit->getSector() &&
58 bklmDigit->getLayer() == digit->getLayer() &&
59 bklmDigit->getPlane() == digit->getPlane())) {
60 B2WARNING("Attempt to combine non-parallel or distinct-module KLMDigits");
61 continue;
62 }
63 m_Time += correctedTime;
65 int strip = digit->getStrip();
66 stripMin = std::min(stripMin, strip);
67 stripMax = std::max(stripMax, strip);
68 if (digit->isMultiStrip()) {
69 m_Time += correctedTime * (digit->getLastStrip() - strip);
70 stripMax = std::max(stripMax, digit->getLastStrip());
71 }
72 addRelationTo(digit);
73 }
74
75 if (stripMax >= stripMin) {
76 m_Time /= ((stripMax - stripMin) + 1.0);
79 }
80}
static void setStripInModule(int &module, int strip)
Set strip number in module identifier.
static void setLayerInModule(int &module, int layer)
Set layer number in module identifier.
static void setSectionInModule(int &module, int section)
Set section number in module identifier.
static void setSectorInModule(int &module, int sector)
Set sector number in module identifier.
static void setPlaneInModule(int &module, int plane)
Set plane number in module identifier.
static void setMaximalStrip(int &module, int strip)
Set maximal strip number.
Definition BKLMStatus.h:49
int getSubdetector() const
Get subdetector number.
Definition KLMDigit.h:72
int getLayer() const
Get layer number.
Definition KLMDigit.h:126
int getSection() const
Get section number.
Definition KLMDigit.h:90
int getPlane() const
Get plane number.
Definition KLMDigit.h:144
int getStrip() const
Get strip number.
Definition KLMDigit.h:162
bool isMultiStrip() const
Determine whether this digit is a multi-strip one or not.
Definition KLMDigit.h:197
int getSector() const
Get sector number.
Definition KLMDigit.h:108
int getLastStrip() const
Get last strip number (for multi-strip digits).
Definition KLMDigit.h:180
float getEnergyDeposit() const
Get energy deposit.
Definition KLMDigit.h:294
void addRelationTo(const RelationsInterface< TObject > *object, float weight=1.0, const std::string &namedRelation="") const

◆ BKLMHit1d() [3/3]

BKLMHit1d ( const BKLMHit1d & h)

Copy constructor.

Definition at line 83 of file BKLMHit1d.cc.

83 :
85 m_ModuleID(h.m_ModuleID),
86 m_Time(h.m_Time),
87 m_EnergyDeposit(h.m_EnergyDeposit)
88{
89}

◆ ~BKLMHit1d()

~BKLMHit1d ( )
inline

Destructor.

Definition at line 48 of file BKLMHit1d.h.

49 {
50 }

Member Function Documentation

◆ addRelationTo() [1/4]

void addRelationTo ( const RelationsInterface< TObject > * 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)
145 DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
146 object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
147 }

◆ addRelationTo() [2/4]

void addRelationTo ( const RelationsInterface< TObject > * 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)
145 DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
146 object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
147 }

◆ addRelationTo() [3/4]

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 }

◆ addRelationTo() [4/4]

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() [1/2]

void copyRelations ( const RelationsInterface< TObject > * 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 }

◆ copyRelations() [2/2]

void copyRelations ( const RelationsInterface< TObject > * 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 }

◆ getArrayIndex() [1/2]

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 {
387 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
388 return m_cacheArrayIndex;
389 }

◆ getArrayIndex() [2/2]

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 {
387 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
388 return m_cacheArrayIndex;
389 }

◆ getArrayName() [1/2]

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.

378 {
379 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
380 return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
381 }

◆ getArrayName() [2/2]

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.

378 {
379 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
380 return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
381 }

◆ getArrayPointer() [1/2]

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 {
420 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
421 if (!m_cacheDataStoreEntry)
422 return nullptr;
423 return m_cacheDataStoreEntry->getPtrAsArray();
424 }

◆ getArrayPointer() [2/2]

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 {
420 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
421 if (!m_cacheDataStoreEntry)
422 return nullptr;
423 return m_cacheDataStoreEntry->getPtrAsArray();
424 }

◆ getEnergyDeposit()

float getEnergyDeposit ( ) const
inline

Get energy deposition.

Returns
energy deposition (MeV)

Definition at line 140 of file BKLMHit1d.h.

141 {
142 return m_EnergyDeposit;
143 }

◆ getInfo() [1/2]

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 {
372 return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
373 }

◆ getInfo() [2/2]

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 {
372 return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
373 }

◆ getInfoHTML() [1/2]

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 Cluster, MCParticle, Particle, PIDLikelihood, RecoTrack, SoftwareTriggerResult, Track, TrackFitResult, and TRGSummary.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getInfoHTML() [2/2]

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();
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 Cluster, MCParticle, Particle, PIDLikelihood, RecoTrack, SoftwareTriggerResult, Track, TrackFitResult, and TRGSummary.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getLayer()

int getLayer ( ) const
inline

Get layer number.

Returns
layer number (1..15) of this 1D hit

Definition at line 75 of file BKLMHit1d.h.

76 {
77 return BKLMElementNumbers::getLayerByModule(m_ModuleID);
78 }

◆ getModuleID()

int getModuleID ( ) const
inline

Get detector-module identifier.

Returns
detector-module identifier
See also
BKLMStatus.h

Definition at line 119 of file BKLMHit1d.h.

120 {
121 return m_ModuleID;
122 }

◆ getName() [1/2]

virtual std::string getName ( ) const
inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getName() [2/2]

virtual std::string getName ( ) const
inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getPlane()

int getPlane ( ) const
inline

Get plane number.

Returns
Plane number (0=z, 1=phi).

Definition at line 82 of file BKLMHit1d.h.

83 {
84 return BKLMElementNumbers::getPlaneByModule(m_ModuleID);
85 }

◆ getRelated() [1/2]

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 {
280 return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
281 T::Class(), name, namedRelation).object);
282 }

◆ getRelated() [2/2]

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 {
280 return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
281 T::Class(), name, namedRelation).object);
282 }

◆ getRelatedFrom() [1/2]

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 {
265 return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
267 }

◆ getRelatedFrom() [2/2]

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 {
265 return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
267 }

◆ getRelatedFromWithWeight() [1/2]

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 {
317 RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
318 FROM::Class(), name, namedRelation);
319 return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
320 }

◆ getRelatedFromWithWeight() [2/2]

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 {
317 RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
318 FROM::Class(), name, namedRelation);
319 return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
320 }

◆ getRelatedTo() [1/2]

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 {
250 return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
251 TO::Class(), name, namedRelation).object);
252 }

◆ getRelatedTo() [2/2]

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 {
250 return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
251 TO::Class(), name, namedRelation).object);
252 }

◆ getRelatedToWithWeight() [1/2]

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 {
300 RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
301 TO::Class(), name, namedRelation);
302 return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
303 }

◆ getRelatedToWithWeight() [2/2]

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 {
300 RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
301 TO::Class(), name, namedRelation);
302 return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
303 }

◆ getRelatedWithWeight() [1/2]

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 {
334 RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
335 T::Class(), name, namedRelation);
336 return std::make_pair(static_cast<T*>(entry.object), entry.weight);
337 }

◆ getRelatedWithWeight() [2/2]

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 {
334 RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
335 T::Class(), name, namedRelation);
336 return std::make_pair(static_cast<T*>(entry.object), entry.weight);
337 }

◆ getRelationsFrom() [1/2]

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 {
215 return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));
217 }

◆ getRelationsFrom() [2/2]

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 {
215 return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));
217 }

◆ getRelationsTo() [1/2]

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 {
199 return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
200 m_cacheArrayIndex, TO::Class(), name, namedRelation));
201 }

◆ getRelationsTo() [2/2]

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 {
199 return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
200 m_cacheArrayIndex, TO::Class(), name, namedRelation));
201 }

◆ getRelationsWith() [1/2]

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 {
232 return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
233 m_cacheArrayIndex, T::Class(), name, namedRelation));
234 }

◆ getRelationsWith() [2/2]

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 {
232 return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
233 m_cacheArrayIndex, T::Class(), name, namedRelation));
234 }

◆ getSection()

int getSection ( ) const
inline

Get section number.

Returns
section number (1=forward or 0=backward) of this 1D hit

Definition at line 61 of file BKLMHit1d.h.

62 {
63 return BKLMElementNumbers::getSectionByModule(m_ModuleID);
64 }

◆ getSector()

int getSector ( ) const
inline

Get sector number.

Returns
sector number (1..8) of this 1D hit

Definition at line 68 of file BKLMHit1d.h.

69 {
70 return BKLMElementNumbers::getSectorByModule(m_ModuleID);
71 }

◆ getStripAve()

double getStripAve ( ) const
inline

Get average strip number.

Returns
average strip number of this 1D hit

Definition at line 111 of file BKLMHit1d.h.

112 {
113 return 0.5 * (getStripMin() + getStripMax());
114 }

◆ getStripMax()

int getStripMax ( ) const
inline

Get highest strip number of this 1D hit.

Returns
highest strip number of this 1D hit

Definition at line 104 of file BKLMHit1d.h.

105 {
106 return BKLMStatus::getMaximalStrip(m_ModuleID);
107 }

◆ getStripMin()

int getStripMin ( ) const
inline

Get lowest strip number of this 1D hit.

Returns
lowest strip number of this 1D hit

Definition at line 97 of file BKLMHit1d.h.

98 {
99 return BKLMElementNumbers::getStripByModule(m_ModuleID);
100 }

◆ getTime()

float getTime ( ) const
inline

Get reconstructed hit time.

Returns
Reconstructed hit time (ns).

Definition at line 126 of file BKLMHit1d.h.

127 {
128 return m_Time;
129 }

◆ inRPC()

bool inRPC ( ) const
inline

Determine whether this 1D hit is in RPC or scintillator.

Returns
whether this 1D hit is in RPC (true) or scintillator (false)

Definition at line 54 of file BKLMHit1d.h.

55 {
56 return getLayer() >= BKLMElementNumbers::c_FirstRPCLayer;
57 }

◆ isPhiReadout()

bool isPhiReadout ( ) const
inline

Get readout coordinate.

Returns
readout coordinate of this 1D hit

Definition at line 89 of file BKLMHit1d.h.

90 {
91 return BKLMElementNumbers::getPlaneByModule(m_ModuleID) ==
92 BKLMElementNumbers::c_PhiPlane;
93 }

◆ operator=()

BKLMHit1d & operator= ( const BKLMHit1d & h)

Assignment operator.

Definition at line 92 of file BKLMHit1d.cc.

93{
94 m_ModuleID = h.m_ModuleID;
95 m_Time = h.m_Time;
96 m_EnergyDeposit = h.m_EnergyDeposit;
97 return *this;
98}

◆ setTime()

void setTime ( double time)
inline

Set reconstructed hit time.

Parameters
[in]timeReconstructed hit time (ns).

Definition at line 133 of file BKLMHit1d.h.

134 {
135 m_Time = time;
136 }

Member Data Documentation

◆ m_cacheArrayIndex [1/2]

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_cacheArrayIndex [2/2]

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 [1/2]

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_cacheDataStoreEntry [2/2]

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_EnergyDeposit

float m_EnergyDeposit
private

reconstructed pulse height (MeV)

Definition at line 155 of file BKLMHit1d.h.

◆ m_ModuleID

int m_ModuleID
private

detector-module identifier

See also
BKLMStatus.h

Definition at line 149 of file BKLMHit1d.h.

◆ m_Time

float m_Time
private

reconstructed hit time (ns)

Definition at line 152 of file BKLMHit1d.h.


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