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

#include <BKLMHit2d.h>

Inheritance diagram for BKLMHit2d:

Collaboration diagram for BKLMHit2d:

[legend]

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.

BKLMHit2d &	operator= (const BKLMHit2d &)
	Assignment operator.

	~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::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

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 32 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

hitPhi	reconstructed BKLMHit1d along the phi-measuring direction
hitZ	reconstructed BKLMHit1d along the z-measuring direction
globalPos	reconstructed position in global coordinates
time	reconstructed time of the hit

Definition at line 32 of file BKLMHit2d.cc.

                                                                                                                   :
   RelationsObject()
 {
   m_ModuleID = hitPhi->getModuleID() | (hitZ->getModuleID() & BKLM_STATUS_MASK);
   m_ZStrips = ((hitZ->getStripMin() - 1) << BKLM_ZSTRIP_BIT) | ((hitZ->getStripMax() - 1) << BKLM_ZMAXSTRIP_BIT);
  
   if (!BKLMElementNumbers::hitsFromSameModule(m_ModuleID, hitZ->getModuleID())) {
     B2WARNING("Attempt to form a 2D hit from distinct-module 1D hits");
   }
  
   m_GlobalPosition[0] = globalPos.x();
   m_GlobalPosition[1] = globalPos.y();
   m_GlobalPosition[2] = globalPos.z();
   m_Time = time;
   m_EnergyDeposit = hitPhi->getEnergyDeposit() + hitZ->getEnergyDeposit();
  
   addRelationTo(hitPhi);
   addRelationTo(hitZ);
 }

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

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional 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

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional 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.

◆ getEnergyDeposit()

float getEnergyDeposit ( ) const

inline

Get reconstructed energy deposition.

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

Definition at line 193 of file BKLMHit2d.h.

     {
       return m_EnergyDeposit;
     }

◆ getGlobalPosition()

TVector3 getGlobalPosition ( void ) const

inline

Get 3D hit position in global coordinates.

Returns: 3D hit position in global coordinates (cm)

Definition at line 179 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 158 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 165 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 172 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 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();

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 (1..15) of this 2D hit

Definition at line 80 of file BKLMHit2d.h.

◆ getModuleID()

int getModuleID ( ) const

inline

Get detector-module identifier.

Returns: detector-module identifier

See also: BKLMStatus.h

Definition at line 130 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, MCParticle, and Particle.

Definition at line 344 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 101 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 94 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 87 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

T	The class of objects to or from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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

FROM	The class of objects from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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

FROM	The class of objects from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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

TO	The class of objects to which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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

TO	The class of objects to which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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

T	The class of objects to or from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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

FROM	The class of objects from which the relations point.

Parameters

name	The 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.
namedRelation	Additional 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

TO	The class of objects to which the relations point.

Parameters

name	The 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.
namedRelation	Additional 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

T	The class of objects to or from which the relations point.

Parameters

name	The 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.
namedRelation	Additional 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 2D hit.

Definition at line 66 of file BKLMHit2d.h.

◆ getSector()

int getSector ( ) const

inline

Get sector number.

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

Definition at line 73 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 186 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 122 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 115 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 108 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 59 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 151 of file BKLMHit2d.h.

◆ isOnStaTrack() [2/2]

void isOnStaTrack ( bool flag )

inline

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

Parameters

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

Definition at line 227 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 144 of file BKLMHit2d.h.

◆ isOnTrack() [2/2]

void isOnTrack ( bool flag )

inline

Set or clear the OnTrack flag.

Parameters

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

Definition at line 217 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 137 of file BKLMHit2d.h.

◆ isOutOfTime() [2/2]

void isOutOfTime ( bool flag )

inline

Set or clear the OutOfTime flag.

Parameters

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

Definition at line 207 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 200 of file BKLMHit2d.h.

Member Data Documentation

◆ m_ModuleID

int m_ModuleID

private

detector-module identifier

See also: BKLMStatus.h

Definition at line 251 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 255 of file BKLMHit2d.h.

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

klm/dataobjects/bklm/include/BKLMHit2d.h
klm/dataobjects/bklm/src/BKLMHit2d.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BKLMHit2d()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getEnergyDeposit()

◆ getGlobalPosition()

◆ getGlobalPositionX()

◆ getGlobalPositionY()

◆ getGlobalPositionZ()

◆ getInfo()

◆ getInfoHTML()

◆ getLayer()

◆ getModuleID()

◆ getName()

◆ getPhiStripAve()

◆ getPhiStripMax()

◆ getPhiStripMin()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getSection()

◆ getSector()

◆ getTime()

◆ getZStripAve()

◆ getZStripMax()

◆ getZStripMin()

◆ inRPC()

◆ isOnStaTrack() [1/2]

◆ isOnStaTrack() [2/2]

◆ isOnTrack() [1/2]

◆ isOnTrack() [2/2]

◆ isOutOfTime() [1/2]

◆ isOutOfTime() [2/2]

◆ match()

Member Data Documentation

◆ m_ModuleID

◆ m_ZStrips