Store one muon-identification hit in the KLM as a ROOT object. More...

#include <KLMMuidHit.h>

Inheritance diagram for KLMMuidHit:

Collaboration diagram for KLMMuidHit:

[legend]

Public Member Functions
	KLMMuidHit ()
	Empty constructor for ROOT IO (needed to make the class storable)

	KLMMuidHit (int pdgCode, bool inBarrel, bool isForward, int sector, int layer, const TVector3 &extPos, const TVector3 &hitPos, double extTime, double hitTime, double chiSq)
	Constructor with initial values. More...

	~KLMMuidHit ()
	Destructor.

int	getPdgCode () const

TVector3	getExtPosition () const

TVector3	getHitPosition () const

double	getExtTime () const

double	getHitTime () const

bool	inBarrel () const

bool	isForward () const

int	getSector () const

int	getLayer () const

double	getChiSquared () const

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_PdgCode
	PDG particleID code for the hypothesis used in this extrapolation.

TVector3	m_ExtPosition
	global-coordinate position of the extrapolated point (cm)

double	m_ExtTime
	time of the extrapolated point (ns)

TVector3	m_HitPosition
	global-coordinate position of the matching KLM hit (cm)

double	m_HitTime
	time of the matching KLM hit (ns)

bool	m_InBarrel
	flag to indicate if hit is in barrel (true) or endcap (false)

bool	m_IsForward
	flag to indicate if hit is in forward (true) or backward (false) half

int	m_Sector
	sector number (1..8 for barrel, 1..4 for endcap)

int	m_Layer
	layer number (1..15 for barrel, 1..14 for endcap)

double	m_ChiSquared
	chi-squared contribution of this hit for extrapolation point and KLM hit

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 muon-identification hit in the KLM as a ROOT object.

Definition at line 24 of file KLMMuidHit.h.

Constructor & Destructor Documentation

◆ KLMMuidHit()

KLMMuidHit	(	int	pdgCode,
		bool	inBarrel,
		bool	isForward,
		int	sector,
		int	layer,
		const TVector3 &	extPos,
		const TVector3 &	hitPos,
		double	extTime,
		double	hitTime,
		double	chiSq
	)

Constructor with initial values.

Parameters

pdgCode	PDG particleID hypothesis used in this extrapolation
inBarrel	flag to indicate if this hit is in the KLM barrel (true) or endcap (false)
isForward	flag to indicate if this hit is in the forward (true) or backward (false) end
sector	Sector number of this hit (1..8 for barrel, 1..4 for endcap)
layer	Layer number of this hit (1..15 for barrel, 1..14 for endcap)
extPos	Extrapolation position of this hit (cm)
hitPos	Matching reconstructed position of this hit (cm)
extTime	extrapolation time of this hit (ns)
hitTime	Measured time of this hit (ns)
chiSq	Chi-squared contribution of this hit

Definition at line 28 of file KLMMuidHit.cc.

                                                                                                        :
   m_PdgCode(pdgCode),
   m_ExtTime(extTime),
   m_HitTime(hitTime),
   m_InBarrel(inBarrel),
   m_IsForward(isForward),
   m_Sector(sector),
   m_Layer(layer),
   m_ChiSquared(chiSquared)
 {
   m_ExtPosition[0] = extPosition.X();
   m_ExtPosition[1] = extPosition.Y();
   m_ExtPosition[2] = extPosition.Z();
   m_HitPosition[0] = hitPosition.X();
   m_HitPosition[1] = hitPosition.Y();
   m_HitPosition[2] = hitPosition.Z();
 }

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.

◆ getChiSquared()

double getChiSquared ( ) const

inline

Returns: chi-squared contribution of this hit for extrapolation point and KLM hit

Definition at line 105 of file KLMMuidHit.h.

     {
       return m_ChiSquared;
     }

◆ getExtPosition()

TVector3 getExtPosition ( ) const

inline

Returns: global-coordinate position of the extrapolated point (cm)

Definition at line 57 of file KLMMuidHit.h.

◆ getExtTime()

double getExtTime ( ) const

inline

Returns: time since start of event of the extrapolated point (ns)

Definition at line 69 of file KLMMuidHit.h.

◆ getHitPosition()

TVector3 getHitPosition ( ) const

inline

Returns: global-coordinate position of the matching KLM hit (cm)

Definition at line 63 of file KLMMuidHit.h.

◆ getHitTime()

double getHitTime ( ) const

inline

Returns: time of the matching KLM hit (ns)

Definition at line 75 of file KLMMuidHit.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

Returns: layer number (1..15 for barrel, 1..14 for endcap)

Definition at line 99 of file KLMMuidHit.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.

◆ getPdgCode()

int getPdgCode ( ) const

inline

Returns: PDG particleID hypothesis used in this extrapolation

Definition at line 51 of file KLMMuidHit.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.

◆ getSector()

int getSector ( ) const

inline

Returns: sector number (1..8 for barrel, 1..4 for endcap)

Definition at line 93 of file KLMMuidHit.h.

◆ inBarrel()

bool inBarrel ( ) const

inline

Returns: flag to indicate if hit is in barrel (true) or endcap (false)

Definition at line 81 of file KLMMuidHit.h.

◆ isForward()

bool isForward ( ) const

inline

Returns: flag to indicate if hit is in forward (true) or backward (false) half

Definition at line 87 of file KLMMuidHit.h.

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

klm/dataobjects/include/KLMMuidHit.h
klm/dataobjects/src/KLMMuidHit.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KLMMuidHit()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getChiSquared()

◆ getExtPosition()

◆ getExtTime()

◆ getHitPosition()

◆ getHitTime()

◆ getInfo()

◆ getInfoHTML()

◆ getLayer()

◆ getName()

◆ getPdgCode()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getSector()

◆ inBarrel()

◆ isForward()