Class to store Cherenkov photons at emission and at detection relation to TOPSimHit filled in top/simulation/src/SensitivePMT.cc. More...

#include <TOPSimPhoton.h>

Inheritance diagram for TOPSimPhoton:

[legend]

Collaboration diagram for TOPSimPhoton:

[legend]

Public Member Functions
	TOPSimPhoton ()
	Default constructor.

	TOPSimPhoton (int moduleID, TVector3 emissionPoint, TVector3 emissionMom, double emissionTime, TVector3 detectionPoint, TVector3 detectionMom, double detectionTime, double length, double energy_eV)
	Full constructor. More...

int	getModuleID () const
	Returns module ID. More...

TVector3	getEmissionPoint () const
	Returns emission point. More...

TVector3	getEmissionDir () const
	Returns emission momentum direction (unit vector) More...

double	getEmissionTime () const
	Returns emission time. More...

TVector3	getDetectionPoint () const
	Returns detection point. More...

TVector3	getDetectionDir () const
	Returns detection momentum direction (unit vector) More...

double	getDetectionTime () const
	Returns detection time. More...

double	getLength () const
	Returns propagation length. More...

double	getEnergy () const
	Returns photon energy. More...

void	addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching). More...

void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow). More...

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

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

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

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

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

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

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

template<class TO >
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array. More...

template<class FROM >
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array. More...

template<class T >
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array. More...

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

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

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

std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.

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

Protected Member Functions
TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Private Member Functions
	ClassDef (TOPSimPhoton, 2)
	ClassDef.

Private Attributes
int	m_moduleID = 0
	TOP module ID.

float	m_xe = 0
	emission point, x component

float	m_ye = 0
	emission point, y component

float	m_ze = 0
	emission point, z component

float	m_pxe = 0
	emission momentum (direction), x component

float	m_pye = 0
	emission momentum (direction), y component

float	m_pze = 0
	emission momentum (direction), z component

float	m_te = 0
	emission time

float	m_xd = 0
	detection point, x component

float	m_yd = 0
	detection point, y component

float	m_zd = 0
	detection point, z component

float	m_pxd = 0
	detection momentum (direction), x component

float	m_pyd = 0
	detection momentum (direction), y component

float	m_pzd = 0
	detection momentum (direction), z component

float	m_td = 0
	detection time

float	m_length = 0
	propagation length

float	m_energy = 0
	photon energy in [eV]

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

Class to store Cherenkov photons at emission and at detection relation to TOPSimHit filled in top/simulation/src/SensitivePMT.cc.

Definition at line 36 of file TOPSimPhoton.h.

Constructor & Destructor Documentation

◆ TOPSimPhoton()

TOPSimPhoton	(	int	moduleID,
		TVector3	emissionPoint,
		TVector3	emissionMom,
		double	emissionTime,
		TVector3	detectionPoint,
		TVector3	detectionMom,
		double	detectionTime,
		double	length,
		double	energy_eV
	)

inline

Full constructor.

Parameters

moduleID	module ID
emissionPoint	emission point
emissionMom	emission momentum (direction)
emissionTime	emission time
detectionPoint	detection point
detectionMom	detection momentum (direction)
detectionTime	detection time
length	photon propagation length
energy_eV	photon energy in [eV]

Definition at line 57 of file TOPSimPhoton.h.

     {
       m_moduleID = moduleID;
       m_xe = (float) emissionPoint.x();
       m_ye = (float) emissionPoint.y();
       m_ze = (float) emissionPoint.z();
       m_pxe = (float) emissionMom.x();
       m_pye = (float) emissionMom.y();
       m_pze = (float) emissionMom.z();
       m_te = (float) emissionTime;
       m_xd = (float) detectionPoint.x();
       m_yd = (float) detectionPoint.y();
       m_zd = (float) detectionPoint.z();
       m_pxd = (float) detectionMom.x();
       m_pyd = (float) detectionMom.y();
       m_pzd = (float) detectionMom.z();
       m_td = (float) detectionTime;
       m_length = (float) length;
       m_energy = (float) energy_eV;
     }
  
     int getModuleID() const { return m_moduleID; }
  

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 144 of file RelationsObject.h.

◆ addRelationTo() [2/2]

void addRelationTo	(	const TObject *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 157 of file RelationsObject.h.

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 172 of file RelationsObject.h.

◆ getDetectionDir()

TVector3 getDetectionDir ( ) const

inline

Returns detection momentum direction (unit vector)

Returns: detection direction

Definition at line 123 of file TOPSimPhoton.h.

◆ getDetectionPoint()

TVector3 getDetectionPoint ( ) const

inline

Returns detection point.

Returns: detection point

Definition at line 117 of file TOPSimPhoton.h.

◆ getDetectionTime()

double getDetectionTime ( ) const

inline

Returns detection time.

Returns: detection time

Definition at line 130 of file TOPSimPhoton.h.

◆ getEmissionDir()

TVector3 getEmissionDir ( ) const

inline

Returns emission momentum direction (unit vector)

Returns: emission direction vector

Definition at line 104 of file TOPSimPhoton.h.

◆ getEmissionPoint()

TVector3 getEmissionPoint ( ) const

inline

Returns emission point.

Returns: emission point

Definition at line 98 of file TOPSimPhoton.h.

◆ getEmissionTime()

double getEmissionTime ( ) const

inline

Returns emission time.

Returns: emission time

Definition at line 111 of file TOPSimPhoton.h.

◆ getEnergy()

double getEnergy ( ) const

inline

Returns photon energy.

Returns: photon energy in [eV]

Definition at line 142 of file TOPSimPhoton.h.

◆ getInfo()

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note: : You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 372 of file RelationsObject.h.

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also: Particle::getInfoHTML() for a more complex example.; HTML for some utility functions.; Use getInfo() to get a raw text version of this output.

Reimplemented in TrackFitResult, TRGSummary, Track, SoftwareTriggerResult, Particle, RecoTrack, MCParticle, Cluster, and PIDLikelihood.

Definition at line 364 of file RelationsObject.h.

◆ getLength()

double getLength ( ) const

inline

Returns propagation length.

Returns: propagation length

Definition at line 136 of file TOPSimPhoton.h.

◆ getModuleID()

int getModuleID ( ) const

inline

Returns module ID.

Returns: module ID

Definition at line 92 of file TOPSimPhoton.h.

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in SpacePoint, Particle, and MCParticle.

Definition at line 346 of file RelationsObject.h.

◆ getRelated()

T* getRelated	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 280 of file RelationsObject.h.

◆ getRelatedFrom()

FROM* getRelatedFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 265 of file RelationsObject.h.

◆ getRelatedFromWithWeight()

std::pair<FROM*, float> getRelatedFromWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 316 of file RelationsObject.h.

◆ getRelatedTo()

TO* getRelatedTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 250 of file RelationsObject.h.

◆ getRelatedToWithWeight()

std::pair<TO*, float> getRelatedToWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 299 of file RelationsObject.h.

◆ getRelatedWithWeight()

std::pair<T*, float> getRelatedWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 333 of file RelationsObject.h.

◆ getRelationsFrom()

RelationVector<FROM> getRelationsFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 214 of file RelationsObject.h.

◆ getRelationsTo()

RelationVector<TO> getRelationsTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 199 of file RelationsObject.h.

◆ getRelationsWith()

RelationVector<T> getRelationsWith	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 232 of file RelationsObject.h.

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

top/dataobjects/include/TOPSimPhoton.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TOPSimPhoton()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getDetectionDir()

◆ getDetectionPoint()

◆ getDetectionTime()

◆ getEmissionDir()

◆ getEmissionPoint()

◆ getEmissionTime()

◆ getEnergy()

◆ getInfo()

◆ getInfoHTML()

◆ getLength()

◆ getModuleID()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()