Class to store calibrated ECLDigits: ECLCalDigits. More...

#include <ECLCalDigit.h>

Inheritance diagram for ECLCalDigit:

Collaboration diagram for ECLCalDigit:

[legend]

Public Types
enum	StatusBit { c_IsEnergyCalibrated = 1 << 0 , c_IsTimeCalibrated = 1 << 1 , c_IsTimeResolutionCalibrated = 1 << 2 , c_IsFailedFit = 1 << 3 , c_IsFailedTimeResolution = 1 << 4 , c_IsCalibrated = c_IsEnergyCalibrated \| c_IsTimeCalibrated \| c_IsTimeResolutionCalibrated }
	status enumerator

Public Member Functions
	ECLCalDigit ()
	default constructor for ROOT More...

void	setCellId (int CellId)
	Set Cell ID.

void	setEnergy (double Energy)
	Set Calibrated Energy.

void	setTwoComponentTotalEnergy (double Energy)
	Set two component total energy.

void	setTwoComponentHadronEnergy (double Energy)
	Set two component hadron energy.

void	setTwoComponentDiodeEnergy (double Energy)
	Set two component diode energy.

void	setTwoComponentChi2 (double chi)
	Set two component chi2.

void	setTwoComponentSavedChi2 (ECLDsp::TwoComponentFitType FitTypeIn, double input)
	Set two comp chi2 for a fit type see enum TwoComponentFitType in ECLDsp.h for description of fit types.

void	setTwoComponentFitType (ECLDsp::TwoComponentFitType ft)
	Set two component fit type.

void	setTime (double Time)
	Set Calibrated Time.

void	setTimeResolution (double TimeResolution)
	Set Calibrated Time Resolution.

void	setStatus (unsigned short int status)
	Set Calibration Status (overwrites previously set bits)

void	addStatus (unsigned short int bitmask)
	Add Calibration Status.

void	removeStatus (unsigned short int bitmask)
	Remove Calibration Status.

int	getCellId () const
	Get Cell ID. More...

double	getEnergy () const
	Get Calibrated Energy. More...

double	getTwoComponentTotalEnergy () const
	Get Two Component calibrated Total Energy. More...

double	getTwoComponentHadronEnergy () const
	Get Two Component calibrated hadron component Energy. More...

double	getTwoComponentDiodeEnergy () const
	Get Two Component calibrated diode component Energy. More...

double	getTwoComponentChi2 () const
	Get two componnent chi2. More...

double	getTwoComponentSavedChi2 (ECLDsp::TwoComponentFitType FitTypeIn) const
	get two comp chi2 for a fit type see enum TwoComponentFitType in ECLDsp.h for description of fit types. More...

ECLDsp::TwoComponentFitType	getTwoComponentFitType () const
	Get two componnent fit type. More...

double	getTime () const
	Get Calibrated Time. More...

double	getTimeResolution () const
	Get Calibrated Time Resolution. More...

bool	hasStatus (unsigned short int bitmask) const
	Get Calibration Status. More...

bool	isCalibrated () const
	Get Boolean Calibration Status. More...

bool	isEnergyCalibrated () const
	Get Boolean Energy Calibration Status. More...

bool	isTimeCalibrated () const
	Get Boolean Time Calibration Status. More...

bool	isTimeResolutionCalibrated () const
	Get Boolean Time Resolution Calibration Status. More...

bool	isFailedFit () const
	Get Boolean Fit Failed Status. More...

bool	isTimeResolutionFailed () const
	Get Boolean time resolution failed status. 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 (ECLCalDigit, 6)
	ClassDef.

Private Attributes
int	m_CellId
	Cell ID.

double	m_Time
	Calibrated Time.

double	m_TimeResolution
	Calibrated Time resolution.

double	m_Energy
	Calibrated Energy.

unsigned short int	m_Status
	Calibration and Fit Status.

double	m_TwoComponentTotalEnergy
	Calibrated Two Component Total Energy.

double	m_TwoComponentHadronEnergy
	Calibrated Hadron Component Energy.

double	m_TwoComponentDiodeEnergy
	Calibrated Diode Component Energy.

double	m_TwoComponentChi2
	Two Component chi2.

double	m_TwoComponentSavedChi2 [3]
	Two comp chi2 for each fit tried in reconstruction.

ECLDsp::TwoComponentFitType	m_TwoComponentFitType
	offline fit hypothesis.

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 calibrated ECLDigits: ECLCalDigits.

Definition at line 23 of file ECLCalDigit.h.

Constructor & Destructor Documentation

◆ ECLCalDigit()

ECLCalDigit ( )

inline

default constructor for ROOT

< Cell ID

< Calibrated Time

< Calibrated Time Resolution

< Calibrated Energy

< Calibration Status

< Offline Two Component Total Energy

< Offline Two Component Hadron Energy

< Offline Two Component Diode Energy

< Offline Two Component chi2

< Offline two component chi2 FT=0

< Offline two component chi2 FT=1

< Offline two component chi2 FT=2

< Offline Two Component fit type

Definition at line 37 of file ECLCalDigit.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.

◆ getCellId()

int getCellId ( ) const

inline

Get Cell ID.

Returns: cell ID

Definition at line 114 of file ECLCalDigit.h.

◆ getEnergy()

double getEnergy ( ) const

inline

Get Calibrated Energy.

Returns: Calibrated Energy

Definition at line 119 of file ECLCalDigit.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.

◆ getTime()

double getTime ( ) const

inline

Get Calibrated Time.

Returns: Calibrated Time

Definition at line 159 of file ECLCalDigit.h.

◆ getTimeResolution()

double getTimeResolution ( ) const

inline

Get Calibrated Time Resolution.

Returns: Calibrated Time Resolution

Definition at line 164 of file ECLCalDigit.h.

◆ getTwoComponentChi2()

double getTwoComponentChi2 ( ) const

inline

Get two componnent chi2.

Returns: two componnent chi2

Definition at line 139 of file ECLCalDigit.h.

◆ getTwoComponentDiodeEnergy()

double getTwoComponentDiodeEnergy ( ) const

inline

Get Two Component calibrated diode component Energy.

Returns: Two Component calibrated diode component Energy

Definition at line 134 of file ECLCalDigit.h.

◆ getTwoComponentFitType()

ECLDsp::TwoComponentFitType getTwoComponentFitType ( ) const

inline

Get two componnent fit type.

Returns: two componnent fit type

Definition at line 154 of file ECLCalDigit.h.

◆ getTwoComponentHadronEnergy()

double getTwoComponentHadronEnergy ( ) const

inline

Get Two Component calibrated hadron component Energy.

Returns: Two Component calibrated hadron component Energy

Definition at line 129 of file ECLCalDigit.h.

◆ getTwoComponentSavedChi2()

double getTwoComponentSavedChi2 ( ECLDsp::TwoComponentFitType FitTypeIn ) const

inline

get two comp chi2 for a fit type see enum TwoComponentFitType in ECLDsp.h for description of fit types.

Returns: two comp chi2 for fit type

Definition at line 145 of file ECLCalDigit.h.

◆ getTwoComponentTotalEnergy()

double getTwoComponentTotalEnergy ( ) const

inline

Get Two Component calibrated Total Energy.

Returns: Two Component calibrated Total Energy

Definition at line 124 of file ECLCalDigit.h.

◆ hasStatus()

bool hasStatus ( unsigned short int bitmask ) const

inline

Get Calibration Status.

Returns: Calibration Status

Definition at line 169 of file ECLCalDigit.h.

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

ecl/dataobjects/include/ECLCalDigit.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ECLCalDigit()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getCellId()

◆ getEnergy()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getTime()

◆ getTimeResolution()

◆ getTwoComponentChi2()

◆ getTwoComponentDiodeEnergy()

◆ getTwoComponentFitType()

◆ getTwoComponentHadronEnergy()

◆ getTwoComponentSavedChi2()

◆ getTwoComponentTotalEnergy()

◆ hasStatus()