Class to store ECL ShaperDSP waveform ADC data and additional information for ML studies. More...

#include <ECLDspWithExtraMCInfo.h>

Inheritance diagram for ECLDspWithExtraMCInfo:

[legend]

Collaboration diagram for ECLDspWithExtraMCInfo:

[legend]

Public Types
enum	TwoComponentFitType { poorChi2 = -1 , photonHadron = 0 , photonHadronBackgroundPhoton = 1 , photonDiodeCrossing = 2 }
	Offline two component fit type. More...

Public Member Functions
void	setEnergyDep (double input)
	Set total true deposited energy.

void	setHadronEnergyDep (double input)
	Set total true deposited hadron energy.

void	setFlightTime (double input)
	Set true flight time (weighted by true deposited energy)

void	setTimeShift (double input)
	Set timeshift (weighted by true deposited energy)

void	setTimeToSensor (double input)
	Set time to sensor (weighted by true deposited energy)

void	setEnergyConversion (double input)
	Set energy conversion factor.

double	getHadronEnergyDep () const
	get true deposited hadron energy More...

double	getEnergyDep () const
	get true deposited energy More...

double	getEnergyConversion () const
	get energy conversion factor More...

double	getFlightTime () const
	get true flight time More...

double	getTimeShift () const
	get time shift More...

double	getTimeToSensor () const
	get time to sensor More...

void	setCellId (int CellId)
	Set Cell ID.

void	setDspA (int DspArray[31])
	Set Dsp array.

void	setDspA (const std::vector< int > &DspArrayVector)
	Set Dsp array.

void	setTwoComponentTotalAmp (double input)
	Set two comp total amp.

void	setTwoComponentHadronAmp (double input)
	Set two comp hadron amp.

void	setTwoComponentDiodeAmp (double input)
	Set two comp diode amp.

void	setTwoComponentChi2 (double input)
	Set two comp chi2.

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

void	setTwoComponentTime (double input)
	Set two comp time.

void	setTwoComponentBaseline (double input)
	Set two comp baseline.

void	setbackgroundPhotonEnergy (double input)
	Set pile-up photon energy.

void	setbackgroundPhotonTime (double input)
	Set pile-up photon time.

void	setTwoComponentFitType (TwoComponentFitType ft)
	Set fit type.

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

void	getDspA (int DspArray[31]) const
	Get Dsp Array. More...

std::vector< int >	getDspA () const
	Get Dsp Array. More...

double	getTwoComponentTotalAmp () const
	get two comp total amp More...

double	getTwoComponentHadronAmp () const
	get two comp hadron amp More...

double	getTwoComponentDiodeAmp () const
	get two comp diode amp More...

double	getTwoComponentChi2 () const
	get two comp chi2 More...

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

double	getTwoComponentTime () const
	get two comp time More...

double	getTwoComponentBaseline () const
	get two comp baseline More...

TwoComponentFitType	getTwoComponentFitType () const
	get two comp fit type More...

double	getbackgroundPhotonEnergy () const
	get pile up photon energy More...

double	getbackgroundPhotonTime () const
	get pile up photon time More...

int	computePeaktoPeakAmp () const
	Compute maximum peak to peak value. More...

int	getNADCPoints () const
	Get number of ADC points. 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.

Static Public Member Functions
static ECLDsp *	getByCellID (int cid)
	Find ECLDsp by Cell ID using linear search. More...

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 (ECLDspWithExtraMCInfo, 1)
	ClassDef.

Private Attributes
double	m_hadronEnergyDep {0}
	True deposited hadron energy.

double	m_energyDep {0}
	True deposited energy.

double	m_energyConversion {0}
	Conversion from energy to ADC.

double	m_flighttime {0}
	True flight time (weighted by true energy)

double	m_timeshift {0}
	Time shift (weighted by true energy)

double	m_timetosensor {0}
	time to sensor (weighted by true energy)

int	m_CellId {0}
	Cell ID.

double	m_TwoComponentTotalAmp { -1}
	Two comp total amp.

double	m_TwoComponentHadronAmp { -1}
	Two comp hadron amp.

double	m_TwoComponentDiodeAmp { -1}
	Two comp diode amp.

double	m_TwoComponentChi2 { -1}
	Two comp chi2.

double	m_TwoComponentSavedChi2 [3] = { -1, -1, -1}
	Two comp chi2 for each fit tried in reconstruction.

double	m_TwoComponentTime {1}
	Two comp time.

double	m_TwoComponentBaseline {1}
	Two comp baseline.

double	m_backgroundPhotonEnergy { -1}
	Pile-up photon energy.

double	m_backgroundPhotonTime { -1}
	Pile-up photon time.

TwoComponentFitType	m_TwoComponentFitType {poorChi2}
	offline fit hypothesis.

std::vector< int >	m_DspAVector
	Dsp array vith variable length for calibration, tests, etc. More...

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 ECL ShaperDSP waveform ADC data and additional information for ML studies.

For MC filled in ecl/modules/eclDigitizer/src/ECLDigitizerModule.cc For data filled in ecl/modules/eclUnpacker/src/eclUnpackerModule.cc

Definition at line 25 of file ECLDspWithExtraMCInfo.h.

Member Enumeration Documentation

◆ TwoComponentFitType

enum TwoComponentFitType

inherited

Offline two component fit type.

Enumerator
poorChi2	All offline fit attempts were greater than chi2 threshold.
photonHadron	photon + hadron template fit
photonHadronBackgroundPhoton	photon + hadron template + pile-up photon fit
photonDiodeCrossing	photon + diode template fit

Definition at line 29 of file ECLDsp.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.

◆ computePeaktoPeakAmp()

int computePeaktoPeakAmp ( ) const

inlineinherited

Compute maximum peak to peak value.

Returns: maximum peak to peak value

Definition at line 194 of file ECLDsp.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.

◆ getbackgroundPhotonEnergy()

double getbackgroundPhotonEnergy ( ) const

inlineinherited

get pile up photon energy

Returns: pile up photon energy

Definition at line 176 of file ECLDsp.h.

◆ getbackgroundPhotonTime()

double getbackgroundPhotonTime ( ) const

inlineinherited

get pile up photon time

Returns: pile up photon time

Definition at line 181 of file ECLDsp.h.

◆ getByCellID()

ECLDsp * getByCellID ( int cid )

staticinherited

Find ECLDsp by Cell ID using linear search.

This is shown to be faster than getRelated(..) method.

Definition at line 14 of file ECLDsp.cc.

◆ getCellId()

int getCellId ( ) const

inlineinherited

Get Cell ID.

Returns: cell ID

Definition at line 116 of file ECLDsp.h.

◆ getDspA() [1/2]

std::vector<int> getDspA ( ) const

inlineinherited

Get Dsp Array.

Returns: Dsp Array of variable length

Definition at line 186 of file ECLDsp.h.

◆ getDspA() [2/2]

void getDspA ( int DspArray[31] ) const

inlineinherited

Get Dsp Array.

Returns: Dsp Array 0~31

Definition at line 121 of file ECLDsp.h.

◆ getEnergyConversion()

double getEnergyConversion ( ) const

inline

get energy conversion factor

Returns: energy conversion factor

Definition at line 64 of file ECLDspWithExtraMCInfo.h.

64 { return m_energyConversion; }

Belle2::ECLDspWithExtraMCInfo::m_energyConversion

double m_energyConversion

Conversion from energy to ADC.

Definition: ECLDspWithExtraMCInfo.h:86

◆ getEnergyDep()

double getEnergyDep ( ) const

inline

get true deposited energy

Returns: true deposited energy

Definition at line 59 of file ECLDspWithExtraMCInfo.h.

◆ getFlightTime()

double getFlightTime ( ) const

inline

get true flight time

Returns: true flight time

Definition at line 69 of file ECLDspWithExtraMCInfo.h.

◆ getHadronEnergyDep()

double getHadronEnergyDep ( ) const

inline

get true deposited hadron energy

Returns: true deposited hadron energy

Definition at line 54 of file ECLDspWithExtraMCInfo.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.

◆ getNADCPoints()

int getNADCPoints ( ) const

inlineinherited

Get number of ADC points.

Returns: number of ADC points

Definition at line 203 of file ECLDsp.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.

◆ getTimeShift()

double getTimeShift ( ) const

inline

get time shift

Returns: time shift

Definition at line 74 of file ECLDspWithExtraMCInfo.h.

◆ getTimeToSensor()

double getTimeToSensor ( ) const

inline

get time to sensor

Returns: time to sensor

Definition at line 79 of file ECLDspWithExtraMCInfo.h.

◆ getTwoComponentBaseline()

double getTwoComponentBaseline ( ) const

inlineinherited

get two comp baseline

Returns: two comp baseline

Definition at line 166 of file ECLDsp.h.

◆ getTwoComponentChi2()

double getTwoComponentChi2 ( ) const

inlineinherited

get two comp chi2

Returns: two comp chi2

Definition at line 146 of file ECLDsp.h.

◆ getTwoComponentDiodeAmp()

double getTwoComponentDiodeAmp ( ) const

inlineinherited

get two comp diode amp

Returns: two comp diode amp

Definition at line 141 of file ECLDsp.h.

◆ getTwoComponentFitType()

TwoComponentFitType getTwoComponentFitType ( ) const

inlineinherited

get two comp fit type

Returns: two comp fit type

Definition at line 171 of file ECLDsp.h.

◆ getTwoComponentHadronAmp()

double getTwoComponentHadronAmp ( ) const

inlineinherited

get two comp hadron amp

Returns: two comp hadron amp

Definition at line 136 of file ECLDsp.h.

◆ getTwoComponentSavedChi2()

double getTwoComponentSavedChi2 ( TwoComponentFitType FitTypeIn ) const

inlineinherited

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 152 of file ECLDsp.h.

◆ getTwoComponentTime()

double getTwoComponentTime ( ) const

inlineinherited

get two comp time

Returns: two comp time

Definition at line 161 of file ECLDsp.h.

◆ getTwoComponentTotalAmp()

double getTwoComponentTotalAmp ( ) const

inlineinherited

get two comp total amp

Returns: two comp total amp

Definition at line 131 of file ECLDsp.h.

Member Data Documentation

◆ m_DspAVector

std::vector<int> m_DspAVector

privateinherited

Dsp array vith variable length for calibration, tests, etc.

Definition at line 227 of file ECLDsp.h.

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

ecl/dataobjects/include/ECLDspWithExtraMCInfo.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ TwoComponentFitType

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ computePeaktoPeakAmp()

◆ copyRelations()

◆ getbackgroundPhotonEnergy()

◆ getbackgroundPhotonTime()

◆ getByCellID()

◆ getCellId()

◆ getDspA() [1/2]

◆ getDspA() [2/2]

◆ getEnergyConversion()

◆ getEnergyDep()

◆ getFlightTime()

◆ getHadronEnergyDep()

◆ getInfo()

◆ getInfoHTML()

◆ getNADCPoints()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getTimeShift()

◆ getTimeToSensor()

◆ getTwoComponentBaseline()

◆ getTwoComponentChi2()

◆ getTwoComponentDiodeAmp()

◆ getTwoComponentFitType()

◆ getTwoComponentHadronAmp()

◆ getTwoComponentSavedChi2()

◆ getTwoComponentTime()

◆ getTwoComponentTotalAmp()

Member Data Documentation

◆ m_DspAVector