KLM simulation hit. More...

#include <KLMSimHit.h>

Inheritance diagram for KLMSimHit:

Public Member Functions
	KLMSimHit ()
	Constructor.

	~KLMSimHit ()
	Destructor.

int	getPDG () const
	Get the lund code of the (leading) particle.

void	setPDG (int pdg)
	Set the lund code of the (leading) particle.

int	getTrackID () const
	Get track ID.

void	setTrackID (int track)
	Set track ID.

int	getParentTrackID () const
	Get ID of parent track.

void	setParentTrackID (int track)
	Set ID of parent track.

int	getVolumeID () const
	Get volume identifier.

int	getSubdetector () const
	Get subdetector number.

void	setSubdetector (int subdetector)
	Set subdetector number.

int	getSection () const
	Get section number.

void	setSection (int Section)
	Set section number.

int	getLayer () const
	Get layer number.

void	setLayer (int layer)
	Set layer number.

int	getSector () const
	Get sector number.

void	setSector (int sector)
	Set sector number.

int	getPlane () const
	Get plane number.

bool	isPhiReadout () const
	Check whether the hit is from phi plane.

void	setPlane (int plane)
	Set plane number.

int	getStrip () const
	Get strip number.

void	setStrip (int strip)
	Set strip number.

int	getLastStrip () const
	Get last strip number.

void	setLastStrip (int lastStrip)
	Set last strip number.

bool	inRPC () const
	Determine whether the hit is in RPC or scintillator.

float	getEnergyDeposit () const
	Get energy deposit.

void	setEnergyDeposit (float eDep)
	Set EnergyDeposit.

float	getTime () const
	Get hit time.

void	setTime (float time)
	Set hit time.

float	getPropagationTime () const
	Get signal propagation time.

void	setPropagationTime (float propagationTime)
	Set signal propagation time.

void	setLocalPosition (float x, float y, float z)
	Set hit local position.

float	getLocalPositionX () const
	Get hit local position x coordinate.

float	getLocalPositionY () const
	Get hit local position y coordinate.

float	getLocalPositionZ () const
	Get hit local position z coordinate.

ROOT::Math::XYZVector	getLocalPosition () const
	Get ihit local position.

void	setPosition (float x, float y, float z)
	Set hit global position.

void	setPosition (const ROOT::Math::XYZVector &pos)
	Set hit global position.

float	getPositionX () const
	Get hit global position x coordinate.

float	getPositionY () const
	Get hit global position y coordinate.

float	getPositionZ () const
	Get hit global position z coordinate.

ROOT::Math::XYZVector	getPosition () const
	Get hit global position.

void	setMomentum (const ROOT::Math::PxPyPzEVector &p)
	Set momentum.

ROOT::Math::PxPyPzEVector	getMomentum () const
	Get momentum.

void	setVolumeID (int id)
	Set volume identifier.

float	getGlobalTime () const override
	Get hit time (implementation of base class function)

void	shiftInTime (float delta) override
	Shift SimHit in time (implementation of base class function)

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

virtual unsigned short	getBackgroundTag () const
	Get background tag.

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

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

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

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.

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.

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.

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation.

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation.

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.

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.

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.

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.

virtual std::string	getName () const
	Return a short name that describes this object, e.g.

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format.

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format.

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
	ClassDefOverride (Belle2::KLMSimHit, 1)
	Class version.

	ClassDef (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

Private Attributes
int	m_PDG = -1
	PDG code of the (leading) particle.

int	m_trackID = -1
	Track ID.

int	m_parentTrackID = -1
	Parent track ID.

int	m_volid = -1
	Volume identifier.

int	m_Subdetector = 0
	Number of subdetector.

int	m_Section = 0
	Number of section.

int	m_Layer = 0
	Number of layer.

int	m_Sector = 0
	Number of sector.

int	m_Plane = 0
	Number of plane.

int	m_Strip = 0
	Number of strip.

int	m_LastStrip
	Number of last strip (for BKLM RPC hits).

float	m_Time = -1
	Time of the hit.

float	m_EDep = -1
	Energy deposition.

float	m_PropagationTime = 0
	Time of propagation (ns) from hit to sensor.

float	m_localX = 0
	Local position X coordinate.

float	m_localY = 0
	Local position Y coordinate.

float	m_localZ = 0
	Local position Z coordinate.

float	m_globalX
	Global position X coordinate.

float	m_globalY
	Global position Y coordinate.

float	m_globalZ
	Global position Z coordinate.

float	m_e = 0
	Energy.

float	m_pX = 0
	Momentum X component.

float	m_pY = 0
	Momentum Y component.

float	m_pZ = 0
	Momentum Z component.

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

KLM simulation hit.

Definition at line 31 of file KLMSimHit.h.

Constructor & Destructor Documentation

◆ KLMSimHit()

KLMSimHit ( )

inline

Constructor.

Definition at line 38 of file KLMSimHit.h.

39 {

40 }

◆ ~KLMSimHit()

~KLMSimHit ( )

inline

Destructor.

Definition at line 45 of file KLMSimHit.h.

46 {

47 }

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.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

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

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

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

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

◆ getArrayIndex()

int getArrayIndex ( ) const

inlineinherited

Returns this object's array index (in StoreArray), or -1 if not found.

Definition at line 385 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

◆ getArrayName()

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

◆ getArrayPointer()

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

◆ getBackgroundTag()

virtual unsigned short getBackgroundTag ( ) const

inlinevirtualinherited

Get background tag.

Returns: The background tag value.

Definition at line 46 of file SimHitBase.h.

46{ return m_backgroundTag; }

Belle2::SimHitBase::m_backgroundTag

unsigned short m_backgroundTag

Background tag.

Definition: SimHitBase.h:68

◆ getEnergyDeposit()

float getEnergyDeposit ( ) const

inline

Get energy deposit.

Returns: Energy deposit.

Definition at line 260 of file KLMSimHit.h.

    {
      return m_EDep;
    }

◆ getGlobalTime()

float getGlobalTime ( ) const

inlineoverridevirtual

Get hit time (implementation of base class function)

Returns: hit time

Reimplemented from SimHitBase.

Definition at line 453 of file KLMSimHit.h.

    {
      return getTime();
    }

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

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

◆ 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 Particle, Cluster, MCParticle, PIDLikelihood, SoftwareTriggerResult, Track, TrackFitResult, TRGSummary, and RecoTrack.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getLastStrip()

int getLastStrip ( ) const

inline

Get last strip number.

Returns: Last strip number.

Definition at line 232 of file KLMSimHit.h.

    {
      return m_LastStrip;
    }

◆ getLayer()

int getLayer ( ) const

inline

Get layer number.

Returns: Layer number.

Definition at line 152 of file KLMSimHit.h.

    {
      return m_Layer;
    }

◆ getLocalPosition()

ROOT::Math::XYZVector getLocalPosition ( ) const

inline

Get ihit local position.

Returns: Hit coordinates.

Definition at line 354 of file KLMSimHit.h.

    {
      return ROOT::Math::XYZVector(m_localX, m_localY, m_localZ);
    }

◆ getLocalPositionX()

float getLocalPositionX ( ) const

inline

Get hit local position x coordinate.

Returns: Hit x coordinate.

Definition at line 327 of file KLMSimHit.h.

    {
      return m_localX;
    }

◆ getLocalPositionY()

float getLocalPositionY ( ) const

inline

Get hit local position y coordinate.

Returns: Hit y coordinate.

Definition at line 336 of file KLMSimHit.h.

    {
      return m_localY;
    }

◆ getLocalPositionZ()

float getLocalPositionZ ( ) const

inline

Get hit local position z coordinate.

Returns: Hit z coordinate.

Definition at line 345 of file KLMSimHit.h.

    {
      return m_localZ;
    }

◆ getMomentum()

ROOT::Math::PxPyPzEVector getMomentum ( ) const

inline

Get momentum.

Returns: Momentum.

Definition at line 435 of file KLMSimHit.h.

    {
      return ROOT::Math::PxPyPzEVector(m_pX, m_pY, m_pZ, m_e);
    }

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in Particle, MCParticle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getParentTrackID()

int getParentTrackID ( ) const

inline

Get ID of parent track.

Returns: Track ID.

Definition at line 89 of file KLMSimHit.h.

    {
      return m_parentTrackID;
    }

◆ getPDG()

int getPDG ( ) const

inline

Get the lund code of the (leading) particle.

Returns: Particle code.

Definition at line 53 of file KLMSimHit.h.

    {
      return m_PDG;
    }

◆ getPlane()

int getPlane ( ) const

inline

Get plane number.

Returns: Plane number.

Definition at line 188 of file KLMSimHit.h.

    {
      return m_Plane;
    }

◆ getPosition()

ROOT::Math::XYZVector getPosition ( ) const

inline

Get hit global position.

Returns: Hit coordinates.

Definition at line 414 of file KLMSimHit.h.

    {
      return ROOT::Math::XYZVector(m_globalX, m_globalY, m_globalZ);
    }

◆ getPositionX()

float getPositionX ( ) const

inline

Get hit global position x coordinate.

Returns: Hit x coordinate.

Definition at line 387 of file KLMSimHit.h.

    {
      return m_globalX;
    }

◆ getPositionY()

float getPositionY ( ) const

inline

Get hit global position y coordinate.

Returns: Hit y coordinate.

Definition at line 396 of file KLMSimHit.h.

    {
      return m_globalY;
    }

◆ getPositionZ()

float getPositionZ ( ) const

inline

Get hit global position z coordinate.

Returns: Hit z coordinate.

Definition at line 405 of file KLMSimHit.h.

    {
      return m_globalZ;
    }

◆ getPropagationTime()

float getPropagationTime ( ) const

inline

Get signal propagation time.

Returns: Time of propagation (ns) from strip to sensor.

Definition at line 296 of file KLMSimHit.h.

    {
      return m_PropagationTime;
    }

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

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

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

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

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

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

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

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

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

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

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

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

◆ getSection()

int getSection ( ) const

inline

Get section number.

Returns: Section number.

Definition at line 134 of file KLMSimHit.h.

    {
      return m_Section;
    }

◆ getSector()

int getSector ( ) const

inline

Get sector number.

Returns: Sector number.

Definition at line 170 of file KLMSimHit.h.

    {
      return m_Sector;
    }

◆ getStrip()

int getStrip ( ) const

inline

Get strip number.

Returns: Strip number.

Definition at line 214 of file KLMSimHit.h.

    {
      return m_Strip;
    }

◆ getSubdetector()

int getSubdetector ( ) const

inline

Get subdetector number.

Returns: Subdetector number.

Definition at line 116 of file KLMSimHit.h.

    {
      return m_Subdetector;
    }

◆ getTime()

float getTime ( ) const

inline

Get hit time.

Returns: Hit time.

Definition at line 278 of file KLMSimHit.h.

    {
      return m_Time;
    }

◆ getTrackID()

int getTrackID ( ) const

inline

Get track ID.

Returns: Track ID.

Definition at line 71 of file KLMSimHit.h.

    {
      return m_trackID;
    }

◆ getVolumeID()

int getVolumeID ( ) const

inline

Get volume identifier.

Returns: Identifier.

Definition at line 107 of file KLMSimHit.h.

    {
      return m_volid;
    }

◆ inRPC()

bool inRPC ( ) const

inline

Determine whether the hit is in RPC or scintillator.

Returns: Whether hit is in RPC (true) or scintillator (false).

Definition at line 250 of file KLMSimHit.h.

    {
      return (m_Subdetector == KLMElementNumbers::c_BKLM &&
              m_Layer >= BKLMElementNumbers::c_FirstRPCLayer);
    }

◆ isPhiReadout()

bool isPhiReadout ( ) const

inline

Check whether the hit is from phi plane.

Definition at line 196 of file KLMSimHit.h.

    {
      return (m_Plane == BKLMElementNumbers::c_PhiPlane);
    }

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

40 { m_backgroundTag = static_cast<unsigned short>(backgroundTag); }

◆ setEnergyDeposit()

void setEnergyDeposit ( float eDep )

inline

Set EnergyDeposit.

Parameters

[in] eDep Energy deposit.

Definition at line 269 of file KLMSimHit.h.

    {
      m_EDep = eDep;
    }

◆ setLastStrip()

void setLastStrip ( int lastStrip )

inline

Set last strip number.

Parameters

[in] lastStrip Last strip number.

Definition at line 241 of file KLMSimHit.h.

    {
      m_LastStrip = lastStrip;
    }

◆ setLayer()

void setLayer ( int layer )

inline

Set layer number.

Parameters

[in] layer Layer number.

Definition at line 161 of file KLMSimHit.h.

    {
      m_Layer = layer;
    }

◆ setLocalPosition()

void setLocalPosition	(	float	x,
		float	y,
		float	z
	)

inline

Set hit local position.

Parameters

[in]	x	Hit x coordinate.
[in]	y	Hit y coordinate.
[in]	z	Hit z coordinate.

Definition at line 316 of file KLMSimHit.h.

    {
      m_localX = x;
      m_localY = y;
      m_localZ = z;
    }

◆ setMomentum()

void setMomentum ( const ROOT::Math::PxPyPzEVector & p )

inline

Set momentum.

Parameters

[in] p momentum

Definition at line 423 of file KLMSimHit.h.

    {
      m_e = p.E();
      m_pX = p.Px();
      m_pY = p.Py();
      m_pZ = p.Pz();
    }

◆ setParentTrackID()

void setParentTrackID ( int track )

inline

Set ID of parent track.

Parameters

[in] track track ID.

Definition at line 98 of file KLMSimHit.h.

    {
      m_parentTrackID = track;
    }

◆ setPDG()

void setPDG ( int pdg )

inline

Set the lund code of the (leading) particle.

Parameters

[in] pdg Particle code.

Definition at line 62 of file KLMSimHit.h.

    {
      m_PDG = pdg;
    }

◆ setPlane()

void setPlane ( int plane )

inline

Set plane number.

Parameters

[in] plane Plane number.

Definition at line 205 of file KLMSimHit.h.

    {
      m_Plane = plane;
    }

◆ setPosition() [1/2]

void setPosition ( const ROOT::Math::XYZVector & pos )

inline

Set hit global position.

Parameters

[in] pos Position.

Definition at line 376 of file KLMSimHit.h.

    {
      m_globalX = pos.X();
      m_globalY = pos.Y();
      m_globalZ = pos.Z();
    }

◆ setPosition() [2/2]

void setPosition	(	float	x,
		float	y,
		float	z
	)

inline

Set hit global position.

Parameters

[in]	x	Hit x coordinate.
[in]	y	Hit y coordinate.
[in]	z	Hit z coordinate.

Definition at line 365 of file KLMSimHit.h.

    {
      m_globalX = x;
      m_globalY = y;
      m_globalZ = z;
    }

◆ setPropagationTime()

void setPropagationTime ( float propagationTime )

inline

Set signal propagation time.

Parameters

[in] propagationTime Time of propagation (ns) from strip to sensor.

Definition at line 305 of file KLMSimHit.h.

    {
      m_PropagationTime = propagationTime;
    }

◆ setSection()

void setSection ( int Section )

inline

Set section number.

Parameters

[in] Section Section number.

Definition at line 143 of file KLMSimHit.h.

    {
      m_Section = Section;
    }

◆ setSector()

void setSector ( int sector )

inline

Set sector number.

Parameters

[in] sector Sector number.

Definition at line 179 of file KLMSimHit.h.

    {
      m_Sector = sector;
    }

◆ setStrip()

void setStrip ( int strip )

inline

Set strip number.

Parameters

[in] strip Strip number.

Definition at line 223 of file KLMSimHit.h.

    {
      m_Strip = strip;
    }

◆ setSubdetector()

void setSubdetector ( int subdetector )

inline

Set subdetector number.

Parameters

[in] subdetector Subdetector number.

Definition at line 125 of file KLMSimHit.h.

    {
      m_Subdetector = subdetector;
    }

◆ setTime()

void setTime ( float time )

inline

Set hit time.

Parameters

[in] time hit time.

Definition at line 287 of file KLMSimHit.h.

    {
      m_Time = time;
    }

◆ setTrackID()

void setTrackID ( int track )

inline

Set track ID.

Parameters

[in] track track ID.

Definition at line 80 of file KLMSimHit.h.

    {
      m_trackID = track;
    }

◆ setVolumeID()

void setVolumeID ( int id )

inline

Set volume identifier.

Parameters

[in] id Identifier.

Definition at line 444 of file KLMSimHit.h.

    {
      m_volid = id;
    }

◆ shiftInTime()

void shiftInTime ( float delta )

inlineoverridevirtual

Shift SimHit in time (implementation of base class function)

Parameters

delta time shift.

Reimplemented from SimHitBase.

Definition at line 462 of file KLMSimHit.h.

    {
      setTime(getTime() + delta);
    }

Member Data Documentation

◆ m_backgroundTag

unsigned short m_backgroundTag

privateinherited

Background tag.

Definition at line 68 of file SimHitBase.h.

◆ m_cacheArrayIndex

int m_cacheArrayIndex

mutableprivateinherited

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

Definition at line 432 of file RelationsObject.h.

◆ m_cacheDataStoreEntry

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

◆ m_e

float m_e = 0

private

Energy.

Definition at line 530 of file KLMSimHit.h.

◆ m_EDep

float m_EDep = -1

private

Energy deposition.

Definition at line 506 of file KLMSimHit.h.

◆ m_globalX

float m_globalX

private

Global position X coordinate.

Definition at line 521 of file KLMSimHit.h.

◆ m_globalY

float m_globalY

private

Global position Y coordinate.

Definition at line 524 of file KLMSimHit.h.

◆ m_globalZ

float m_globalZ

private

Global position Z coordinate.

Definition at line 527 of file KLMSimHit.h.

◆ m_LastStrip

int m_LastStrip

private

Number of last strip (for BKLM RPC hits).

Definition at line 500 of file KLMSimHit.h.

◆ m_Layer

int m_Layer = 0

private

Number of layer.

Definition at line 488 of file KLMSimHit.h.

◆ m_localX

float m_localX = 0

private

Local position X coordinate.

Definition at line 512 of file KLMSimHit.h.

◆ m_localY

float m_localY = 0

private

Local position Y coordinate.

Definition at line 515 of file KLMSimHit.h.

◆ m_localZ

float m_localZ = 0

private

Local position Z coordinate.

Definition at line 518 of file KLMSimHit.h.

◆ m_parentTrackID

int m_parentTrackID = -1

private

Parent track ID.

Definition at line 476 of file KLMSimHit.h.

◆ m_PDG

int m_PDG = -1

private

PDG code of the (leading) particle.

Definition at line 470 of file KLMSimHit.h.

◆ m_Plane

int m_Plane = 0

private

Number of plane.

Definition at line 494 of file KLMSimHit.h.

◆ m_PropagationTime

float m_PropagationTime = 0

private

Time of propagation (ns) from hit to sensor.

Definition at line 509 of file KLMSimHit.h.

◆ m_pX

float m_pX = 0

private

Momentum X component.

Definition at line 533 of file KLMSimHit.h.

◆ m_pY

float m_pY = 0

private

Momentum Y component.

Definition at line 536 of file KLMSimHit.h.

◆ m_pZ

float m_pZ = 0

private

Momentum Z component.

Definition at line 539 of file KLMSimHit.h.

◆ m_Section

int m_Section = 0

private

Number of section.

Definition at line 485 of file KLMSimHit.h.

◆ m_Sector

int m_Sector = 0

private

Number of sector.

Definition at line 491 of file KLMSimHit.h.

◆ m_Strip

int m_Strip = 0

private

Number of strip.

Definition at line 497 of file KLMSimHit.h.

◆ m_Subdetector

int m_Subdetector = 0

private

Number of subdetector.

Definition at line 482 of file KLMSimHit.h.

◆ m_Time

float m_Time = -1

private

Time of the hit.

Definition at line 503 of file KLMSimHit.h.

◆ m_trackID

int m_trackID = -1

private

Track ID.

Definition at line 473 of file KLMSimHit.h.

◆ m_volid

int m_volid = -1

private

Volume identifier.

Definition at line 479 of file KLMSimHit.h.

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

klm/dataobjects/include/KLMSimHit.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KLMSimHit()

◆ ~KLMSimHit()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getBackgroundTag()

◆ getEnergyDeposit()

◆ getGlobalTime()

◆ getInfo()

◆ getInfoHTML()

◆ getLastStrip()

◆ getLayer()

◆ getLocalPosition()

◆ getLocalPositionX()

◆ getLocalPositionY()

◆ getLocalPositionZ()

◆ getMomentum()

◆ getName()

◆ getParentTrackID()

◆ getPDG()

◆ getPlane()

◆ getPosition()

◆ getPositionX()

◆ getPositionY()

◆ getPositionZ()

◆ getPropagationTime()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getSection()

◆ getSector()

◆ getStrip()

◆ getSubdetector()

◆ getTime()

◆ getTrackID()

◆ getVolumeID()

◆ inRPC()

◆ isPhiReadout()

◆ setBackgroundTag()

◆ setEnergyDeposit()

◆ setLastStrip()

◆ setLayer()

◆ setLocalPosition()

◆ setMomentum()

◆ setParentTrackID()

◆ setPDG()

◆ setPlane()

◆ setPosition() [1/2]

◆ setPosition() [2/2]

◆ setPropagationTime()

◆ setSection()

◆ setSector()

◆ setStrip()

◆ setSubdetector()

◆ setTime()

◆ setTrackID()

◆ setVolumeID()

◆ shiftInTime()

Member Data Documentation

◆ m_backgroundTag

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_e

◆ m_EDep