Class to store TOP log likelihoods (output of TOPReconstructor). More...

#include <TOPLikelihood.h>

Inheritance diagram for TOPLikelihood:

Collaboration diagram for TOPLikelihood:

[legend]

Public Member Functions
	TOPLikelihood ()
	default constructor

	TOPLikelihood (int flag, int numPhot, const double logL, const double estPhot, double estBkg)
	full constructor More...

int	getFlag () const
	Return reconstruction flag. More...

int	getNphot () const
	Return number of detected photons. More...

float	getLogL (const Const::ChargedStable &part) const
	Return log likelihood for a given particle. More...

float	getEstPhot (const Const::ChargedStable &part) const
	Return estimated number of photons for a given particle. More...

float	getEstBkg () const
	Return estimated number of background photons. More...

double	getLogL_e () const
	Return electron log likelihood. More...

double	getLogL_mu () const
	Return muon log likelihood. More...

double	getLogL_pi () const
	Return pion log likelihood. More...

double	getLogL_K () const
	Return kaon log likelihood. More...

double	getLogL_p () const
	Return proton log likelihood. More...

double	getNphot_e () const
	Return number of expected photons for electron. More...

double	getNphot_mu () const
	Return number of expected photons for muon. More...

double	getNphot_pi () const
	Return number of expected photons for pion. More...

double	getNphot_K () const
	Return number of expected photons for kaon. More...

double	getNphot_p () const
	Return number of expected photons for proton. 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 (TOPLikelihood, 2)
	ClassDef.

Private Attributes
int	m_flag
	reconstruction flag

int	m_numPhot
	number of photons

float	m_logL [Const::ChargedStable::c_SetSize]
	log likelihoods

float	m_estPhot [Const::ChargedStable::c_SetSize]
	estimated number of photons

float	m_estBkg
	estimated background

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 TOP log likelihoods (output of TOPReconstructor).

relation from Tracks filled in top/modules/TOPReconstruction/src/TOPReconstructorModule.cc

Definition at line 37 of file TOPLikelihood.h.

Constructor & Destructor Documentation

◆ TOPLikelihood()

TOPLikelihood	(	int	flag,
		int	numPhot,
		const double *	logL,
		const double *	estPhot,
		double	estBkg
	)

inline

full constructor

Parameters

flag	reconstruction flag
numPhot	number of detected photons
logL	log likelihoods in the order of Const::ChargedStableSet
estPhot	estimated number of photons in the order of Const::ChargedStableSet
estBkg	estimated number of background photons

Definition at line 58 of file TOPLikelihood.h.

69 {return m_flag;}

70

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 144 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 157 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 172 of file RelationsObject.h.

◆ getEstBkg()

float getEstBkg ( ) const

inline

Return estimated number of background photons.

Returns: estimated background

Definition at line 109 of file TOPLikelihood.h.

◆ getEstPhot()

float getEstPhot ( const Const::ChargedStable & part ) const

inline

Return estimated number of photons for a given particle.

Parameters

part	charged stable particle

Returns: estimated number of photons (signal + background)

Definition at line 100 of file TOPLikelihood.h.

◆ getFlag()

int getFlag ( ) const

inline

Return reconstruction flag.

Returns: reconstruction flag: 1=OK, 0=out of acceptance, -1=inside gap btw. bars

Definition at line 77 of file TOPLikelihood.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 372 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 TrackFitResult, TRGSummary, Track, SoftwareTriggerResult, Particle, RecoTrack, MCParticle, Cluster, and PIDLikelihood.

Definition at line 364 of file RelationsObject.h.

◆ getLogL()

float getLogL ( const Const::ChargedStable & part ) const

inline

Return log likelihood for a given particle.

Parameters

part	charged stable particle

Returns: log likelihood

Definition at line 90 of file TOPLikelihood.h.

◆ getLogL_e()

double getLogL_e ( ) const

inline

Return electron log likelihood.

Returns: electron log likelihood

Definition at line 115 of file TOPLikelihood.h.

◆ getLogL_K()

double getLogL_K ( ) const

inline

Return kaon log likelihood.

Returns: kaon log likelihood

Definition at line 133 of file TOPLikelihood.h.

◆ getLogL_mu()

double getLogL_mu ( ) const

inline

Return muon log likelihood.

Returns: muon log likelihood

Definition at line 121 of file TOPLikelihood.h.

◆ getLogL_p()

double getLogL_p ( ) const

inline

Return proton log likelihood.

Returns: proton log likelihood

Definition at line 139 of file TOPLikelihood.h.

◆ getLogL_pi()

double getLogL_pi ( ) const

inline

Return pion log likelihood.

Returns: pion log likelihood

Definition at line 127 of file TOPLikelihood.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, Particle, and MCParticle.

Definition at line 346 of file RelationsObject.h.

◆ getNphot()

int getNphot ( ) const

inline

Return number of detected photons.

Returns: number of detected photons

Definition at line 83 of file TOPLikelihood.h.

◆ getNphot_e()

double getNphot_e ( ) const

inline

Return number of expected photons for electron.

Returns: number of expected photons for electron

Definition at line 145 of file TOPLikelihood.h.

◆ getNphot_K()

double getNphot_K ( ) const

inline

Return number of expected photons for kaon.

Returns: number of expected photons for kaon

Definition at line 163 of file TOPLikelihood.h.

◆ getNphot_mu()

double getNphot_mu ( ) const

inline

Return number of expected photons for muon.

Returns: number of expected photons for muon

Definition at line 151 of file TOPLikelihood.h.

◆ getNphot_p()

double getNphot_p ( ) const

inline

Return number of expected photons for proton.

Returns: number of expected photons for proton

Definition at line 169 of file TOPLikelihood.h.

◆ getNphot_pi()

double getNphot_pi ( ) const

inline

Return number of expected photons for pion.

Returns: number of expected photons for pion

Definition at line 157 of file TOPLikelihood.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 280 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 265 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 316 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 250 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 299 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 333 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 214 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 199 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 232 of file RelationsObject.h.

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

top/dataobjects/include/TOPLikelihood.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TOPLikelihood()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getEstBkg()

◆ getEstPhot()

◆ getFlag()

◆ getInfo()

◆ getInfoHTML()

◆ getLogL()

◆ getLogL_e()

◆ getLogL_K()

◆ getLogL_mu()

◆ getLogL_p()

◆ getLogL_pi()

◆ getName()

◆ getNphot()

◆ getNphot_e()

◆ getNphot_K()

◆ getNphot_mu()

◆ getNphot_p()

◆ getNphot_pi()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()