Class PXDSimHit - Geant4 simulated hit for the PXD. More...

#include <PXDSimHit.h>

Inheritance diagram for PXDSimHit:

[legend]

Collaboration diagram for PXDSimHit:

[legend]

Public Member Functions
	PXDSimHit ()
	default constructor for ROOT

	PXDSimHit (VxdID sensorID, int pdg, float globalTime, const float posIn, const float posOut)
	Standard constructor. More...

void	setEnergyDeposit (std::vector< unsigned int > &electronProfile)
	Set energy deposition profile To avoid copying of the entries this will take over the contents of the argument and after the call the argument will be empty. More...

VxdID	getSensorID () const
	Return the sensorID of the sensor the electron was deposited in.

int	getPDGcode () const
	Return the PDG code of the particle causing the electron deposition.

ROOT::Math::XYZVector	getPosIn () const
	Return the start point of the electron deposition in local coordinates.

ROOT::Math::XYZVector	getPosOut () const
	Return the end point of the electron deposition in local coordinates.

const float *	getPosArrayIn () const
	Return the start point of the electron deposition in local coordinates as float array.

const float *	getPosArrayOut () const
	Return the end point of the electron deposition in local coordinates as float array.

float	getGlobalTime () const override
	Return the time of the electron deposition.

virtual void	shiftInTime (float delta) override
	Shift the SimHit in time. More...

float	getElectrons () const
	Return the number of created electrons.

std::vector< std::pair< float, float > >	getElectronProfile () const
	Get the decoded electron profile. More...

std::vector< std::pair< float, float > >	getElectronsConstantDistance (double length) const
	Get the electron deposition along constant stepsize. More...

std::vector< std::pair< float, float > >	getElectronsConstantNumber (double electronsPerStep) const
	Get the electron deposition with constant number of electrons between sampling points. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
std::vector< unsigned int >	m_electronProfile
	Energy depsoition profile encoded using the ElectronDeposit class.

int	m_pdg
	PDG Code of the particle producing the Hit.

float	m_globalTime
	Time of electron deposition.

float	m_posIn [3]
	Start point of electron deposition in local coordinates.

float	m_posOut [3]
	End point of electron deposition in local coordinates.

unsigned short	m_sensorID
	ID of the sensor the electron was deposited in.

unsigned short	m_backgroundTag
	Background tag.

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

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

Detailed Description

Class PXDSimHit - Geant4 simulated hit for the PXD.

This class holds particle hit data from geant4 simulation. As the simulated hit classes are used to generate detector response, they contain local information.

Definition at line 24 of file PXDSimHit.h.

Constructor & Destructor Documentation

◆ PXDSimHit()

PXDSimHit	(	VxdID	sensorID,
		int	pdg,
		float	globalTime,
		const float *	posIn,
		const float *	posOut
	)

inline

Standard constructor.

Parameters

sensorID	ID of the sensor
pdg	PDG Code of the particle producing the Hit
globalTime	Time of electron deposition
posIn	Start point of electron deposition in local coordinates
posOut	End point of electron deposition in local coordinates

Definition at line 36 of file PXDSimHit.h.

37 : VXDSimHit(sensorID, pdg, globalTime, posIn, posOut)

38 {}

Belle2::VXDSimHit::VXDSimHit

VXDSimHit()

default constructor for ROOT

Definition: VXDSimHit.h:33

Member Function Documentation

◆ addRelationTo() [1/2]

void addRelationTo	(	const RelationsInterface< BASE > *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

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

Definition at line 142 of file RelationsObject.h.

◆ addRelationTo() [2/2]

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

inlineinherited

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

Parameters

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

Definition at line 155 of file RelationsObject.h.

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > * sourceObj )

inlineinherited

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

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

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

Definition at line 170 of file RelationsObject.h.

◆ getBackgroundTag()

virtual unsigned short getBackgroundTag ( ) const

inlinevirtualinherited

Get background tag.

Returns: The background tag value.

Definition at line 46 of file SimHitBase.h.

◆ getElectronProfile()

std::vector< std::pair< float, float > > getElectronProfile ( ) const

inherited

Get the decoded electron profile.

Each entry is the fraction between posIn and posOut and the number of electrons deposited up to that point. It will contain at least one entry with a fraction of one and the total number of deposited electrons.

Returns: vector of (fraction, electron) pairs

Definition at line 21 of file VXDSimhit.cc.

 {
   std::vector<std::pair<float, float>> result;
   result.reserve(m_electronProfile.size());
   for (unsigned int encoded : m_electronProfile) {
     VXDElectronDeposit ed(encoded);
     result.emplace_back(ed.getFraction(), ed.getElectrons());
   }
   return result;
 }

◆ getElectronsConstantDistance()

std::vector< std::pair< float, float > > getElectronsConstantDistance ( double length ) const

inherited

Get the electron deposition along constant stepsize.

The electron deposition will be sampled between posIn and posOut in equal steps with a specified length. The acutal sampling length might differ slightly from the given parameter but will be equal and below the given value for all steps. The returned vector will contain fractions between posIn and posOut and the electrons deposited up to that point.It will contain at least one entry with a fraction of one and the total number of deposited electrons.

Parameters

length target step size in default length unit (cm)

Returns: vector of (fraction, electron) pairs

Definition at line 32 of file VXDSimhit.cc.

◆ getElectronsConstantNumber()

std::vector< std::pair< float, float > > getElectronsConstantNumber ( double electronsPerStep ) const

inherited

Get the electron deposition with constant number of electrons between sampling points.

The number of electrons per step might differ from the given parameter but will be equal and at most the given value for all steps. The returned vector will contain fractions between posIn and posOut and the electrons deposited up to that point. It will contain at least one entry with a fraction of one and the total number of deposited electrons.

Parameters

electronsPerStep length target number of electrons per step

Returns: vector of (fraction, electron) pairs

Definition at line 66 of file VXDSimhit.cc.

◆ getInfo()

std::string getInfo ( ) const

inlineinherited

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

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

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

Definition at line 370 of file RelationsObject.h.

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

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

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

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

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

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

Definition at line 362 of file RelationsObject.h.

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in SpacePoint, MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

◆ getRelated()

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

inlineinherited

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

Template Parameters

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

Parameters

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

Returns: The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

◆ getRelatedFrom()

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

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

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

Returns: The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

◆ getRelatedFromWithWeight()

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

inlineinherited

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

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

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

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

Definition at line 314 of file RelationsObject.h.

◆ getRelatedTo()

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

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

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

Returns: The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

◆ getRelatedToWithWeight()

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

inlineinherited

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

Template Parameters

TO	The class of objects to which the relation points.

Parameters

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

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

Definition at line 297 of file RelationsObject.h.

◆ getRelatedWithWeight()

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

inlineinherited

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

Template Parameters

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

Parameters

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

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

Definition at line 331 of file RelationsObject.h.

◆ getRelationsFrom()

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

inlineinherited

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

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

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

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

◆ getRelationsTo()

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

inlineinherited

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

Template Parameters

TO	The class of objects to which the relations point.

Parameters

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

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

◆ getRelationsWith()

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

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

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

Parameters

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

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

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

◆ setEnergyDeposit()

void setEnergyDeposit ( std::vector< unsigned int > & electronProfile )

inlineinherited

Set energy deposition profile To avoid copying of the entries this will take over the contents of the argument and after the call the argument will be empty.

TODO: Normally this would be done with an lvalue reference but we need a dictionary so we have to compile it with cint, might change for ROOT6.

Parameters

electronProfile list of energy depositions along the simhit, encoded using ElectronDeposit class. Will be empty after call

Definition at line 59 of file VXDSimHit.h.

     {
       m_electronProfile.clear();
       std::swap(m_electronProfile, electronProfile);
     }

◆ shiftInTime()

virtual void shiftInTime ( float delta )

inlineoverridevirtualinherited

Shift the SimHit in time.

Parameters

delta The value of the time shift.

Reimplemented from SimHitBase.

Definition at line 82 of file VXDSimHit.h.

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

pxd/dataobjects/include/PXDSimHit.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PXDSimHit()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getBackgroundTag()

◆ getElectronProfile()

◆ getElectronsConstantDistance()

◆ getElectronsConstantNumber()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ setBackgroundTag()

◆ setEnergyDeposit()

◆ shiftInTime()