Belle II Software  release-06-01-15
BKLMSimHit Class Reference

Store one simulation hit as a ROOT object. More...

#include <BKLMSimHit.h>

Inheritance diagram for BKLMSimHit:
Collaboration diagram for BKLMSimHit:

Public Member Functions

 BKLMSimHit ()
 Empty constructor for ROOT IO (needed to make the class storable) More...
 
 BKLMSimHit (int moduleID, double x, double t, double dE)
 Constructor with initial values. More...
 
 ~BKLMSimHit ()
 Destructor.
 
 BKLMSimHit (const BKLMSimHit &)
 Copy constructor.
 
BKLMSimHitoperator= (const BKLMSimHit &)
 Assignment operator.
 
bool inRPC () const
 Determine whether this hit is in an RPC or scintillator. More...
 
int getSection () const
 Get section number. More...
 
int getSector () const
 Get sector number. More...
 
int getLayer () const
 Get layer number. More...
 
int getPlane () const
 Get plane number. More...
 
bool isPhiReadout () const
 Get readout coordinate. More...
 
int getStrip () const
 Get strip number of this hit. More...
 
int getStripMin () const
 Get lowest readout strip number of a contiguous set. More...
 
int getStripMax () const
 Get highest readout strip number of a contiguous set. More...
 
int getModuleID () const
 Get detector-module identifier. More...
 
float getPropagationTime () const
 Get signal propagation time alont strip. More...
 
float getGlobalTime () const override
 Get the hit time (implementation of base class function. More...
 
double getTime () const
 Get the hit time. More...
 
double getEnergyDeposit () const
 Get energy deposition. More...
 
void shiftInTime (float delta) override
 Adjust time (for background-overlay hit) More...
 
virtual void setBackgroundTag (unsigned int backgroundTag)
 Set background tag. More...
 
virtual unsigned short getBackgroundTag () const
 Get background tag. More...
 
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). More...
 
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). More...
 
void copyRelations (const RelationsInterface< BASE > *sourceObj)
 Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights). More...
 
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. More...
 
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. More...
 
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. More...
 
template<class TO >
TO * getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
 Get the object to which this object has a relation. More...
 
template<class FROM >
FROM * getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the object from which this object has a relation. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual std::string getName () const
 Return a short name that describes this object, e.g. More...
 
virtual std::string getInfoHTML () const
 Return a short summary of this object's contents in HTML format. More...
 
std::string getInfo () const
 Return a short summary of this object's contents in raw text format. More...
 
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

 ClassDefOverride (BKLMSimHit, 5)
 Needed to make the ROOT object storable.
 
 ClassDef (RelationsInterface, 0)
 defines interface for accessing relations of objects in StoreArray.
 

Private Attributes

int m_ModuleID
 detector-module identifier More...
 
float m_Time
 event hit time (ns)
 
float m_EDep
 energy deposition (MeV)
 
float m_PropagationTime
 time-of-propagation (ns) from hit to sensor
 
unsigned short m_backgroundTag
 Background tag.
 
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 one simulation hit as a ROOT object.

Definition at line 25 of file BKLMSimHit.h.

Constructor & Destructor Documentation

◆ BKLMSimHit() [1/2]

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

empty constructor for ROOT

Definition at line 15 of file BKLMSimHit.cc.

15  :
16  SimHitBase(),
17  m_ModuleID(0),
18  m_Time(0.0),
19  m_EDep(0.0),
21 {
22 }
float m_Time
event hit time (ns)
Definition: BKLMSimHit.h:164
int m_ModuleID
detector-module identifier
Definition: BKLMSimHit.h:161
float m_EDep
energy deposition (MeV)
Definition: BKLMSimHit.h:167
float m_PropagationTime
time-of-propagation (ns) from hit to sensor
Definition: BKLMSimHit.h:170
SimHitBase()
Constructor.
Definition: SimHitBase.h:33

◆ BKLMSimHit() [2/2]

BKLMSimHit ( int  moduleID,
double  x,
double  t,
double  dE 
)

Constructor with initial values.

Parameters
moduleIDmodule identifier
xposition along the strip (cm)
ttime since start of event (ns)
dEdeposited energy (MeV)
See also
BKLMStatus.h for moduleID

Definition at line 25 of file BKLMSimHit.cc.

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.

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

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

◆ getBackgroundTag()

virtual unsigned short getBackgroundTag ( ) const
inlinevirtualinherited

Get background tag.

Returns
The background tag value.

Definition at line 46 of file SimHitBase.h.

◆ getEnergyDeposit()

double getEnergyDeposit ( ) const
inline

Get energy deposition.

Returns
energy deposition (MeV)

Definition at line 145 of file BKLMSimHit.h.

146  {
147  return (double)m_EDep;
148  }

◆ getGlobalTime()

float getGlobalTime ( ) const
inlineoverridevirtual

Get the hit time (implementation of base class function.

Returns
the hit time (ns) since start of the event

Reimplemented from SimHitBase.

Definition at line 131 of file BKLMSimHit.h.

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

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

Definition at line 362 of file RelationsObject.h.

◆ getLayer()

int getLayer ( ) const
inline

Get layer number.

Returns
layer number of this hit

Definition at line 74 of file BKLMSimHit.h.

◆ getModuleID()

int getModuleID ( ) const
inline

Get detector-module identifier.

Returns
detector-module identifier

Definition at line 117 of file BKLMSimHit.h.

◆ getName()

virtual std::string getName ( ) const
inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in SpacePoint, MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

◆ getPlane()

int getPlane ( ) const
inline

Get plane number.

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

Definition at line 81 of file BKLMSimHit.h.

◆ getPropagationTime()

float getPropagationTime ( ) const
inline

Get signal propagation time alont strip.

Returns
time-of-propagation (ns) from hit to sensor

Definition at line 124 of file BKLMSimHit.h.

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

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

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

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

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

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

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

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

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

◆ getSection()

int getSection ( ) const
inline

Get section number.

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

Definition at line 60 of file BKLMSimHit.h.

◆ getSector()

int getSector ( ) const
inline

Get sector number.

Returns
sector number of this hit

Definition at line 67 of file BKLMSimHit.h.

◆ getStrip()

int getStrip ( ) const
inline

Get strip number of this hit.

Returns
readout strip number of this hit (assuming one strip per hit)

Definition at line 96 of file BKLMSimHit.h.

◆ getStripMax()

int getStripMax ( ) const
inline

Get highest readout strip number of a contiguous set.

Returns
highest readout strip number of this hit (assuming a contiguous set of RPC strips)

Definition at line 110 of file BKLMSimHit.h.

◆ getStripMin()

int getStripMin ( ) const
inline

Get lowest readout strip number of a contiguous set.

Returns
lowest readout strip number of this hit (assuming a contiguous set of RPC strips)

Definition at line 103 of file BKLMSimHit.h.

◆ getTime()

double getTime ( ) const
inline

Get the hit time.

Returns
the hit time (ns) since start of the event

Definition at line 138 of file BKLMSimHit.h.

◆ inRPC()

bool inRPC ( ) const
inline

Determine whether this hit is in an RPC or scintillator.

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

Definition at line 53 of file BKLMSimHit.h.

◆ isPhiReadout()

bool isPhiReadout ( ) const
inline

Get readout coordinate.

Returns
readout coordinate (TRUE=phi, FALSE=z) of this hit

Definition at line 88 of file BKLMSimHit.h.

◆ setBackgroundTag()

virtual void setBackgroundTag ( unsigned int  backgroundTag)
inlinevirtualinherited

Set background tag.

Parameters
backgroundTagThe desired setting of the background tag.

Definition at line 39 of file SimHitBase.h.

◆ shiftInTime()

void shiftInTime ( float  delta)
inlineoverridevirtual

Adjust time (for background-overlay hit)

Parameters
deltatime shift (ns)

Reimplemented from SimHitBase.

Definition at line 152 of file BKLMSimHit.h.

Member Data Documentation

◆ m_ModuleID

int m_ModuleID
private

detector-module identifier

See also
BKLMStatus.h

Definition at line 161 of file BKLMSimHit.h.


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