Belle II Software  release-05-01-25
BKLMHit1d Class Reference

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

#include <BKLMHit1d.h>

Inheritance diagram for BKLMHit1d:
Collaboration diagram for BKLMHit1d:

Public Member Functions

 BKLMHit1d ()
 Empty constructor for ROOT IO (needed to make the class storable)
 
 BKLMHit1d (const std::vector< const KLMDigit * > &digits)
 Constructor with initial values. More...
 
 BKLMHit1d (const BKLMHit1d &)
 Copy constructor.
 
BKLMHit1doperator= (const BKLMHit1d &)
 Assignment operator.
 
virtual ~BKLMHit1d ()
 Destructor.
 
bool inRPC () const
 Determine whether this 1D hit is in 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 getStripMin () const
 Get lowest strip number of this 1D hit. More...
 
int getStripMax () const
 Get highest strip number of this 1D hit. More...
 
double getStripAve () const
 Get average strip number. More...
 
int getModuleID () const
 Get detector-module identifier. More...
 
float getTime () const
 Get reconstructed hit time. More...
 
float getEnergyDeposit () const
 Get energy deposition. 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

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

Private Attributes

int m_ModuleID
 detector-module identifier More...
 
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.
 
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 39 of file BKLMHit1d.h.

Constructor & Destructor Documentation

◆ BKLMHit1d()

BKLMHit1d ( const std::vector< const KLMDigit * > &  digits)
explicit

Constructor with initial values.

Parameters
digitsvector of contiguous KLMDigits

Definition at line 36 of file BKLMHit1d.cc.

36  :
38  m_ModuleID(0),
39  m_Time(0.0),
40  m_EnergyDeposit(0.0)
41 {
42  if (digits.size() == 0) {
43  B2WARNING("Attempt to create a BKLMHit1d with no KLMDigits");
44  return;
45  }
46  int stripMin = INT_MAX;
47  int stripMax = INT_MIN;
48  const KLMDigit* bklmDigit = digits.front();
49  if (bklmDigit->getSubdetector() != KLMElementNumbers::c_BKLM)
50  B2FATAL("Trying to construct a BKLMHit1d using KLMDigits from EKLM.");
56  for (std::vector<const KLMDigit*>::const_iterator iDigit = digits.begin(); iDigit != digits.end(); ++iDigit) {
57  const KLMDigit* digit = *iDigit;
58  if (!(bklmDigit->getSection() == digit->getSection() &&
59  bklmDigit->getSector() == digit->getSector() &&
60  bklmDigit->getLayer() == digit->getLayer() &&
61  bklmDigit->getPlane() == digit->getPlane())) {
62  B2WARNING("Attempt to combine non-parallel or distinct-module KLMDigits");
63  continue;
64  }
65  m_Time += digit->getTime();
67  int strip = digit->getStrip();
68  stripMin = std::min(stripMin, strip);
69  stripMax = std::max(stripMax, strip);
70  addRelationTo(digit);
71  }
72 
73  if (stripMax >= stripMin) {
74  m_Time /= ((stripMax - stripMin) + 1.0);
77  }
78 }

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 144 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 157 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 172 of file RelationsObject.h.

◆ getEnergyDeposit()

float getEnergyDeposit ( ) const
inline

Get energy deposition.

Returns
energy deposition (MeV)

Definition at line 142 of file BKLMHit1d.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 372 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();
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 TrackFitResult, TRGSummary, Track, SoftwareTriggerResult, Particle, RecoTrack, MCParticle, Cluster, and PIDLikelihood.

Definition at line 364 of file RelationsObject.h.

◆ getLayer()

int getLayer ( ) const
inline

Get layer number.

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

Definition at line 84 of file BKLMHit1d.h.

◆ getModuleID()

int getModuleID ( ) const
inline

Get detector-module identifier.

Returns
detector-module identifier
See also
BKLMStatus.h

Definition at line 128 of file BKLMHit1d.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, Particle, and MCParticle.

Definition at line 346 of file RelationsObject.h.

◆ getPlane()

int getPlane ( ) const
inline

Get plane number.

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

Definition at line 91 of file BKLMHit1d.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 280 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 265 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 316 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 250 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 299 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 333 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 214 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 199 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 232 of file RelationsObject.h.

◆ getSection()

int getSection ( ) const
inline

Get section number.

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

Definition at line 70 of file BKLMHit1d.h.

◆ getSector()

int getSector ( ) const
inline

Get sector number.

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

Definition at line 77 of file BKLMHit1d.h.

◆ getStripAve()

double getStripAve ( ) const
inline

Get average strip number.

Returns
average strip number of this 1D hit

Definition at line 120 of file BKLMHit1d.h.

◆ getStripMax()

int getStripMax ( ) const
inline

Get highest strip number of this 1D hit.

Returns
highest strip number of this 1D hit

Definition at line 113 of file BKLMHit1d.h.

◆ getStripMin()

int getStripMin ( ) const
inline

Get lowest strip number of this 1D hit.

Returns
lowest strip number of this 1D hit

Definition at line 106 of file BKLMHit1d.h.

◆ getTime()

float getTime ( ) const
inline

Get reconstructed hit time.

Returns
reconstructed hit time (ns)

Definition at line 135 of file BKLMHit1d.h.

◆ 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 63 of file BKLMHit1d.h.

◆ isPhiReadout()

bool isPhiReadout ( ) const
inline

Get readout coordinate.

Returns
readout coordinate of this 1D hit

Definition at line 98 of file BKLMHit1d.h.

Member Data Documentation

◆ m_ModuleID

int m_ModuleID
private

detector-module identifier

See also
BKLMStatus.h

Definition at line 151 of file BKLMHit1d.h.


The documentation for this class was generated from the following files:
Belle2::KLMDigit::getSubdetector
int getSubdetector() const
Get subdetector number.
Definition: KLMDigit.h:89
Belle2::BKLMHit1d::m_EnergyDeposit
float m_EnergyDeposit
reconstructed pulse height (MeV)
Definition: BKLMHit1d.h:157
Belle2::KLMDigit::getPlane
int getPlane() const
Get plane number.
Definition: KLMDigit.h:161
Belle2::BKLMStatus::setMaximalStrip
static void setMaximalStrip(int &module, int strip)
Set maximal strip number.
Definition: BKLMStatus.h:95
Belle2::BKLMHit1d::m_Time
float m_Time
reconstructed hit time (ns)
Definition: BKLMHit1d.h:154
Belle2::BKLMElementNumbers::setSectionInModule
static void setSectionInModule(int &module, int section)
Set section number in module identifier.
Definition: BKLMElementNumbers.h:334
Belle2::BKLMElementNumbers::setLayerInModule
static void setLayerInModule(int &module, int layer)
Set layer number in module identifier.
Definition: BKLMElementNumbers.h:354
Belle2::RelationsInterface::addRelationTo
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).
Definition: RelationsObject.h:144
Belle2::KLMDigit::getSection
int getSection() const
Get section number.
Definition: KLMDigit.h:107
Belle2::KLMDigit::getSector
int getSector() const
Get sector number.
Definition: KLMDigit.h:125
Belle2::KLMDigit::getTime
float getTime() const
Get hit time.
Definition: KLMDigit.h:293
Belle2::KLMDigit::getLayer
int getLayer() const
Get layer number.
Definition: KLMDigit.h:143
Belle2::BKLMElementNumbers::setPlaneInModule
static void setPlaneInModule(int &module, int plane)
Set plane number in module identifier.
Definition: BKLMElementNumbers.h:364
Belle2::BKLMElementNumbers::setSectorInModule
static void setSectorInModule(int &module, int sector)
Set sector number in module identifier.
Definition: BKLMElementNumbers.h:344
Belle2::KLMDigit
KLM digit (class representing a digitized hit in RPCs or scintillators).
Definition: KLMDigit.h:40
Belle2::HTML::getString
std::string getString(const TMatrixFBase &matrix, int precision=2, bool color=true)
get HTML table representing a matrix.
Definition: HTML.cc:18
Belle2::KLMDigit::getEnergyDeposit
float getEnergyDeposit() const
Get energy deposit.
Definition: KLMDigit.h:311
Belle2::KLMElementNumbers::c_BKLM
@ c_BKLM
BKLM.
Definition: KLMElementNumbers.h:47
Belle2::RelationsObject
RelationsInterface< TObject > RelationsObject
Provides interface for getting/adding relations to objects in StoreArrays.
Definition: RelationsObject.h:443
Belle2::BKLMHit1d::m_ModuleID
int m_ModuleID
detector-module identifier
Definition: BKLMHit1d.h:151
Belle2::KLMDigit::getStrip
int getStrip() const
Get strip number.
Definition: KLMDigit.h:179
Belle2::BKLMElementNumbers::setStripInModule
static void setStripInModule(int &module, int strip)
Set strip number in module identifier.
Definition: BKLMElementNumbers.h:374