Store one Ext hit as a ROOT object. More...

#include <ExtHit.h>

Inheritance diagram for ExtHit:

Collaboration diagram for ExtHit:

[legend]

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

	ExtHit (int pdgCode, Const::EDetector detector, int element, ExtHitStatus status, bool backwardPropagation, double t, const ROOT::Math::XYZPoint &r, const ROOT::Math::XYZVector &p, const TMatrixDSym &e)
	Constructor with initial values. More...

	ExtHit (int pdgCode, Const::EDetector detector, int element, ExtHitStatus status, bool backwardPropagation, double t, const G4ThreeVector &r, const G4ThreeVector &p, const G4ErrorSymMatrix &e)
	Constructor with initial values. More...

	ExtHit (const ExtHit &)
	Copy constructor.

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

virtual	~ExtHit ()
	Destructor.

void	setPDGCode (int pdgCode)
	Set PDG code of this extrapolation's hypothesis.

void	setDetectorID (Const::EDetector detectorID)
	Set detector ID of this extrapolation hit.

void	setCopyID (int copyID)
	Set detector-element ID of sensitive element within detector.

void	setBackwardPropagation (bool backwardPropagation)
	Set the direction of track propagation.

void	setStatus (ExtHitStatus extHitStatus)
	Set state of extrapolation at this hit.

void	setTOF (double tof)
	Set time of flight from the point of closest approach near the origin to this hit.

void	setPosition (const ROOT::Math::XYZVector &position)
	Set position of this extrapolation hit.

void	setMomentum (const ROOT::Math::XYZVector &momentum)
	Set momentum at this extrapolation hit.

void	setCovariance (double covArray[21])
	Set phase-space covariance at this extrapolation hit.

int	getPdgCode () const
	Get PDG code of this extrapolation's hypothesis. More...

Const::EDetector	getDetectorID () const
	Get detector ID of this extrapolation hit. More...

int	getCopyID () const
	Get detector-element ID of sensitive element within detector. More...

ExtHitStatus	getStatus () const
	Get state of extrapolation at this hit. More...

bool	isBackwardPropagated () const
	Get the direction of track propagation.

double	getTOF () const
	Get time of flight from the point of closest approach near the origin to this hit. More...

double	getLength () const
	Get path length from start of extrapolation to closest approach to ECL cluster (for EXT_ECLDL only) More...

ROOT::Math::XYZVector	getPosition () const
	Get position of this extrapolation hit. More...

TVector3	getPositionTVector3 () const
	Get position of this extrapolation hit. More...

ROOT::Math::XYZVector	getMomentum () const
	Get momentum at this extrapolation hit. More...

TVector3	getMomentumTVector3 () const
	Get momentum at this extrapolation hit. More...

TMatrixDSym	getCovariance () const
	Get phase-space covariance at this extrapolation hit. More...

void	update (ExtHitStatus status, double t, const G4ThreeVector &r, const G4ThreeVector &p, const G4ErrorSymMatrix &e)
	Update the parameters of this extrapolation hit. More...

double	getErrorTheta () const
	Get the uncertainty in the azimuthal angle phi (radians)

double	getErrorPhi () const
	Get the uncertainty in the azimuthal angle phi (radians)

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
double	getPolarCovariance (int i) const
	Get diagonal elemment of the 3x3 position-covariance matrix in polar coordinates (r, theta, phi)

	ClassDef (ExtHit, 8)
	Needed to make the ROOT object storable.

Private Attributes
int	m_PdgCode
	PDG code.

Const::EDetector	m_DetectorID
	detector ID

int	m_CopyID
	copy ID

ExtHitStatus	m_Status
	extrapolation state

bool	m_BackwardPropagation
	Direction of track propagation.

float	m_TOF
	time of flight (ns)

float	m_Position [3]
	position (cm)

float	m_Momentum [3]
	momentum (GeV/c)

float	m_Covariance [21]
	phase-space covariance (symmetric 6x6 linearized to 6*(6+1)/2: position & momentum in cm & GeV/c)

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 Ext hit as a ROOT object.

Definition at line 32 of file ExtHit.h.

Constructor & Destructor Documentation

◆ ExtHit() [1/2]

ExtHit	(	int	pdgCode,
		Const::EDetector	detector,
		int	element,
		ExtHitStatus	status,
		bool	backwardPropagation,
		double	t,
		const ROOT::Math::XYZPoint &	r,
		const ROOT::Math::XYZVector &	p,
		const TMatrixDSym &	e
	)

Constructor with initial values.

Parameters

pdgCode	PDG hypothesis used for this extrapolation
detector	Detector containing this hit
element	Detector element containing this hit
status	State of extrapolation at this hit
backwardPropagation	Direction of the track propagation.
t	Time of flight from start of event to this hit (ns)
r	Global position of this hit (cm)
p	Momentum of extrapolated track at this hit (GeV/c)
e	Covariance matrix of extrapolation at this hit (GeV/c and cm)

Definition at line 40 of file ExtHit.cc.

                                                                                                                    :
   RelationsObject(),
   m_PdgCode(pdgCode),
   m_DetectorID(detectorID),
   m_CopyID(copyID),
   m_Status(status),
   m_BackwardPropagation(backwardPropagation),
   m_TOF(tof)
 {
   m_Position[0] = position.X();
   m_Position[1] = position.Y();
   m_Position[2] = position.Z();
   m_Momentum[0] = momentum.X();
   m_Momentum[1] = momentum.Y();
   m_Momentum[2] = momentum.Z();
   int k = 0;
   for (int i = 0; i < 6; ++i) {
     for (int j = 0; j <= i; ++j) {
       m_Covariance[k++] = covariance[i][j];
     }
   }
 }

◆ ExtHit() [2/2]

ExtHit	(	int	pdgCode,
		Const::EDetector	detector,
		int	element,
		ExtHitStatus	status,
		bool	backwardPropagation,
		double	t,
		const G4ThreeVector &	r,
		const G4ThreeVector &	p,
		const G4ErrorSymMatrix &	e
	)

Constructor with initial values.

Parameters

pdgCode	PDG hypothesis used for this extrapolation
detector	Detector containing this hit
element	Detector element containing this hit
status	State of extrapolation at this hit
backwardPropagation	Direction of the track propagation.
t	Time of flight from IP to this hit (ns)
r	Global position of this hit (cm)
p	Momentum of extrapolated track at this hit (GeV/c)
e	Covariance matrix of extrapolation at this hit (GeV/c and cm)

Definition at line 65 of file ExtHit.cc.

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.

◆ getCopyID()

int getCopyID ( ) const

inline

Get detector-element ID of sensitive element within detector.

Returns: detector-element ID of sensitive element within detector

Definition at line 126 of file ExtHit.h.

126 { return m_CopyID; }

◆ getCovariance()

TMatrixDSym getCovariance ( ) const

Get phase-space covariance at this extrapolation hit.

Returns: phase-space covariance (symmetric 6x6: position & momentum in cm & GeV/c) at this extrapolation hit

Definition at line 130 of file ExtHit.cc.

◆ getDetectorID()

Const::EDetector getDetectorID ( ) const

inline

Get detector ID of this extrapolation hit.

Returns: detector ID of this extrapolation hit

Definition at line 122 of file ExtHit.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.

◆ getLength()

double getLength ( ) const

inline

Get path length from start of extrapolation to closest approach to ECL cluster (for EXT_ECLDL only)

Returns: path length (in radiation lengths)

Definition at line 141 of file ExtHit.h.

◆ getMomentum()

ROOT::Math::XYZVector getMomentum ( ) const

inline

Get momentum at this extrapolation hit.

Returns: momentum (GeV/c) at this extrapolation hit

Definition at line 159 of file ExtHit.h.

◆ getMomentumTVector3()

TVector3 getMomentumTVector3 ( ) const

inline

Get momentum at this extrapolation hit.

Returns: momentum (GeV/c) at this extrapolation hit

Definition at line 166 of file ExtHit.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

Get PDG code of this extrapolation's hypothesis.

Returns: PDG code of this extrapolation's hypothesis

Definition at line 118 of file ExtHit.h.

◆ getPosition()

ROOT::Math::XYZVector getPosition ( ) const

inline

Get position of this extrapolation hit.

Returns: position (cm) of this extrapolation hit

Definition at line 145 of file ExtHit.h.

◆ getPositionTVector3()

TVector3 getPositionTVector3 ( ) const

inline

Get position of this extrapolation hit.

Returns: position (cm) of this extrapolation hit

Definition at line 152 of file ExtHit.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.

◆ getStatus()

ExtHitStatus getStatus ( void ) const

inline

Get state of extrapolation at this hit.

Returns: state of extrapolation at this hit

Definition at line 130 of file ExtHit.h.

◆ getTOF()

double getTOF ( ) const

inline

Get time of flight from the point of closest approach near the origin to this hit.

Returns: time of flight from the point of closest approach near the origin to this hit (ns)

Definition at line 137 of file ExtHit.h.

◆ update()

void update	(	ExtHitStatus	status,
		double	t,
		const G4ThreeVector &	r,
		const G4ThreeVector &	p,
		const G4ErrorSymMatrix &	e
	)

Update the parameters of this extrapolation hit.

Parameters

status	State of extrapolation at this hit
t	Time of flight from IP to this hit (ns)
r	Global position of this hit (cm)
p	Momentum of extrapolated track at this hit (GeV/c)
e	Covariance matrix of extrapolation at this hit (GeV/c and cm)

Definition at line 143 of file ExtHit.cc.

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

tracking/dataobjects/include/ExtHit.h
tracking/dataobjects/src/ExtHit.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExtHit() [1/2]

◆ ExtHit() [2/2]

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getCopyID()

◆ getCovariance()

◆ getDetectorID()

◆ getInfo()

◆ getInfoHTML()

◆ getLength()

◆ getMomentum()

◆ getMomentumTVector3()

◆ getName()

◆ getPdgCode()

◆ getPosition()

◆ getPositionTVector3()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getStatus()

◆ getTOF()

◆ update()