Class to store pixel-by-pixel likelihoods for a track relation from Tracks filled in top/modules/TOPPDFDebugger/src/TOPPDFDebuggerModule.cc. More...

#include <TOPPixelLikelihood.h>

Inheritance diagram for TOPPixelLikelihood:

[legend]

Collaboration diagram for TOPPixelLikelihood:

[legend]

Public Types
typedef std::array< float, 512 >	PixelArray_t
	Array of length 512 to hold per-pixel information.

Public Member Functions
	TOPPixelLikelihood ()
	Default constructor.

bool	addHypothesisLikelihoods (const PixelArray_t &plkhs, const int hypothesis)
	Adds the likelihood array for the given hypothesis (PDG code) More...

bool	addHypothesisSignalPhotons (const PixelArray_t &sfots, const int hypothesis)
	Adds the signal photon array for the given hypothesis (PDG code) More...

const PixelArray_t &	getHypothesisLikelihoods (const int hypothesis) const
	Returns the pixel likelihoods for the given hypothesis (PDG code) More...

const PixelArray_t &	getHypothesisSignalPhotons (const int hypothesis) const
	Returns the pixel signal photons for the given hypothesis (PDG code) More...

const PixelArray_t &	getPixelLogL_e () const
	Returns the pixel likelihoods for the electron hypothesis. More...

const PixelArray_t &	getPixelLogL_mu () const
	Returns the pixel likelihoods for the muon hypothesis. More...

const PixelArray_t &	getPixelLogL_pi () const
	Returns the pixel likelihoods for the pion hypothesis. More...

const PixelArray_t &	getPixelLogL_K () const
	Returns the pixel likelihoods for the kaon hypothesis. More...

const PixelArray_t &	getPixelLogL_p () const
	Returns the pixel likelihoods for the proton hypothesis. More...

const PixelArray_t &	getPixelSigPhot_e () const
	Returns the pixel signal photons for the electron hypothesis. More...

const PixelArray_t &	getPixelSigPhot_mu () const
	Returns the pixel signal photons for the muon hypothesis. More...

const PixelArray_t &	getPixelSigPhot_pi () const
	Returns the pixel signal photons for the pion hypothesis. More...

const PixelArray_t &	getPixelSigPhot_K () const
	Returns the pixel signal photons for the kaon hypothesis. More...

const PixelArray_t &	getPixelSigPhot_p () const
	Returns the pixel signal photons for the proton hypothesis. More...

void	setModuleID (int moduleID)
	Sets module ID of the associated exthit. More...

int	getModuleID () const
	Returns module ID of the associated exthit.

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 (TOPPixelLikelihood, 3)
	ClassDef.

Private Attributes
std::map< int, PixelArray_t >	m_logls
	pixel likelihoods for different hypotheses

std::map< int, PixelArray_t >	m_sfots
	pixel sigphot counts for different hypotheses

int	m_moduleID = 0
	slot ID of the exthit

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 pixel-by-pixel likelihoods for a track relation from Tracks filled in top/modules/TOPPDFDebugger/src/TOPPDFDebuggerModule.cc.

Definition at line 32 of file TOPPixelLikelihood.h.

Member Function Documentation

◆ addHypothesisLikelihoods()

bool addHypothesisLikelihoods	(	const PixelArray_t &	plkhs,
		const int	hypothesis
	)

inline

Adds the likelihood array for the given hypothesis (PDG code)

Parameters

plkhs	array of pixel likelihoods
hypothesis	PDG code of hypothesis

Definition at line 51 of file TOPPixelLikelihood.h.

     {
       auto result = m_logls.insert(std::make_pair(hypothesis, plkhs));
       if (not result.second) {
         B2WARNING("Likelihoods already exist for this track");
       }
       return result.second;
     }

◆ addHypothesisSignalPhotons()

bool addHypothesisSignalPhotons	(	const PixelArray_t &	sfots,
		const int	hypothesis
	)

inline

Adds the signal photon array for the given hypothesis (PDG code)

Parameters

sfots	array of per-pixel expected signal photon counts
hypothesis	PDG code of hypothesis

Definition at line 65 of file TOPPixelLikelihood.h.

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

◆ getHypothesisLikelihoods()

const PixelArray_t& getHypothesisLikelihoods ( const int hypothesis ) const

inline

Returns the pixel likelihoods for the given hypothesis (PDG code)

Parameters

hypothesis PDG code of desired hypothesis

Returns: array of pixel log likelihoods

Definition at line 79 of file TOPPixelLikelihood.h.

◆ getHypothesisSignalPhotons()

const PixelArray_t& getHypothesisSignalPhotons ( const int hypothesis ) const

inline

Returns the pixel signal photons for the given hypothesis (PDG code)

Parameters

hypothesis PDG code of desire hypothesis

Returns: array of per-pixel expected signal photon counts

Definition at line 89 of file TOPPixelLikelihood.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.

◆ getPixelLogL_e()

const PixelArray_t& getPixelLogL_e ( ) const

inline

Returns the pixel likelihoods for the electron hypothesis.

Returns: array of pixel log likelihoods

Definition at line 98 of file TOPPixelLikelihood.h.

◆ getPixelLogL_K()

const PixelArray_t& getPixelLogL_K ( ) const

inline

Returns the pixel likelihoods for the kaon hypothesis.

Returns: array of pixel log likelihoods

Definition at line 116 of file TOPPixelLikelihood.h.

◆ getPixelLogL_mu()

const PixelArray_t& getPixelLogL_mu ( ) const

inline

Returns the pixel likelihoods for the muon hypothesis.

Returns: array of pixel log likelihoods

Definition at line 104 of file TOPPixelLikelihood.h.

◆ getPixelLogL_p()

const PixelArray_t& getPixelLogL_p ( ) const

inline

Returns the pixel likelihoods for the proton hypothesis.

Returns: array of pixel log likelihoods

Definition at line 122 of file TOPPixelLikelihood.h.

◆ getPixelLogL_pi()

const PixelArray_t& getPixelLogL_pi ( ) const

inline

Returns the pixel likelihoods for the pion hypothesis.

Returns: array of pixel log likelihoods

Definition at line 110 of file TOPPixelLikelihood.h.

◆ getPixelSigPhot_e()

const PixelArray_t& getPixelSigPhot_e ( ) const

inline

Returns the pixel signal photons for the electron hypothesis.

Returns: array of per-pixel expected signal photon counts

Definition at line 128 of file TOPPixelLikelihood.h.

◆ getPixelSigPhot_K()

const PixelArray_t& getPixelSigPhot_K ( ) const

inline

Returns the pixel signal photons for the kaon hypothesis.

Returns: array of per-pixel expected signal photon counts

Definition at line 146 of file TOPPixelLikelihood.h.

◆ getPixelSigPhot_mu()

const PixelArray_t& getPixelSigPhot_mu ( ) const

inline

Returns the pixel signal photons for the muon hypothesis.

Returns: array of per-pixel expected signal photon counts

Definition at line 134 of file TOPPixelLikelihood.h.

◆ getPixelSigPhot_p()

const PixelArray_t& getPixelSigPhot_p ( ) const

inline

Returns the pixel signal photons for the proton hypothesis.

Returns: array of per-pixel expected signal photon counts

Definition at line 152 of file TOPPixelLikelihood.h.

◆ getPixelSigPhot_pi()

const PixelArray_t& getPixelSigPhot_pi ( ) const

inline

Returns the pixel signal photons for the pion hypothesis.

Returns: array of per-pixel expected signal photon counts

Definition at line 140 of file TOPPixelLikelihood.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.

◆ setModuleID()

void setModuleID ( int moduleID )

inline

Sets module ID of the associated exthit.

Parameters

moduleID the module ID of associated exthit

Definition at line 158 of file TOPPixelLikelihood.h.

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

top/dataobjects/include/TOPPixelLikelihood.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addHypothesisLikelihoods()

◆ addHypothesisSignalPhotons()

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getHypothesisLikelihoods()

◆ getHypothesisSignalPhotons()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getPixelLogL_e()

◆ getPixelLogL_K()

◆ getPixelLogL_mu()

◆ getPixelLogL_p()

◆ getPixelLogL_pi()

◆ getPixelSigPhot_e()

◆ getPixelSigPhot_K()

◆ getPixelSigPhot_mu()

◆ getPixelSigPhot_p()

◆ getPixelSigPhot_pi()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ setModuleID()