The SVD Cluster class This class stores all information about reconstructed SVD clusters. More...

#include <SVDCluster.h>

Inheritance diagram for SVDCluster:

Collaboration diagram for SVDCluster:

[legend]

Public Member Functions
	SVDCluster (VxdID sensorID, bool isU, float position, float positionSigma, double clsTime, double clsTimeSigma, float clsCharge, float seedCharge, unsigned short clsSize, float clsSN, float clsChi2, int firstFrame=0)
	Constructor. More...

	SVDCluster ()
	Default constructor for the ROOT IO.

	SVDCluster (VxdID sensorID, bool isU, float position, double clsTime, double clsTimeSigma, float clsCharge, float seedCharge, unsigned short clsSize)
	OLD STYLE 8-params constructor, just for backward compatibility. More...

	SVDCluster (VxdID sensorID, bool isU, float position, float positionSigma, double clsTime, double clsTimeSigma, float clsCharge, float seedCharge, unsigned short clsSize, float clsSN)
	OLD STYLE Constructor, just for backward compatibility. More...

VxdID	getSensorID () const
	Get the sensor ID. More...

unsigned short	getRawSensorID () const
	Get raw sensor ID.

bool	isUCluster () const
	Get the direction of strips. More...

float	getPosition (double v=0) const
	Get the coordinate of reconstructed hit. More...

float	getPositionSigma () const
	Get the error of the reconstructed hit coordinate. More...

float	getClsTime () const
	Get average of waveform maximum times of cluster strip signals. More...

float	getClsTimeSigma () const
	Get the error of the reconstructed hit time. More...

float	getCharge () const
	Get collected charge. More...

float	getSeedCharge () const
	Get seed charge. More...

unsigned short	getSize () const
	Get cluster size. More...

float	getSNR () const
	Get cluster SNR. More...

float	getChi2 () const
	Get chi2 of the time/amplitude fit. More...

int	getFirstFrame () const
	Get firstFrame of the MaxSum algorithm. More...

double	getQuality () const
	Get cluster quality indicator. More...

double	getQualityError () const
	Get cluster quality indicator error. More...

const std::vector< int > &	getTimeGroupId () const
	Get ID of the time-group. More...

const std::vector< std::tuple< float, float, float > > &	getTimeGroupInfo () const
	Get time-group parameters. More...

void	setPosition (const double position)
	Set position of the cluster.

void	setClsTime (const double time)
	Set time of the cluster.

void	setQualityIndicator (const double qualityIndicator)
	Add quality indicator to object.

void	setQualityIndicatorError (double qualityIndicatorError)
	Add quality indicator error to object.

std::vector< int > &	setTimeGroupId ()
	Set ID of the time-group. More...

std::vector< std::tuple< float, float, float > > &	setTimeGroupInfo ()
	Set time-group parameters. More...

std::string	print () const
	Get a string representation of the cluster.

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

Protected Attributes
unsigned short	m_sensorID
	Compressed sensor identifier.

bool	m_isU
	True if clusters of u-strips, otherwise false.

float	m_position
	Reconstructed hit position in r-phi or z.

float	m_positionSigma
	Standard deviation of hit position in r-phi or z.

double	m_clsTime
	Average waveform maximum time.

double	m_clsTimeSigma
	Standard deviation of waveform maximum times.

float	m_clsCharge
	Deposited charge in electrons.

float	m_seedCharge
	Cluster seed charge in electrons.

unsigned short	m_clsSize
	Cluster size in pixels.

float	m_clsSN
	Cluster S/N ratio.

float	m_clsChi2
	Chi2 for time/amplitude fit.

int	m_firstFrame
	firstFrame computed with the MaxSum algorithm

std::vector< int >	m_timeGroupId
	Grouping of clusters in time.

std::vector< std::tuple< float, float, float > >	m_timeGroupInfo
	TimeGroup Gaussian Parameters, (integral, center, sigma)

double	m_qualityIndicator = {0.}
	Probability of signal cluster.

double	m_qualityIndicatorError = {0.}
	Error associated with probability calcualtion.

Private Member Functions
	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.

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

Detailed Description

The SVD Cluster class This class stores all information about reconstructed SVD clusters.

Definition at line 29 of file SVDCluster.h.

Constructor & Destructor Documentation

◆ SVDCluster() [1/3]

SVDCluster	(	VxdID	sensorID,
		bool	isU,
		float	position,
		float	positionSigma,
		double	clsTime,
		double	clsTimeSigma,
		float	clsCharge,
		float	seedCharge,
		unsigned short	clsSize,
		float	clsSN,
		float	clsChi2,
		int	firstFrame = `0`
	)

inline

Constructor.

Parameters

sensorID	Sensor compact ID.
isU	true if u strips, otherwise false.
position	Hit position estimate.
positionSigma	Error of hit postion estimate.
clsTime	Hit time stimate.
clsTimeSigma	Error of hit time estimate.
clsCharge	The cluster charge in ADC units.
seedCharge	The charge of the seed strip in ADC units.
clsSize	Cluster size, number of fired strips that form the cluster.
clsSN	Signal-to-noise ratio for the cluster
clsChi2	value for cluster fit
firstFrame

Definition at line 46 of file SVDCluster.h.

                                                                                       :
       m_sensorID(sensorID), m_isU(isU),
       m_position(position), m_positionSigma(positionSigma),
       m_clsTime(clsTime), m_clsTimeSigma(clsTimeSigma), m_clsCharge(clsCharge),
       m_seedCharge(seedCharge), m_clsSize(clsSize), m_clsSN(clsSN),
       m_clsChi2(clsChi2), m_firstFrame(firstFrame)
     {}

◆ SVDCluster() [2/3]

SVDCluster	(	VxdID	sensorID,
		bool	isU,
		float	position,
		double	clsTime,
		double	clsTimeSigma,
		float	clsCharge,
		float	seedCharge,
		unsigned short	clsSize
	)

inline

OLD STYLE 8-params constructor, just for backward compatibility.

Will be removed in future.

Parameters

sensorID	Sensor compact ID.
isU	true if u strips, otherwise false.
position	Hit position estimate.
clsTime	Hit time stimate.
clsTimeSigma	Error of hit time estimate.
clsCharge	The cluster charge in ADC units.
seedCharge	The charge of the seed strip in ADC units.
clsSize	Cluster size, number of fired strips that form the cluster.

Definition at line 72 of file SVDCluster.h.

◆ SVDCluster() [3/3]

SVDCluster	(	VxdID	sensorID,
		bool	isU,
		float	position,
		float	positionSigma,
		double	clsTime,
		double	clsTimeSigma,
		float	clsCharge,
		float	seedCharge,
		unsigned short	clsSize,
		float	clsSN
	)

inline

OLD STYLE Constructor, just for backward compatibility.

Parameters

sensorID	Sensor compact ID.
isU	true if u strips, otherwise false.
position	Hit position estimate.
positionSigma	Error of hit postion estimate.
clsTime	Hit time stimate.
clsTimeSigma	Error of hit time estimate.
clsCharge	The cluster charge in ADC units.
seedCharge	The charge of the seed strip in ADC units.
clsSize	Cluster size, number of fired strips that form the cluster.
clsSN	Signal-to-noise ratio for the cluster Will be removed in future.

Definition at line 92 of file SVDCluster.h.

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.

◆ getCharge()

float getCharge ( void ) const

inline

Get collected charge.

Returns: charge collected in the cluster in e-.

Definition at line 144 of file SVDCluster.h.

◆ getChi2()

float getChi2 ( ) const

inline

Get chi2 of the time/amplitude fit.

Returns: Chi2/ndf for the fit

Definition at line 164 of file SVDCluster.h.

◆ getClsTime()

float getClsTime ( ) const

inline

Get average of waveform maximum times of cluster strip signals.

Returns: average waveform maximum times.

Definition at line 134 of file SVDCluster.h.

◆ getClsTimeSigma()

float getClsTimeSigma ( ) const

inline

Get the error of the reconstructed hit time.

Returns: error of the reconstructed hit time.

Definition at line 139 of file SVDCluster.h.

◆ getFirstFrame()

int getFirstFrame ( ) const

inline

Get firstFrame of the MaxSum algorithm.

Returns: firstFrame of the MaxSum algorithm

Definition at line 169 of file SVDCluster.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.

◆ getPosition()

float getPosition ( double v = 0 ) const

inline

Get the coordinate of reconstructed hit.

The returned value is now dependent of vCluster and valid only and it is only relevant for wedged/slanted sensors because of their trapezoidal shape, for rectangular shapes, the value does not change

Returns: coordinate of the reconstructed hit.

Definition at line 117 of file SVDCluster.h.

◆ getPositionSigma()

float getPositionSigma ( ) const

inline

Get the error of the reconstructed hit coordinate.

Returns: error of the reconstructed hit coordinate.

Definition at line 129 of file SVDCluster.h.

◆ getQuality()

double getQuality ( ) const

inline

Get cluster quality indicator.

Returns: probability that cluster is generated from signal hit.

Definition at line 174 of file SVDCluster.h.

◆ getQualityError()

double getQualityError ( ) const

inline

Get cluster quality indicator error.

Returns: error in probability that cluster is generated from signal hit.

Definition at line 179 of file SVDCluster.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.

◆ getSeedCharge()

float getSeedCharge ( ) const

inline

Get seed charge.

Returns: charge of the seed strip in e-.

Definition at line 149 of file SVDCluster.h.

◆ getSensorID()

VxdID getSensorID ( void ) const

inline

Get the sensor ID.

Returns: ID of the sensor.

Definition at line 102 of file SVDCluster.h.

◆ getSize()

unsigned short getSize ( ) const

inline

Get cluster size.

Returns: number of strips contributing to the cluster.

Definition at line 154 of file SVDCluster.h.

◆ getSNR()

float getSNR ( ) const

inline

Get cluster SNR.

Returns: cluster charge / std error of cluster charge

Definition at line 159 of file SVDCluster.h.

◆ getTimeGroupId()

const std::vector<int>& getTimeGroupId ( ) const

inline

Get ID of the time-group.

Returns: time-group ID

Definition at line 184 of file SVDCluster.h.

◆ getTimeGroupInfo()

const std::vector<std::tuple<float, float, float> >& getTimeGroupInfo ( ) const

inline

Get time-group parameters.

Returns: time-group parameters (integral, center, sigma)

Definition at line 189 of file SVDCluster.h.

◆ isUCluster()

bool isUCluster ( ) const

inline

Get the direction of strips.

Returns: true if u-strips, otherwise false.

Definition at line 110 of file SVDCluster.h.

◆ setTimeGroupId()

std::vector<int>& setTimeGroupId ( )

inline

Set ID of the time-group.

Returns: reference to time-group ID

Definition at line 226 of file SVDCluster.h.

◆ setTimeGroupInfo()

std::vector<std::tuple<float, float, float> >& setTimeGroupInfo ( )

inline

Set time-group parameters.

Returns: reference to the time-group parameters (integral, center, sigma)

Definition at line 231 of file SVDCluster.h.

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

svd/dataobjects/include/SVDCluster.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SVDCluster() [1/3]

◆ SVDCluster() [2/3]

◆ SVDCluster() [3/3]

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getCharge()

◆ getChi2()

◆ getClsTime()

◆ getClsTimeSigma()

◆ getFirstFrame()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getPosition()

◆ getPositionSigma()

◆ getQuality()

◆ getQualityError()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getSeedCharge()

◆ getSensorID()

◆ getSize()

◆ getSNR()

◆ getTimeGroupId()

◆ getTimeGroupInfo()

◆ isUCluster()

◆ setTimeGroupId()

◆ setTimeGroupInfo()