Example Detector. More...

#include <CDCSimHit.h>

Inheritance diagram for CDCSimHit:

[legend]

Collaboration diagram for CDCSimHit:

[legend]

Public Member Functions
void	setWireID (int iCLayerID, int iWireID)
	Setter for Wire ID. More...

void	setTrackId (int trackId)
	The method to set track id.

void	setPDGCode (int pdg)
	The method to set PDG code.

void	setDriftLength (double driftLength)
	The method to set drift length.

void	setFlightTime (double flightTime)
	The method to set flight time.

void	setGlobalTime (double globalTime)
	The method to set global time.

void	setEnergyDep (double edep)
	The method to set deposited energy.

void	setStepLength (double stepLength)
	The method to set step length.

void	setMomentum (const B2Vector3D &momentum)
	The method to set momentum.

void	setPosWire (const B2Vector3D &posWire)
	The method to set position on wire.

void	setPosIn (const B2Vector3D &posIn)
	The method to set position of pre-step.

void	setPosOut (const B2Vector3D &posOut)
	The method to set position of post-step.

void	setPosTrack (const B2Vector3D &posTrack)
	The method to set position on the track.

void	setPosFlag (int zeroOrOne)
	The method to set position flag.

void	setLeftRightPassageRaw (int minusOneOrZeroOrOne)
	The method to set new left/right info. for digitization.

void	setLeftRightPassage (int minusOneOrZeroOrOne)
	The method to set new left/right info. for tracking.

WireID	getWireID () const
	Getter for WireID object.

int	getTrackId () const
	The method to get track id.

int	getPDGCode () const
	The method to get PDG code.

double	getDriftLength () const
	The method to get drift length.

double	getFlightTime () const
	The method to get flight time.

double	getEnergyDep () const
	The method to get deposited energy.

double	getStepLength () const
	The method to get step length.

B2Vector3D	getMomentum () const
	The method to get momentum.

B2Vector3D	getPosWire () const
	The method to get position on wire.

B2Vector3D	getPosIn () const
	The method to get position of pre-step.

B2Vector3D	getPosOut () const
	The method to get position of post-step.

B2Vector3D	getPosTrack () const
	The method to get position on the track.

int	getPosFlag () const
	The method to get old left/right info.

int	getLeftRightPassageRaw () const
	The method to get new left/right info. for digitization.

int	getLeftRightPassage () const
	The method to get new left/right info. for tracking.

float	getGlobalTime () const override
	The method to get global time.

	CDCSimHit ()
	Empty constructor. More...

	CDCSimHit (int layerId, int wireId, int trackId, int pdg, double driftLength, double flightTime, double edep, double stepLength, B2Vector3D momentum, B2Vector3D posWire, B2Vector3D posIn, B2Vector3D posOut, B2Vector3D posTrack, int leftRight, double globalTime)
	Useful Constructor.

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

	ClassDefOverride (CDCSimHit, 6)
	ROOT Macro.

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
WireID	m_wireID
	The WireID of the hit.

unsigned short	m_trackId
	The track id of this hit.

int	m_pdg
	Particle PDG (can be one of secondaries).

float	m_driftLength
	Drift length of this hit.

float	m_flightTime
	Flight time from IP.

float	m_edep
	Deposited energy of this hit.

float	m_stepLength
	Step length of this hit.

float	m_momentum [3]
	The momentum at closest point.

float	m_posWire [3]
	The position on wire which is closest to this hit.

float	m_posIn [3]
	Position of pre-step.

float	m_posOut [3]
	Position of post-step.

float	m_posTrack [3]
	Position on the track.

unsigned char	m_leftRight
	The flag to denote this hit is in the left or right side. More...

float	m_globalTime
	Time of energy deposition.

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

Example Detector.

Definition at line 21 of file CDCSimHit.h.

Constructor & Destructor Documentation

◆ CDCSimHit()

CDCSimHit ( )

inline

Empty constructor.

Recommended for ROOT IO

Definition at line 254 of file CDCSimHit.h.

                : SimHitBase(),
       m_trackId(0), m_pdg(0), m_driftLength(0.0),
       m_flightTime(0.0), m_edep(0.0), m_stepLength(1.0),
       m_momentum(), m_posWire(),
       m_posIn(), m_posOut(), m_posTrack(),
       m_leftRight(0), m_globalTime(0.0)
     {}

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.

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

◆ setWireID()

void setWireID	(	int	iCLayerID,
		int	iWireID
	)

inline

Setter for Wire ID.

Parameters

iCLayerID	number of layer with continuous counting method.
iWireID	number of wire within the layer.

Definition at line 79 of file CDCSimHit.h.

◆ shiftInTime()

virtual void shiftInTime ( float delta )

inlineoverridevirtual

Shift the SimHit in time.

Parameters

delta The value of the time shift.

Reimplemented from SimHitBase.

Definition at line 309 of file CDCSimHit.h.

Member Data Documentation

◆ m_leftRight

unsigned char m_leftRight

private

The flag to denote this hit is in the left or right side.

bit0: old L/R flag; bit1: new L/R flag for digitization; bit2: new L/R flag for tracking.

Definition at line 67 of file CDCSimHit.h.

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

cdc/dataobjects/include/CDCSimHit.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CDCSimHit()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getBackgroundTag()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ setBackgroundTag()

◆ setWireID()

◆ shiftInTime()

Member Data Documentation

◆ m_leftRight