Class to store energy information for ECL hits closest to a track. More...

#include <ECLEnergyCloseToTrack.h>

Inheritance diagram for ECLEnergyCloseToTrack:

Collaboration diagram for ECLEnergyCloseToTrack:

[legend]

Public Member Functions
	ECLEnergyCloseToTrack ()
	Default constructor.

void	setEnergy3FWDBarrel (float energy3low)
	Set m_energy3FWDBarrel.

float	getEnergy3FWDBarrel () const
	Get m_energy3FWDBarrel.

void	setEnergy3FWDEndcap (float energy3high)
	Set m_energy3FWDEndcap.

float	getEnergy3FWDEndcap () const
	Get m_energy3FWDEndcap.

void	setEnergy3BWDBarrel (float energy3low)
	Set m_energy3FWDBarrel.

float	getEnergy3BWDBarrel () const
	Get m_energy3BFWDBarrel.

void	setEnergy3BWDEndcap (float energy3high)
	Set m_energy3BWDEndcap.

float	getEnergy3BWDEndcap () const
	Get m_energy3BWDEndcap.

void	setExtTheta (float theta)
	Set m_extTheta.

float	getExtTheta () const
	Get m_extTheta.

void	setExtPhi (float phi)
	Set m_extPhi.

float	getExtPhi () const
	Get m_extPhi.

void	setExtPhiId (float phi)
	Set m_extPhiId.

float	getExtPhiId () const
	Get m_extPhiId.

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

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

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

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.

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.

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.

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

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

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.

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.

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.

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.

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

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

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

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 (ECLEnergyCloseToTrack, 1)
	class definition

Private Attributes
float	m_energy3FWDBarrel
	energy sum of the three ECLCalDigits on the barrel side, FWD

float	m_energy3FWDEndcap
	energy sum of the three ECLCalDigits on the endcap side, FWD

float	m_energy3BWDBarrel
	energy sum of the three ECLCalDigits on the barrel side, BWD

float	m_energy3BWDEndcap
	energy sum of the three ECLCalDigits on the endcap side, BWD

float	m_extTheta
	track extrapolation theta

float	m_extPhi
	track extrapolation phi

float	m_extPhiId
	track extrapolation phi id

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 energy information for ECL hits closest to a track.

Definition at line 20 of file ECLEnergyCloseToTrack.h.

Constructor & Destructor Documentation

◆ ECLEnergyCloseToTrack()

ECLEnergyCloseToTrack ( )

inline

Default constructor.

Definition at line 27 of file ECLEnergyCloseToTrack.h.

                            :
      m_energy3FWDBarrel(0.0),
      m_energy3FWDEndcap(0.0),
      m_energy3BWDBarrel(0.0),
      m_energy3BWDEndcap(0.0),
      m_extTheta(-999.),
      m_extPhi(-999.),
      m_extPhiId(-1)
    {}

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.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

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

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

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

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

◆ getArrayIndex()

int getArrayIndex ( ) const

inlineinherited

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

Definition at line 385 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

◆ getArrayName()

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

◆ getArrayPointer()

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

◆ getEnergy3BWDBarrel()

float getEnergy3BWDBarrel ( ) const

inline

Get m_energy3BFWDBarrel.

Definition at line 53 of file ECLEnergyCloseToTrack.h.

53{return m_energy3BWDBarrel;}

◆ getEnergy3BWDEndcap()

float getEnergy3BWDEndcap ( ) const

inline

Get m_energy3BWDEndcap.

Definition at line 59 of file ECLEnergyCloseToTrack.h.

59{return m_energy3BWDEndcap;}

◆ getEnergy3FWDBarrel()

float getEnergy3FWDBarrel ( ) const

inline

Get m_energy3FWDBarrel.

Definition at line 41 of file ECLEnergyCloseToTrack.h.

41{return m_energy3FWDBarrel;}

◆ getEnergy3FWDEndcap()

float getEnergy3FWDEndcap ( ) const

inline

Get m_energy3FWDEndcap.

Definition at line 47 of file ECLEnergyCloseToTrack.h.

47{return m_energy3FWDEndcap;}

◆ getExtPhi()

float getExtPhi ( ) const

inline

Get m_extPhi.

Definition at line 71 of file ECLEnergyCloseToTrack.h.

71{return m_extPhi;}

◆ getExtPhiId()

float getExtPhiId ( ) const

inline

Get m_extPhiId.

Definition at line 77 of file ECLEnergyCloseToTrack.h.

77{return m_extPhiId;}

◆ getExtTheta()

float getExtTheta ( ) const

inline

Get m_extTheta.

Definition at line 65 of file ECLEnergyCloseToTrack.h.

65{return m_extTheta;}

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

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

◆ 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 Particle, Cluster, MCParticle, PIDLikelihood, SoftwareTriggerResult, Track, TrackFitResult, and TRGSummary.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in Particle, and MCParticle.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

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

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

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

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

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

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

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

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

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

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

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

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

◆ setEnergy3BWDBarrel()

void setEnergy3BWDBarrel ( float energy3low )

inline

Set m_energy3FWDBarrel.

Definition at line 50 of file ECLEnergyCloseToTrack.h.

50{m_energy3BWDBarrel = energy3low;}

◆ setEnergy3BWDEndcap()

void setEnergy3BWDEndcap ( float energy3high )

inline

Set m_energy3BWDEndcap.

Definition at line 56 of file ECLEnergyCloseToTrack.h.

56{m_energy3BWDEndcap = energy3high;}

◆ setEnergy3FWDBarrel()

void setEnergy3FWDBarrel ( float energy3low )

inline

Set m_energy3FWDBarrel.

Definition at line 38 of file ECLEnergyCloseToTrack.h.

38{m_energy3FWDBarrel = energy3low;}

◆ setEnergy3FWDEndcap()

void setEnergy3FWDEndcap ( float energy3high )

inline

Set m_energy3FWDEndcap.

Definition at line 44 of file ECLEnergyCloseToTrack.h.

44{m_energy3FWDEndcap = energy3high;}

◆ setExtPhi()

void setExtPhi ( float phi )

inline

Set m_extPhi.

Definition at line 68 of file ECLEnergyCloseToTrack.h.

68{m_extPhi = phi;}

◆ setExtPhiId()

void setExtPhiId ( float phi )

inline

Set m_extPhiId.

Definition at line 74 of file ECLEnergyCloseToTrack.h.

74{m_extPhiId = phi;}

◆ setExtTheta()

void setExtTheta ( float theta )

inline

Set m_extTheta.

Definition at line 62 of file ECLEnergyCloseToTrack.h.

62{m_extTheta = theta;}

Member Data Documentation

◆ m_cacheArrayIndex

int m_cacheArrayIndex

mutableprivateinherited

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

Definition at line 432 of file RelationsObject.h.

◆ m_cacheDataStoreEntry

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

◆ m_energy3BWDBarrel

float m_energy3BWDBarrel

private

energy sum of the three ECLCalDigits on the barrel side, BWD

Definition at line 82 of file ECLEnergyCloseToTrack.h.

◆ m_energy3BWDEndcap

float m_energy3BWDEndcap

private

energy sum of the three ECLCalDigits on the endcap side, BWD

Definition at line 83 of file ECLEnergyCloseToTrack.h.

◆ m_energy3FWDBarrel

float m_energy3FWDBarrel

private

energy sum of the three ECLCalDigits on the barrel side, FWD

Definition at line 80 of file ECLEnergyCloseToTrack.h.

◆ m_energy3FWDEndcap

float m_energy3FWDEndcap

private

energy sum of the three ECLCalDigits on the endcap side, FWD

Definition at line 81 of file ECLEnergyCloseToTrack.h.

◆ m_extPhi

float m_extPhi

private

track extrapolation phi

Definition at line 85 of file ECLEnergyCloseToTrack.h.

◆ m_extPhiId

float m_extPhiId

private

track extrapolation phi id

Definition at line 86 of file ECLEnergyCloseToTrack.h.

◆ m_extTheta

float m_extTheta

private

track extrapolation theta

Definition at line 84 of file ECLEnergyCloseToTrack.h.

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

analysis/dataobjects/include/ECLEnergyCloseToTrack.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ECLEnergyCloseToTrack()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getEnergy3BWDBarrel()

◆ getEnergy3BWDEndcap()

◆ getEnergy3FWDBarrel()

◆ getEnergy3FWDEndcap()

◆ getExtPhi()

◆ getExtPhiId()

◆ getExtTheta()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ setEnergy3BWDBarrel()

◆ setEnergy3BWDEndcap()

◆ setEnergy3FWDBarrel()

◆ setEnergy3FWDEndcap()

◆ setExtPhi()

◆ setExtPhiId()

◆ setExtTheta()

Member Data Documentation

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_energy3BWDBarrel

◆ m_energy3BWDEndcap

◆ m_energy3FWDBarrel

◆ m_energy3FWDEndcap

◆ m_extPhi

◆ m_extPhiId

◆ m_extTheta