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

Store one BKLM strip hit as a ROOT object. More...

#include <BKLMHit2d.h>

Inheritance diagram for BKLMHit2d:
Collaboration diagram for BKLMHit2d:

Public Member Functions

 BKLMHit2d ()
 Empty constructor for ROOT IO (needed to make the class storable)
 
 BKLMHit2d (const BKLMHit1d *hitPhi, const BKLMHit1d *hitZ, const CLHEP::Hep3Vector &globalPos, double time)
 Constructor with initial values. More...
 
 BKLMHit2d (const BKLMHit2d &)
 Copy constructor.
 
BKLMHit2doperator= (const BKLMHit2d &)
 Assignment operator.
 
virtual ~BKLMHit2d ()
 Destructor.
 
bool inRPC () const
 Determine whether this 2D 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 getPhiStripMin () const
 Get lowest phi-measuring strip number. More...
 
int getPhiStripMax () const
 Get highest phi-measuring strip number. More...
 
double getPhiStripAve () const
 Get average phi-measuring strip number. More...
 
int getZStripMin () const
 Get lowest z-measuring strip number. More...
 
int getZStripMax () const
 Get highest z-measuring strip number. More...
 
double getZStripAve () const
 Get average z-measuring strip number. More...
 
int getModuleID () const
 Get detector-module identifier. More...
 
bool isOutOfTime ()
 Determine whether this 2D hit is outside the trigger-coincidence window. More...
 
bool isOnTrack ()
 Determine whether this 2D hit is associated with a muid-extrapolated track. More...
 
bool isOnStaTrack ()
 Determine whether this 2D hit is associated with a BKLM-stand-alone track. More...
 
float getGlobalPositionX (void) const
 Get 3D hit position's x coordinate in global coordinates. More...
 
float getGlobalPositionY (void) const
 Get 3D hit position's y coordinate in global coordinates. More...
 
float getGlobalPositionZ (void) const
 Get 3D hit position's z coordinate in global coordinates. More...
 
TVector3 getGlobalPosition (void) const
 Get 3D hit position in global coordinates. More...
 
float getTime () const
 Get reconstructed hit time. More...
 
float getEnergyDeposit () const
 Get reconstructed energy deposition. More...
 
bool match (const BKLMHit2d *h) const
 Determine whether the two BKLMHit2ds are in the same module. More...
 
void isOutOfTime (bool flag)
 Set or clear the OutOfTime flag. More...
 
void isOnTrack (bool flag)
 Set or clear the OnTrack flag. More...
 
void isOnStaTrack (bool flag)
 Set or clear the On-BKLM-stand-alone-track flag. 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...
 
int m_ZStrips
 z-measuring strip numbers of the 2D hit More...
 
float m_GlobalPosition [3]
 position of the 2D hit in global coordinates (cm)
 
float m_Time
 reconstructed hit time relative to trigger (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.
 

Static Private Attributes

static constexpr int BKLM_ZSTRIP_BIT = 0
 BKLMHit2d Zstrips bit position for strip-1 [0..47].
 
static constexpr int BKLM_ZMAXSTRIP_BIT = 6
 BKLMHit2d Zstrips bit position for maxStrip-1 [0..47].
 
static constexpr int BKLM_ZSTRIP_MASK = (63 << BKLM_ZSTRIP_BIT)
 BKLMHit2d Zstrips bit mask for strip-1 [0..47].
 
static constexpr int BKLM_ZMAXSTRIP_MASK = (63 << BKLM_ZMAXSTRIP_BIT)
 BKLMHit2d Zstrips bit mask for maxStrip-1 [0..47].
 

Detailed Description

Store one BKLM strip hit as a ROOT object.

Definition at line 42 of file BKLMHit2d.h.

Constructor & Destructor Documentation

◆ BKLMHit2d()

BKLMHit2d ( const BKLMHit1d hitPhi,
const BKLMHit1d hitZ,
const CLHEP::Hep3Vector &  globalPos,
double  time 
)

Constructor with initial values.

Parameters
hitPhireconstructed BKLMHit1d along the phi-measuring direction
hitZreconstructed BKLMHit1d along the z-measuring direction

Definition at line 34 of file BKLMHit2d.cc.

34  :
36 {
37  m_ModuleID = hitPhi->getModuleID() | (hitZ->getModuleID() & BKLM_STATUS_MASK);
38  m_ZStrips = ((hitZ->getStripMin() - 1) << BKLM_ZSTRIP_BIT) | ((hitZ->getStripMax() - 1) << BKLM_ZMAXSTRIP_BIT);
39 
41  B2WARNING("Attempt to form a 2D hit from distinct-module 1D hits");
42  }
43 
44  m_GlobalPosition[0] = globalPos.x();
45  m_GlobalPosition[1] = globalPos.y();
46  m_GlobalPosition[2] = globalPos.z();
47  m_Time = time;
49 
50  addRelationTo(hitPhi);
51  addRelationTo(hitZ);
52 }

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 reconstructed energy deposition.

Returns
reconstructed energy deposition (MeV), the sum of the 2 projections

Definition at line 201 of file BKLMHit2d.h.

201  {
202  return BKLMElementNumbers::hitsFromSameModule(m_ModuleID, h->getModuleID());
203  }
204 

◆ getGlobalPosition()

TVector3 getGlobalPosition ( void  ) const
inline

Get 3D hit position in global coordinates.

Returns
3D hit position in global coordinates (cm)

Definition at line 187 of file BKLMHit2d.h.

◆ getGlobalPositionX()

float getGlobalPositionX ( void  ) const
inline

Get 3D hit position's x coordinate in global coordinates.

Returns
3D hit position's x coordinate in global coordinates (cm)

Definition at line 166 of file BKLMHit2d.h.

◆ getGlobalPositionY()

float getGlobalPositionY ( void  ) const
inline

Get 3D hit position's y coordinate in global coordinates.

Returns
3D hit position's y coordinate in global coordinates (cm)

Definition at line 173 of file BKLMHit2d.h.

◆ getGlobalPositionZ()

float getGlobalPositionZ ( void  ) const
inline

Get 3D hit position's z coordinate in global coordinates.

Returns
3D hit position's z coordinate in global coordinates (cm)

Definition at line 180 of file BKLMHit2d.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 2D hit

Definition at line 88 of file BKLMHit2d.h.

◆ getModuleID()

int getModuleID ( ) const
inline

Get detector-module identifier.

Returns
detector-module identifier
See also
BKLMStatus.h

Definition at line 138 of file BKLMHit2d.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.

◆ getPhiStripAve()

double getPhiStripAve ( ) const
inline

Get average phi-measuring strip number.

Returns
average phi-measuring strip number of this 2D hit

Definition at line 109 of file BKLMHit2d.h.

◆ getPhiStripMax()

int getPhiStripMax ( ) const
inline

Get highest phi-measuring strip number.

Returns
highest phi-measuring strip number of this 2D hit

Definition at line 102 of file BKLMHit2d.h.

◆ getPhiStripMin()

int getPhiStripMin ( ) const
inline

Get lowest phi-measuring strip number.

Returns
lowest phi-measuring strip number of this 2D hit

Definition at line 95 of file BKLMHit2d.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 2D hit.

Definition at line 74 of file BKLMHit2d.h.

◆ getSector()

int getSector ( ) const
inline

Get sector number.

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

Definition at line 81 of file BKLMHit2d.h.

◆ getTime()

float getTime ( ) const
inline

Get reconstructed hit time.

Returns
reconstructed hit time (ns), the average of the 2 projections

Definition at line 194 of file BKLMHit2d.h.

◆ getZStripAve()

double getZStripAve ( ) const
inline

Get average z-measuring strip number.

Returns
average z-measuring strip number of this 2D hit

Definition at line 130 of file BKLMHit2d.h.

◆ getZStripMax()

int getZStripMax ( ) const
inline

Get highest z-measuring strip number.

Returns
highest z-measuring strip number of this 2D hit

Definition at line 123 of file BKLMHit2d.h.

◆ getZStripMin()

int getZStripMin ( ) const
inline

Get lowest z-measuring strip number.

Returns
lowest z-measuring strip number of this 2D hit

Definition at line 116 of file BKLMHit2d.h.

◆ inRPC()

bool inRPC ( ) const
inline

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

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

Definition at line 67 of file BKLMHit2d.h.

◆ isOnStaTrack() [1/2]

bool isOnStaTrack ( )
inline

Determine whether this 2D hit is associated with a BKLM-stand-alone track.

Returns
whether this 2D hit is associated with a BKLM-stand-alone track (true) or not (false)

Definition at line 159 of file BKLMHit2d.h.

◆ isOnStaTrack() [2/2]

void isOnStaTrack ( bool  flag)
inline

Set or clear the On-BKLM-stand-alone-track flag.

Parameters
flagwhether this hit is associated with a stand-alone BKLM track (true) or not (false)

Definition at line 229 of file BKLMHit2d.h.

◆ isOnTrack() [1/2]

bool isOnTrack ( )
inline

Determine whether this 2D hit is associated with a muid-extrapolated track.

Returns
whether this 2D hit is associated with a muid-extrapolated track (true) or not (false)

Definition at line 152 of file BKLMHit2d.h.

◆ isOnTrack() [2/2]

void isOnTrack ( bool  flag)
inline

Set or clear the OnTrack flag.

Parameters
flagwhether this hit is associated with a muid-extrapolated track (true) or not (false)

Definition at line 222 of file BKLMHit2d.h.

◆ isOutOfTime() [1/2]

bool isOutOfTime ( )
inline

Determine whether this 2D hit is outside the trigger-coincidence window.

Returns
whether this 2D hit is outside the trigger-coincidence window (true) or not (false)

Definition at line 145 of file BKLMHit2d.h.

◆ isOutOfTime() [2/2]

void isOutOfTime ( bool  flag)
inline

Set or clear the OutOfTime flag.

Parameters
flagwhether this hit is outside the trigger-coincidence window (true) or not (false)

Definition at line 215 of file BKLMHit2d.h.

◆ match()

bool match ( const BKLMHit2d h) const
inline

Determine whether the two BKLMHit2ds are in the same module.

Returns
whether the two BKLMHit2ds are in the same module (true) or not (false)

Definition at line 208 of file BKLMHit2d.h.

Member Data Documentation

◆ m_ModuleID

int m_ModuleID
private

detector-module identifier

See also
BKLMStatus.h

Definition at line 250 of file BKLMHit2d.h.

◆ m_ZStrips

int m_ZStrips
private

z-measuring strip numbers of the 2D hit

See also
BKLMStatus.h

Definition at line 254 of file BKLMHit2d.h.


The documentation for this class was generated from the following files:
Belle2::BKLMHit2d::m_ModuleID
int m_ModuleID
detector-module identifier
Definition: BKLMHit2d.h:250
Belle2::BKLMHit2d::m_Time
float m_Time
reconstructed hit time relative to trigger (ns)
Definition: BKLMHit2d.h:260
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::BKLMHit2d::m_ZStrips
int m_ZStrips
z-measuring strip numbers of the 2D hit
Definition: BKLMHit2d.h:254
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::BKLMElementNumbers::hitsFromSameModule
static bool hitsFromSameModule(int module1, int module2)
Check whether the hits are from the same module.
Definition: BKLMElementNumbers.h:399
Belle2::RelationsObject
RelationsInterface< TObject > RelationsObject
Provides interface for getting/adding relations to objects in StoreArrays.
Definition: RelationsObject.h:443
Belle2::BKLMHit2d::m_GlobalPosition
float m_GlobalPosition[3]
position of the 2D hit in global coordinates (cm)
Definition: BKLMHit2d.h:257
Belle2::BKLMHit2d::m_EnergyDeposit
float m_EnergyDeposit
reconstructed pulse height (MeV)
Definition: BKLMHit2d.h:263
Belle2::BKLMHit1d::getEnergyDeposit
float getEnergyDeposit() const
Get energy deposition.
Definition: BKLMHit1d.h:142
Belle2::BKLMHit2d::BKLM_ZSTRIP_BIT
static constexpr int BKLM_ZSTRIP_BIT
BKLMHit2d Zstrips bit position for strip-1 [0..47].
Definition: BKLMHit2d.h:237
Belle2::BKLMHit1d::getStripMin
int getStripMin() const
Get lowest strip number of this 1D hit.
Definition: BKLMHit1d.h:106
Belle2::BKLMHit1d::getModuleID
int getModuleID() const
Get detector-module identifier.
Definition: BKLMHit1d.h:128
Belle2::BKLMHit2d::BKLM_ZMAXSTRIP_BIT
static constexpr int BKLM_ZMAXSTRIP_BIT
BKLMHit2d Zstrips bit position for maxStrip-1 [0..47].
Definition: BKLMHit2d.h:240
Belle2::BKLMHit1d::getStripMax
int getStripMax() const
Get highest strip number of this 1D hit.
Definition: BKLMHit1d.h:113