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

#include <BKLMHit1d.h>

Inheritance diagram for BKLMHit1d:

Collaboration diagram for BKLMHit1d:

[legend]

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.

BKLMHit1d &	operator= (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::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.

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

digits vector of contiguous KLMDigits

Definition at line 36 of file BKLMHit1d.cc.

                                                              :
   RelationsObject(),
   m_ModuleID(0),
   m_Time(0.0),
   m_EnergyDeposit(0.0)
 {
   if (digits.size() == 0) {
     B2WARNING("Attempt to create a BKLMHit1d with no KLMDigits");
     return;
   }
   int stripMin = INT_MAX;
   int stripMax = INT_MIN;
   const KLMDigit* bklmDigit = digits.front();
   if (bklmDigit->getSubdetector() != KLMElementNumbers::c_BKLM)
     B2FATAL("Trying to construct a BKLMHit1d using KLMDigits from EKLM.");
   BKLMElementNumbers::setSectionInModule(m_ModuleID, bklmDigit->getSection());
   BKLMElementNumbers::setSectorInModule(m_ModuleID, bklmDigit->getSector());
   BKLMElementNumbers::setLayerInModule(m_ModuleID, bklmDigit->getLayer());
   BKLMElementNumbers::setPlaneInModule(m_ModuleID, bklmDigit->getPlane());
   BKLMElementNumbers::setStripInModule(m_ModuleID, bklmDigit->getStrip());
   for (std::vector<const KLMDigit*>::const_iterator iDigit = digits.begin(); iDigit != digits.end(); ++iDigit) {
     const KLMDigit* digit = *iDigit;
     if (!(bklmDigit->getSection() == digit->getSection() &&
           bklmDigit->getSector() == digit->getSector() &&
           bklmDigit->getLayer() == digit->getLayer() &&
           bklmDigit->getPlane() == digit->getPlane())) {
       B2WARNING("Attempt to combine non-parallel or distinct-module KLMDigits");
       continue;
     }
     m_Time += digit->getTime();
     m_EnergyDeposit += digit->getEnergyDeposit();
     int strip = digit->getStrip();
     stripMin = std::min(stripMin, strip);
     stripMax = std::max(stripMax, strip);
     addRelationTo(digit);
   }
  
   if (stripMax >= stripMin) {
     m_Time /= ((stripMax - stripMin) + 1.0);
     BKLMElementNumbers::setStripInModule(m_ModuleID, stripMin);
     BKLMStatus::setMaximalStrip(m_ModuleID, stripMax);
   }
 }

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BKLMHit1d()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getEnergyDeposit()

◆ getInfo()

◆ getInfoHTML()

◆ getLayer()

◆ getModuleID()

◆ getName()

◆ getPlane()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getSection()

◆ getSector()

◆ getStripAve()

◆ getStripMax()

◆ getStripMin()

◆ getTime()

◆ inRPC()

◆ isPhiReadout()

Member Data Documentation

◆ m_ModuleID