Class PXDEnergyDepositionEvent: PXDSimHit data container for background studies. More...

#include <PXDEnergyDepositionEvent.h>

Inheritance diagram for PXDEnergyDepositionEvent:

Public Member Functions
	PXDEnergyDepositionEvent ()
	default constructor for ROOT

	PXDEnergyDepositionEvent (unsigned short layer, unsigned short ladder, unsigned short sensor, int pdg, float time, float u, float v, const float *globalPos, float energyDep, float dose, float expo)
	Standard constructor.

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.

Public Attributes
float	m_globalPos [3]
	global (x,y,z) of particle crossing

float	m_time
	time of particle crossing

float	m_u
	local u-coordinate of particle crossing

float	m_v
	local v-coordinate of particle crossing

float	m_energyDep
	deposited energy

float	m_dose
	contribution to dose (in Gy)

float	m_expo
	contribution to exposition (J/s)

int	m_pdg
	PDG number of generating particle.

unsigned short	m_layer
	layer number

unsigned short	m_ladder
	ladder number

unsigned short	m_sensor
	sensor number

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 (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

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

Private Attributes
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 PXDEnergyDepositionEvent: PXDSimHit data container for background studies.

This class holds particle hit data from geant4 simulation, and adds several quantities for easy analysis of background studies. In particular, the class is self-contained in that no relations or sensor data lookup is needed for background analysis.

Definition at line 26 of file PXDEnergyDepositionEvent.h.

Constructor & Destructor Documentation

◆ PXDEnergyDepositionEvent() [1/2]

PXDEnergyDepositionEvent ( )

inline

default constructor for ROOT

Definition at line 31 of file PXDEnergyDepositionEvent.h.

                              : m_time(0.0), m_u(0.0), m_v(0.0),
      m_energyDep(0.0), m_dose(0.0), m_expo(0.0),
      m_pdg(0), m_layer(0), m_ladder(0), m_sensor(0)
    {
      std::fill_n(m_globalPos, 3, 0.0);
    }

◆ PXDEnergyDepositionEvent() [2/2]

PXDEnergyDepositionEvent	(	unsigned short	layer,
		unsigned short	ladder,
		unsigned short	sensor,
		int	pdg,
		float	time,
		float	u,
		float	v,
		const float *	globalPos,
		float	energyDep,
		float	dose,
		float	expo )

inline

Standard constructor.

Parameters

layer	Layer number
ladder	Ladder number
sensor	Sensor number
pdg	PDG Code of the particle producing the Hit
time	Time of energy deposition
u	Local u coordinate of the event
v	Local v coordinate of the event
globalPos	Global (x,y,z) of the event
energyDep	Energy deposited by the event
dose	Contribution to dose (Gy) by the event
expo	Contribution to exposition (J/m2/s) by the event

Definition at line 51 of file PXDEnergyDepositionEvent.h.

                                                                                             :
      m_time(time), m_u(u), m_v(v), m_energyDep(energyDep), m_dose(dose), m_expo(expo),
      m_pdg(pdg), m_layer(layer), m_ladder(ladder), m_sensor(sensor)
    {
      std::copy_n(globalPos, 3, m_globalPos);
    }

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.

386 {

387 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

388 return m_cacheArrayIndex;

389 }

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

386 {

387 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

388 return m_cacheArrayIndex;

389 }

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

378 {

379 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

380 return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";

381 }

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

378 {

379 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

380 return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";

381 }

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

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

371 {

372 return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());

373 }

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

371 {

372 return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());

373 }

◆ 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 << "PDG: " << m_pdg << " ";

out << "Covariance Matrix: " << HTML::getString(getCovariance5()) << " ";

return out.str();

Belle2::PXDEnergyDepositionEvent::m_pdg

int m_pdg

PDG number of generating particle.

Definition PXDEnergyDepositionEvent.h:67

Belle2::HTML::getString

std::string getString(const TMatrixFBase &matrix, int precision=2, bool color=true)

get HTML table representing a matrix.

Definition HTML.cc:24

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 << "PDG: " << m_pdg << " ";

out << "Covariance Matrix: " << HTML::getString(getCovariance5()) << " ";

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

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

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

279 {

280 return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

281 T::Class(), name, namedRelation).object);

282 }

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

279 {

280 return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

281 T::Class(), name, namedRelation).object);

282 }

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

264 {

265 return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);

267 }

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

264 {

265 return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);

267 }

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

249 {

250 return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

251 TO::Class(), name, namedRelation).object);

252 }

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

249 {

250 return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

251 TO::Class(), name, namedRelation).object);

252 }

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

214 {

215 return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));

217 }

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

214 {

215 return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));

217 }

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

198 {

199 return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,

200 m_cacheArrayIndex, TO::Class(), name, namedRelation));

201 }

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

198 {

199 return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,

200 m_cacheArrayIndex, TO::Class(), name, namedRelation));

201 }

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

231 {

232 return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,

233 m_cacheArrayIndex, T::Class(), name, namedRelation));

234 }

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

231 {

232 return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,

233 m_cacheArrayIndex, T::Class(), name, namedRelation));

234 }

Member Data Documentation

◆ m_cacheArrayIndex [1/2]

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_cacheArrayIndex [2/2]

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

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_cacheDataStoreEntry [2/2]

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_dose

float m_dose

contribution to dose (in Gy)

Definition at line 65 of file PXDEnergyDepositionEvent.h.

◆ m_energyDep

float m_energyDep

deposited energy

Definition at line 64 of file PXDEnergyDepositionEvent.h.

◆ m_expo

float m_expo

contribution to exposition (J/s)

Definition at line 66 of file PXDEnergyDepositionEvent.h.

◆ m_globalPos

float m_globalPos[3]

global (x,y,z) of particle crossing

Definition at line 60 of file PXDEnergyDepositionEvent.h.

◆ m_ladder

unsigned short m_ladder

ladder number

Definition at line 69 of file PXDEnergyDepositionEvent.h.

◆ m_layer

unsigned short m_layer

layer number

Definition at line 68 of file PXDEnergyDepositionEvent.h.

◆ m_pdg

int m_pdg

PDG number of generating particle.

Definition at line 67 of file PXDEnergyDepositionEvent.h.

◆ m_sensor

unsigned short m_sensor

sensor number

Definition at line 70 of file PXDEnergyDepositionEvent.h.

◆ m_time

float m_time

time of particle crossing

Definition at line 61 of file PXDEnergyDepositionEvent.h.

◆ m_u

float m_u

local u-coordinate of particle crossing

Definition at line 62 of file PXDEnergyDepositionEvent.h.

◆ m_v

float m_v

local v-coordinate of particle crossing

Definition at line 63 of file PXDEnergyDepositionEvent.h.

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

pxd/dataobjects/include/PXDEnergyDepositionEvent.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PXDEnergyDepositionEvent() [1/2]

◆ PXDEnergyDepositionEvent() [2/2]

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]

◆ getInfo() [1/2]

◆ getInfo() [2/2]

◆ getInfoHTML() [1/2]

◆ getInfoHTML() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

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

Member Data Documentation

◆ m_cacheArrayIndex [1/2]

◆ m_cacheArrayIndex [2/2]

◆ m_cacheDataStoreEntry [1/2]

◆ m_cacheDataStoreEntry [2/2]

◆ m_dose

◆ m_energyDep

◆ m_expo

◆ m_globalPos

◆ m_ladder

◆ m_layer

◆ m_pdg

◆ m_sensor

◆ m_time

◆ m_u

◆ m_v