ClassTPCSimHit - Geant4 simulated hit for the TPC crystal in beast. More...

#include <TPCSimHit.h>

Inheritance diagram for TPCSimHit:

[legend]

Collaboration diagram for TPCSimHit:

[legend]

Public Member Functions
	TPCSimHit ()
	default constructor for ROOT

	TPCSimHit (int CellId, int TrackId, int Pdg, float FlightTime, float Edep, TVector3 Momentum, TVector3 Position, int flag)
	Useful Constructor. More...

void	setCellId (int CellId)
	Set Cell ID.

void	setTrackId (int TrackId)
	Set Track ID.

void	setPDGCode (int Pdg)
	Set Particle PDG (can be one of secondaries)

void	setFlightTime (double FlightTime)
	Set Flight time from IP.

void	setEnergyDep (double Edep)
	Set Deposit energy.

void	setMomentum (TVector3 Momentum)
	Set Momentum.

void	setPosIn (TVector3 Position)
	Set Position.

void	setPosition (TVector3 Position)
	Set Position.

void	setFlag (int flag)
	Set flag.

int	getCellId () const
	Get Cell ID. More...

int	getTrackId () const
	Get Track ID. More...

int	getPDGCode () const
	Get Particle PDG (can be one of secondaries) More...

double	getFlightTime () const
	Get Flight time from IP. More...

double	getEnergyDep () const
	Get Deposit energy. More...

TVector3	getMomentum () const
	Get Momentum. More...

TVector3	getPosIn () const
	Get Position. More...

TVector3	getPosition () const
	Get Position. More...

int	getFlag () const
	Get flag. More...

void	shiftInTime (float delta)
	Shift the SimHit in time (needed for beam background mixing) More...

virtual void	setBackgroundTag (unsigned int backgroundTag)
	Set background tag. More...

virtual unsigned short	getBackgroundTag () const
	Get background tag. More...

virtual float	getGlobalTime () const
	Get time of the hit. 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_CellId
	Cell ID.

int	m_TrackId
	Track ID.

int	m_Pdg
	Particle PDG (can be one of secondaries)

float	m_FlightTime
	Flight time from IP.

float	m_Edep
	Deposit energy.

TVector3	m_Momentum
	Momentum.

TVector3	m_Position
	Position.

int	m_flag
	flag

unsigned short	m_backgroundTag
	Background tag.

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

ClassTPCSimHit - Geant4 simulated hit for the TPC crystal in beast.

This class holds particle hit data from geant4 simulation. As the simulated hit classes are used to generate detector response information. relation to MCParticle filled in beast/TPC/simulation/src/SensitiveDetector.cc

Definition at line 31 of file TPCSimHit.h.

Constructor & Destructor Documentation

◆ TPCSimHit()

TPCSimHit	(	int	CellId,
		int	TrackId,
		int	Pdg,
		float	FlightTime,
		float	Edep,
		TVector3	Momentum,
		TVector3	Position,
		int	flag
	)

inline

Useful Constructor.

Parameters

CellId	Cell ID
TrackId	Track ID
Pdg	Particle PDG (can be one of secondaries)
FlightTime	Flight time from IP
Edep	Deposit energy
Momentum	Momentum
Position	Position
flag	flag

Definition at line 37 of file TPCSimHit.h.

      : SimHitBase()
     {
       m_CellId = CellId;
       m_TrackId = TrackId;
       m_Pdg = Pdg;
       m_FlightTime = FlightTime;
       m_Edep = Edep;
       m_Momentum = Momentum;
       m_Position = Position;
       m_flag = flag;
  
     }

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.

◆ getBackgroundTag()

virtual unsigned short getBackgroundTag ( ) const

inlinevirtualinherited

Get background tag.

Returns: The background tag value.

Definition at line 46 of file SimHitBase.h.

◆ getCellId()

int getCellId ( ) const

inline

Get Cell ID.

Returns: Cell ID

Definition at line 102 of file TPCSimHit.h.

◆ getEnergyDep()

double getEnergyDep ( ) const

inline

Get Deposit energy.

Returns: Deposit energy

Definition at line 122 of file TPCSimHit.h.

◆ getFlag()

int getFlag ( ) const

inline

Get flag.

Returns: flag

Definition at line 142 of file TPCSimHit.h.

◆ getFlightTime()

double getFlightTime ( ) const

inline

Get Flight time from IP.

Returns: Flight time from IP

Definition at line 117 of file TPCSimHit.h.

◆ getGlobalTime()

virtual float getGlobalTime ( ) const

inlinevirtualinherited

Get time of the hit.

Re-implement for your subdetector's SimHit class.

Returns: global time

Reimplemented in VXDSimHit, TOPSimHit, KLMSimHit, ECLHit, CDCSimHit, and ARICHSimHit.

Definition at line 61 of file SimHitBase.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.

◆ getMomentum()

TVector3 getMomentum ( ) const

inline

Get Momentum.

Returns: Momentum

Definition at line 127 of file TPCSimHit.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 ( void ) const

inline

Get Particle PDG (can be one of secondaries)

Returns: Particle PDG (can be one of secondaries)

Definition at line 112 of file TPCSimHit.h.

◆ getPosIn()

TVector3 getPosIn ( ) const

inline

Get Position.

Returns: Position

Definition at line 132 of file TPCSimHit.h.

◆ getPosition()

TVector3 getPosition ( ) const

inline

Get Position.

Returns: Position

Definition at line 137 of file TPCSimHit.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.

◆ getTrackId()

int getTrackId ( ) const

inline

Get Track ID.

Returns: Track ID

Definition at line 107 of file TPCSimHit.h.

◆ setBackgroundTag()

virtual void setBackgroundTag ( unsigned int backgroundTag )

inlinevirtualinherited

Set background tag.

Parameters

backgroundTag The desired setting of the background tag.

Definition at line 39 of file SimHitBase.h.

◆ shiftInTime()

void shiftInTime ( float delta )

inlinevirtual

Shift the SimHit in time (needed for beam background mixing)

Parameters

delta The value of the time shift.

Reimplemented from SimHitBase.

Definition at line 148 of file TPCSimHit.h.

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

beast/microtpc/dataobjects/include/TPCSimHit.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TPCSimHit()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getBackgroundTag()

◆ getCellId()

◆ getEnergyDep()

◆ getFlag()

◆ getFlightTime()

◆ getGlobalTime()

◆ getInfo()

◆ getInfoHTML()

◆ getMomentum()

◆ getName()

◆ getPDGCode()

◆ getPosIn()

◆ getPosition()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getTrackId()

◆ setBackgroundTag()

◆ shiftInTime()