This class stores the Flavor Tagger information for a specific method and particle filled in the Flavor Tagger Module. More...

#include <FlavorTaggerInfoMap.h>

Inheritance diagram for FlavorTaggerInfoMap:

[legend]

Collaboration diagram for FlavorTaggerInfoMap:

[legend]

Public Member Functions
	FlavorTaggerInfoMap ()
	Default constructor. More...

void	setTargetTrackLevel (const std::string &category, const Belle2::Track *track)
	SETTERS The setters are expected to fill a map whose element corresponds to the probabilities and tracks of a given category. More...

void	setProbTrackLevel (const std::string &category, float probability)
	Map filler: Set the category name and the corresponding highest target track probability. More...

void	setTargetEventLevel (const std::string &category, const Belle2::Track *track)
	Map filler: Set the category name and the pointer of the track with the highest category probability for the corresponding category in Event Level. More...

void	setProbEventLevel (const std::string &category, float probability)
	Map filler: Set the category name and the highest category probability for the corresponding category in Event Level. More...

void	setQpCategory (const std::string &category, float qr)
	Map filler: Set the category name and the corresponding qr Output, i.e. More...

void	setHasTrueTarget (const std::string &category, float isTrue)
	Map filler: Set the category name and the corresponding MC target truth value. More...

void	setIsTrueCategory (const std::string &category, float isTrue)
	Map filler: Set the category name and the corresponding truth MC value. More...

void	setQrCombined (float qr)
	Saves qr Output of the Combiner. More...

void	setB0Probability (float B0Probability)
	Saves the B0Probability output of the Combiner. More...

void	setB0barProbability (float B0barProbability)
	Saves the B0barProbability output of the Combiner. More...

std::map< std::string, const Belle2::Track * >	getTargetTrackLevel ()
	get map containing the category name and the corresponding pointer to the track with highest target probability in Track Level More...

std::map< std::string, float >	getProbTrackLevel ()
	get map containing the category name and thecorresponding highest target track probability in Track Level More...

std::map< std::string, const Belle2::Track * >	getTargetEventLevel ()
	get map containing the category name and the corresponding pointer to the track with highest category probability in Event Level More...

std::map< std::string, float >	getProbEventLevel ()
	get map containing the category name and the corresponding highest category probability in Event Level More...

std::map< std::string, float >	getQpCategory ()
	get map containing the category name and the corresponding qr Output More...

std::map< std::string, float >	getHasTrueTarget ()
	get map containing the category truth. More...

std::map< std::string, float >	getIsTrueCategory ()
	get map containing the category truth. More...

float	getQrCombined ()
	qr Output of the Combiner. More...

float	getB0Probability ()
	Probability of being a B0. More...

float	getB0barProbability ()
	Probability of being a B0bar. 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 (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

Private Attributes
std::map< std::string, const Belle2::Track * >	m_targetTrackLevel
	map containing the category name and the corresponding pointer to the track with highest target probability in Track Level

std::map< std::string, float >	m_probTrackLevel
	map containing the category name and thecorresponding highest target track probability in Track Level

std::map< std::string, const Belle2::Track * >	m_targetEventLevel
	map containing the category name and the corresponding pointer to the track with highest category probability in Event Level

std::map< std::string, float >	m_probEventLevel
	map containing the category name and the corresponding highest category probability in Event Level

std::map< std::string, float >	m_qpCategory
	map containing the category name and the corresponding qr Output, i.e. More...

std::map< std::string, float >	m_hasTrueTarget
	map containing the category name and a float value which is 1 if the corresponding category has a target or 0 else.

std::map< std::string, float >	m_isTrueCategory
	map containing the category name and a float value which is 1 if the corresponding category tags the MC Flavor correctly or 0 else.

float	m_qrCombined
	qr Output of the Combiner. More...

float	m_B0Probability
	Direct Output of the Combiner: Probability of being a B0.

float	m_B0barProbability
	Direct Output of the Combiner: Probability of being a B0bar).

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

This class stores the Flavor Tagger information for a specific method and particle filled in the Flavor Tagger Module.

The way the information is stored is into maps for each Level: Track, event and Combiner. there are two maps per level: One saving the pointer to the tracks and the other saving the probabilities. Each category has its own key.

Definition at line 48 of file FlavorTaggerInfoMap.h.

Constructor & Destructor Documentation

◆ FlavorTaggerInfoMap()

FlavorTaggerInfoMap ( )

inline

Default constructor.

All private members are set to 0 (all vectors are empty).

Definition at line 56 of file FlavorTaggerInfoMap.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 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.

◆ getB0barProbability()

float getB0barProbability ( )

Probability of being a B0bar.

Output of the FlavorTagger after the complete process.

Returns: B0barProbability

Definition at line 125 of file FlavorTaggerInfoMap.cc.

 {
   return m_B0barProbability;
 }

◆ getB0Probability()

float getB0Probability ( )

Probability of being a B0.

Output of the FlavorTagger after the complete process.

Returns: B0Probability

Definition at line 120 of file FlavorTaggerInfoMap.cc.

◆ getHasTrueTarget()

std::map< std::string, float > getHasTrueTarget ( )

get map containing the category truth.

1 if the Category has a target or 0 else.

Returns: map

Definition at line 105 of file FlavorTaggerInfoMap.cc.

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

◆ getIsTrueCategory()

std::map< std::string, float > getIsTrueCategory ( )

get map containing the category truth.

1 if the Category tags the B0 MC flavor correctly 0 else.

Returns: map

Definition at line 110 of file FlavorTaggerInfoMap.cc.

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

◆ getProbEventLevel()

std::map< std::string, float > getProbEventLevel ( )

get map containing the category name and the corresponding highest category probability in Event Level

Returns: map

Definition at line 95 of file FlavorTaggerInfoMap.cc.

◆ getProbTrackLevel()

std::map< std::string, float > getProbTrackLevel ( )

get map containing the category name and thecorresponding highest target track probability in Track Level

Returns: map

Definition at line 85 of file FlavorTaggerInfoMap.cc.

◆ getQpCategory()

std::map< std::string, float > getQpCategory ( )

get map containing the category name and the corresponding qr Output

Returns: map

Definition at line 100 of file FlavorTaggerInfoMap.cc.

◆ getQrCombined()

float getQrCombined ( )

qr Output of the Combiner.

Output of the FlavorTagger after the complete process.

Returns: qr

Definition at line 115 of file FlavorTaggerInfoMap.cc.

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

◆ getTargetEventLevel()

std::map< std::string, const Belle2::Track * > getTargetEventLevel ( )

get map containing the category name and the corresponding pointer to the track with highest category probability in Event Level

Returns: map

Definition at line 90 of file FlavorTaggerInfoMap.cc.

◆ getTargetTrackLevel()

std::map< std::string, const Belle2::Track * > getTargetTrackLevel ( )

get map containing the category name and the corresponding pointer to the track with highest target probability in Track Level

Returns: map

Definition at line 80 of file FlavorTaggerInfoMap.cc.

◆ setB0barProbability()

void setB0barProbability ( float B0barProbability )

Saves the B0barProbability output of the Combiner.

Parameters

B0barProbability Probability of being a B0bar

Definition at line 71 of file FlavorTaggerInfoMap.cc.

◆ setB0Probability()

void setB0Probability ( float B0Probability )

Saves the B0Probability output of the Combiner.

Parameters

B0Probability probability of being a B0

Definition at line 65 of file FlavorTaggerInfoMap.cc.

◆ setHasTrueTarget()

void setHasTrueTarget	(	const std::string &	category,
		float	isTrue
	)

Map filler: Set the category name and the corresponding MC target truth value.

Parameters

category	string name of the given category
isTrue	output of the given category

Definition at line 49 of file FlavorTaggerInfoMap.cc.

◆ setIsTrueCategory()

void setIsTrueCategory	(	const std::string &	category,
		float	isTrue
	)

Map filler: Set the category name and the corresponding truth MC value.

Parameters

category	string name of the given category
isTrue	output of the given category

Definition at line 54 of file FlavorTaggerInfoMap.cc.

◆ setProbEventLevel()

void setProbEventLevel	(	const std::string &	category,
		float	probability
	)

Map filler: Set the category name and the highest category probability for the corresponding category in Event Level.

Parameters

category	string name of the given category
probability	highest category probability

Definition at line 38 of file FlavorTaggerInfoMap.cc.

◆ setProbTrackLevel()

void setProbTrackLevel	(	const std::string &	category,
		float	probability
	)

Map filler: Set the category name and the corresponding highest target track probability.

Parameters

category	string name of the given category
probability	highest target track probability

Definition at line 26 of file FlavorTaggerInfoMap.cc.

◆ setQpCategory()

void setQpCategory	(	const std::string &	category,
		float	qr
	)

Map filler: Set the category name and the corresponding qr Output, i.e.

the Combiner input value. They could be used for independent tags.

Parameters

category	string name of the given category
qr	output of the given category

Definition at line 44 of file FlavorTaggerInfoMap.cc.

◆ setQrCombined()

void setQrCombined ( float qr )

Saves qr Output of the Combiner.

Output of the FlavorTagger after the complete process.

Parameters

qr	final FlavorTagger output

Definition at line 59 of file FlavorTaggerInfoMap.cc.

◆ setTargetEventLevel()

void setTargetEventLevel	(	const std::string &	category,
		const Belle2::Track *	track
	)

Map filler: Set the category name and the pointer of the track with the highest category probability for the corresponding category in Event Level.

Parameters

category	string name of the given category
track	pointer to track object

Definition at line 32 of file FlavorTaggerInfoMap.cc.

◆ setTargetTrackLevel()

void setTargetTrackLevel	(	const std::string &	category,
		const Belle2::Track *	track
	)

SETTERS The setters are expected to fill a map whose element corresponds to the probabilities and tracks of a given category.

The categories are set by the Flavor Tagger. The setting of all elements need to be performed in a loop. For example, setTargetTrackLevel() need to be called once per each category so that the vector is filled progressively. The same holds for all the other setters described as map fillers. Map filler: Set the category name and the pointer of the track with the highest target track probability for the corresponding category in Event Level.

Parameters

category	string name of the given category
track	pointer to track object

Definition at line 20 of file FlavorTaggerInfoMap.cc.

Member Data Documentation

◆ m_qpCategory

std::map<std::string, float> m_qpCategory

private

map containing the category name and the corresponding qr Output, i.e.

the Combiner input value. They could be used for independent tags.

Definition at line 228 of file FlavorTaggerInfoMap.h.

◆ m_qrCombined

float m_qrCombined

private

qr Output of the Combiner.

Output of the FlavorTagger after the complete process

Definition at line 234 of file FlavorTaggerInfoMap.h.

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

analysis/dataobjects/include/FlavorTaggerInfoMap.h
analysis/dataobjects/src/FlavorTaggerInfoMap.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FlavorTaggerInfoMap()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getB0barProbability()

◆ getB0Probability()

◆ getHasTrueTarget()

◆ getInfo()

◆ getInfoHTML()

◆ getIsTrueCategory()

◆ getName()

◆ getProbEventLevel()

◆ getProbTrackLevel()

◆ getQpCategory()

◆ getQrCombined()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getTargetEventLevel()

◆ getTargetTrackLevel()

◆ setB0barProbability()

◆ setB0Probability()

◆ setHasTrueTarget()

◆ setIsTrueCategory()

◆ setProbEventLevel()

◆ setProbTrackLevel()

◆ setQpCategory()

◆ setQrCombined()

◆ setTargetEventLevel()

◆ setTargetTrackLevel()

Member Data Documentation

◆ m_qpCategory

◆ m_qrCombined