Class for saving raw hit data of the IR. More...

#include <IRSimHit.h>

Inheritance diagram for IRSimHit:

Public Member Functions
	IRSimHit ()
	Empty constructor for ROOT IO.

	IRSimHit (ROOT::Math::XYZVector posIn, ROOT::Math::XYZVector momIn, ROOT::Math::XYZVector posOut, ROOT::Math::XYZVector momOut, int PDGcode, float depEnergy, const std::string &Volname)
	Full Constructor.

void	setposIn (ROOT::Math::XYZVector posIn)
	The method to set.

void	setmomIn (ROOT::Math::XYZVector momIn)
	Set position at start point.

void	setposOut (ROOT::Math::XYZVector posOut)
	Set momentum at start point.

void	setmomOut (ROOT::Math::XYZVector momOut)
	Set position at end point.

void	setPDGcode (int PDGcode)
	Set momentum at end point.

void	setdepEnergy (float depEnergy)
	Set PDF code.

void	setVolname (const std::string &Volname)
	Set deposited energy.

ROOT::Math::XYZVector	getposIn ()
	Set volume name.

ROOT::Math::XYZVector	getmomIn ()
	return position at start point

ROOT::Math::XYZVector	getposOut ()
	return momentum at start point

ROOT::Math::XYZVector	getmomOut ()
	return position at end point

int	getPDGcode ()
	return momentum at end point

float	getdepEnergy ()
	return PDG code

std::string	getVolname ()
	return deposited energy

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

virtual unsigned short	getBackgroundTag () const
	Get background tag.

virtual void	shiftInTime (float)
	The method to shift the SimHit in time.

virtual float	getGlobalTime () const
	Get time of the hit.

void	addRelationTo (const RelationsInterface< TObject > *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	addRelationTo (const RelationsInterface< TObject > *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< TObject > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

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

RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.

RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.

RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.

RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.

RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.

RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.

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

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

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

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

T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.

T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.

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.

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.

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.

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.

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.

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

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

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.

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

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 (IRSimHit, 2)
	ROOT Macro.

Private Attributes
ROOT::Math::XYZVector	m_posIn
	return volume name

ROOT::Math::XYZVector	m_momIn
	Momentum of particle at start of energy deposition.

ROOT::Math::XYZVector	m_posOut
	End point of energy deposition in local coordinates.

ROOT::Math::XYZVector	m_momOut
	Momentum of particle at end of energy deposition.

int	m_PDGcode
	PDG code of the particle producing hit.

float	m_depEnergy
	Deposited energy.

std::string	m_Volname
	Volume name.

unsigned short	m_backgroundTag
	Background tag.

DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

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.

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

Detailed Description

Class for saving raw hit data of the IR.

Definition at line 22 of file IRSimHit.h.

Constructor & Destructor Documentation

◆ IRSimHit() [1/2]

IRSimHit ( )

inline

Empty constructor for ROOT IO.

Definition at line 26 of file IRSimHit.h.

              :
      m_posIn(0, 0, 0),
      m_momIn(0, 0, 0),
      m_posOut(0, 0, 0),
      m_momOut(0, 0, 0),
      m_PDGcode(0),
      m_depEnergy(0),
      m_Volname("noname") {}

◆ IRSimHit() [2/2]

IRSimHit	(	ROOT::Math::XYZVector	posIn,
		ROOT::Math::XYZVector	momIn,
		ROOT::Math::XYZVector	posOut,
		ROOT::Math::XYZVector	momOut,
		int	PDGcode,
		float	depEnergy,
		const std::string &	Volname )

inline

Full Constructor.

Definition at line 36 of file IRSimHit.h.

      :
      m_posIn(posIn),
      m_momIn(momIn),
      m_posOut(posOut),
      m_momOut(momOut),
      m_PDGcode(PDGcode),
      m_depEnergy(depEnergy),
      m_Volname(Volname) {}

◆ ~IRSimHit()

~IRSimHit ( )

Definition at line 14 of file IRSimHit.cc.

15{

16}

Member Function Documentation

◆ addRelationTo() [1/4]

void addRelationTo	(	const RelationsInterface< TObject > *	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/4]

void addRelationTo	(	const RelationsInterface< TObject > *	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() [3/4]

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);
    }

◆ addRelationTo() [4/4]

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() [1/2]

void copyRelations ( const RelationsInterface< TObject > * 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));
      }
    }

◆ copyRelations() [2/2]

void copyRelations ( const RelationsInterface< TObject > * 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() [1/2]

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

◆ getArrayIndex() [2/2]

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() [1/2]

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 : "";
    }

◆ getArrayName() [2/2]

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() [1/2]

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();
    }

◆ getArrayPointer() [2/2]

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

◆ getdepEnergy()

float getdepEnergy ( )

return PDG code

Definition at line 54 of file IRSimHit.cc.

54{ return m_depEnergy; }

Belle2::IRSimHit::m_depEnergy

float m_depEnergy

Deposited energy.

Definition IRSimHit.h:82

◆ getGlobalTime()

virtual float getGlobalTime ( ) const

inlinevirtualinherited

Get time of the hit.

Re-implement for your subdetector's SimHit class.

Returns: global time

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

Definition at line 63 of file SimHitBase.h.

63{ return 0; }

◆ getInfo() [1/2]

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());
    }

◆ getInfo() [2/2]

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() [1/2]

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

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getInfoHTML() [2/2]

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

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getmomIn()

ROOT::Math::XYZVector getmomIn ( )

return position at start point

Definition at line 50 of file IRSimHit.cc.

50{ return m_momIn; }

Belle2::IRSimHit::m_momIn

ROOT::Math::XYZVector m_momIn

Momentum of particle at start of energy deposition.

Definition IRSimHit.h:78

◆ getmomOut()

ROOT::Math::XYZVector getmomOut ( )

return position at end point

Definition at line 52 of file IRSimHit.cc.

52{ return m_momOut; }

Belle2::IRSimHit::m_momOut

ROOT::Math::XYZVector m_momOut

Momentum of particle at end of energy deposition.

Definition IRSimHit.h:80

◆ getName() [1/2]

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getName() [2/2]

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getPDGcode()

int getPDGcode ( )

return momentum at end point

Definition at line 53 of file IRSimHit.cc.

53{ return m_PDGcode; }

Belle2::IRSimHit::m_PDGcode

int m_PDGcode

PDG code of the particle producing hit.

Definition IRSimHit.h:81

◆ getposIn()

ROOT::Math::XYZVector getposIn ( )

Set volume name.

The method to get.

Definition at line 49 of file IRSimHit.cc.

49{ return m_posIn; }

Belle2::IRSimHit::m_posIn

ROOT::Math::XYZVector m_posIn

return volume name

Definition IRSimHit.h:77

◆ getposOut()

ROOT::Math::XYZVector getposOut ( )

return momentum at start point

Definition at line 51 of file IRSimHit.cc.

51{ return m_posOut; }

Belle2::IRSimHit::m_posOut

ROOT::Math::XYZVector m_posOut

End point of energy deposition in local coordinates.

Definition IRSimHit.h:79

◆ getRelated() [1/2]

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);
    }

◆ getRelated() [2/2]

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() [1/2]

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);
    }

◆ getRelatedFrom() [2/2]

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() [1/2]

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);
    }

◆ getRelatedFromWithWeight() [2/2]

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() [1/2]

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);
    }

◆ getRelatedTo() [2/2]

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() [1/2]

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);
    }

◆ getRelatedToWithWeight() [2/2]

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() [1/2]

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);
    }

◆ getRelatedWithWeight() [2/2]

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() [1/2]

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));
    }

◆ getRelationsFrom() [2/2]

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() [1/2]

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));
    }

◆ getRelationsTo() [2/2]

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() [1/2]

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));
    }

◆ getRelationsWith() [2/2]

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));
    }

◆ getVolname()

std::string getVolname ( )

return deposited energy

Definition at line 55 of file IRSimHit.cc.

55{ return m_Volname; }

Belle2::IRSimHit::m_Volname

std::string m_Volname

Volume name.

Definition IRSimHit.h:83

◆ 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); }

◆ setdepEnergy()

void setdepEnergy ( float depEnergy )

Set PDF code.

Definition at line 39 of file IRSimHit.cc.

{
  m_depEnergy = depEnergy;
}

◆ setmomIn()

void setmomIn ( ROOT::Math::XYZVector momIn )

Set position at start point.

Definition at line 23 of file IRSimHit.cc.

{
  m_momIn = momIn;
}

◆ setmomOut()

void setmomOut ( ROOT::Math::XYZVector momOut )

Set position at end point.

Definition at line 31 of file IRSimHit.cc.

{
  m_momOut = momOut;
}

◆ setPDGcode()

void setPDGcode ( int PDGcode )

Set momentum at end point.

Definition at line 35 of file IRSimHit.cc.

{
  m_PDGcode = PDGcode;
}

◆ setposIn()

void setposIn ( ROOT::Math::XYZVector posIn )

The method to set.

Definition at line 19 of file IRSimHit.cc.

{
  m_posIn = posIn;
}

◆ setposOut()

void setposOut ( ROOT::Math::XYZVector posOut )

Set momentum at start point.

Definition at line 27 of file IRSimHit.cc.

{
  m_posOut = posOut;
}

◆ setVolname()

void setVolname ( const std::string & Volname )

Set deposited energy.

Definition at line 43 of file IRSimHit.cc.

{
  m_Volname = Volname;
}

◆ shiftInTime()

virtual void shiftInTime ( float )

inlinevirtualinherited

The method to shift the SimHit in time.

Re-implement for your subdetector's SimHit class if time-aware background is needed. Tha parameter delta the function would take is the desired time shift. However, it's unused in many cases and thus not explicitely given here, but only as an example as a comment.

ROOT::Math::XYZVector m_posIn

private

return volume name

Start point of energy deposition in local coordinates.

Definition at line 77 of file IRSimHit.h.

◆ m_posOut

ROOT::Math::XYZVector m_posOut

private

End point of energy deposition in local coordinates.

Definition at line 79 of file IRSimHit.h.

◆ m_Volname

std::string m_Volname

private

Volume name.

Definition at line 83 of file IRSimHit.h.

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

ir/dataobjects/include/IRSimHit.h
ir/dataobjects/src/IRSimHit.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IRSimHit() [1/2]

◆ IRSimHit() [2/2]

◆ ~IRSimHit()

Member Function Documentation

◆ addRelationTo() [1/4]

◆ addRelationTo() [2/4]

◆ addRelationTo() [3/4]

◆ addRelationTo() [4/4]

◆ copyRelations() [1/2]

◆ copyRelations() [2/2]

◆ getArrayIndex() [1/2]

◆ getArrayIndex() [2/2]

◆ getArrayName() [1/2]

◆ getArrayName() [2/2]

◆ getArrayPointer() [1/2]

◆ getArrayPointer() [2/2]

◆ getBackgroundTag()

◆ getdepEnergy()

◆ getGlobalTime()

◆ getInfo() [1/2]

◆ getInfo() [2/2]

◆ getInfoHTML() [1/2]

◆ getInfoHTML() [2/2]

◆ getmomIn()

◆ getmomOut()

◆ getName() [1/2]

◆ getName() [2/2]

◆ getPDGcode()

◆ getposIn()

◆ getposOut()

◆ getRelated() [1/2]

◆ getRelated() [2/2]

◆ getRelatedFrom() [1/2]

◆ getRelatedFrom() [2/2]

◆ getRelatedFromWithWeight() [1/2]

◆ getRelatedFromWithWeight() [2/2]

◆ getRelatedTo() [1/2]

◆ getRelatedTo() [2/2]

◆ getRelatedToWithWeight() [1/2]

◆ getRelatedToWithWeight() [2/2]

◆ getRelatedWithWeight() [1/2]

◆ getRelatedWithWeight() [2/2]

◆ getRelationsFrom() [1/2]

◆ getRelationsFrom() [2/2]

◆ getRelationsTo() [1/2]

◆ getRelationsTo() [2/2]

◆ getRelationsWith() [1/2]

◆ getRelationsWith() [2/2]

◆ getVolname()

◆ setBackgroundTag()

◆ setdepEnergy()

◆ setmomIn()

◆ setmomOut()

◆ setPDGcode()

◆ setposIn()

◆ setposOut()

◆ setVolname()

◆ shiftInTime()

Member Data Documentation

◆ m_backgroundTag

◆ m_cacheArrayIndex [1/2]

◆ m_cacheArrayIndex [2/2]

◆ m_cacheDataStoreEntry [1/2]

◆ m_cacheDataStoreEntry [2/2]

◆ m_depEnergy

◆ m_momIn

◆ m_momOut

◆ m_PDGcode

◆ m_posIn

◆ m_posOut

◆ m_Volname