Class to store the result of the TOP LL scan (output of TOPLLScanner). More...

#include <TOPLikelihoodScanResult.h>

Inheritance diagram for TOPLikelihoodScanResult:

Collaboration diagram for TOPLikelihoodScanResult:

[legend]

Public Member Functions
	TOPLikelihoodScanResult ()
	default constructor

void	set (float mostLikelyMass, float mostLikelyMassIntervalLow, float mostLikelyMassIntervalUp, float threshold, float mostLikelySignalPhotonCount, float mostLikelyBackgroundPhotonCount, float mostLikelyDeltaPhotonCount, const std::vector< float > &coarseScanMassPoints, const std::vector< float > &fineScanMassPoints, const std::vector< float > &coarseScanLLValues, const std::vector< float > &fineScanLLValues, const std::vector< float > &coarseScanExpectedPhotons, const std::vector< float > &fineScanExpectedPhotons)
	Sets other data members for a given particle hypothesis.

float	getMostLikelyMass () const
	Return the most likely mass form the scan. More...

float	getMostLikelyMassIntervalLow () const
	Return the lower limit of the mass interval. More...

float	getMostLikelyMassIntervalUp () const
	Return the upper limit of the mass interval. More...

float	getThreshold () const
	Return the position of the Cherenkov threshold from the LL scan. More...

float	getMostLikelySignalPhotonCount () const
	Return the number of expected photons at the LL maximum. More...

float	getMostLikelyBackgroundPhotonCount () const
	Return the number of expected photons at the LL maximum. More...

float	getMostLikelyDeltaPhotonCount () const
	Return the number of expected photons at the LL maximum. More...

std::vector< float >	getCoarseScanMassPoints () const
	Return a std::vector containing the mass points used for the coarse LL scane. More...

std::vector< float >	getFineScanMassPoints () const
	Return a std::vector containing the mass points used for the fine LL scane. More...

std::vector< float >	getCoarseScanLLValues () const
	Return a std::vector containing the LL values of the coarse scan. More...

std::vector< float >	getFineScanLLValues () const
	Return a std::vector containing the LL values of the fine scan. More...

std::vector< float >	getCoarseScanExpectedPhotons () const
	Return a std::vector containing the number of expected photons of the coarse scan. More...

std::vector< float >	getFineScanExpectedPhotons () const
	Return a std::vector containing the number of expected photons of the fine scan. 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 (TOPLikelihoodScanResult, 1)
	ClassDef.

Private Attributes
float	m_mostLikelyMass = 0
	mass that maximizes the LL

float	m_mostLikelyMassIntervalLow = 0
	lower edge of the mass interval from the LL

float	m_mostLikelyMassIntervalUp = 0
	upper edge of the mass interval from the LL

float	m_threshold = 0
	location of the Chrerenkov threshold from the LL scan

float	m_mostLikelySignalPhotonCount = 0
	Expected number of signal photons at the LL max.

float	m_mostLikelyBackgroundPhotonCount = 0
	Expected number of background photons at the LL max.

float	m_mostLikelyDeltaPhotonCount = 0
	Expected number of delta rays photons at the LL max.

std::vector< float >	m_coarseScanMassPoints
	mass points used in the coarse scan

std::vector< float >	m_fineScanMassPoints
	mass points used in the fine scan

std::vector< float >	m_coarseScanLLValues
	LL values of the coarse scan.

std::vector< float >	m_fineScanLLValues
	LL values of the fine scan.

std::vector< float >	m_coarseScanExpectedPhotons
	expected signal photons from the coarse scan

std::vector< float >	m_fineScanExpectedPhotons
	expected signal photons from the fine scan

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 the result of the TOP LL scan (output of TOPLLScanner).

Definition at line 24 of file TOPLikelihoodScanResult.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.

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

◆ getCoarseScanExpectedPhotons()

std::vector<float> getCoarseScanExpectedPhotons ( ) const

inline

Return a std::vector containing the number of expected photons of the coarse scan.

Returns: coarseScanExpectedPhotons the scan points

Definition at line 141 of file TOPLikelihoodScanResult.h.

141 {return m_coarseScanExpectedPhotons;}

Belle2::TOPLikelihoodScanResult::m_coarseScanExpectedPhotons

std::vector< float > m_coarseScanExpectedPhotons

expected signal photons from the coarse scan

Definition: TOPLikelihoodScanResult.h:165

◆ getCoarseScanLLValues()

std::vector<float> getCoarseScanLLValues ( ) const

inline

Return a std::vector containing the LL values of the coarse scan.

Returns: coarseScanLLValues the scan points

Definition at line 129 of file TOPLikelihoodScanResult.h.

◆ getCoarseScanMassPoints()

std::vector<float> getCoarseScanMassPoints ( ) const

inline

Return a std::vector containing the mass points used for the coarse LL scane.

Returns: coarseScanMassPoints the scan points

Definition at line 116 of file TOPLikelihoodScanResult.h.

◆ getFineScanExpectedPhotons()

std::vector<float> getFineScanExpectedPhotons ( ) const

inline

Return a std::vector containing the number of expected photons of the fine scan.

Returns: fineScanExpectedPhotons the scan points

Definition at line 147 of file TOPLikelihoodScanResult.h.

◆ getFineScanLLValues()

std::vector<float> getFineScanLLValues ( ) const

inline

Return a std::vector containing the LL values of the fine scan.

Returns: fineScanLLValues the scan points

Definition at line 135 of file TOPLikelihoodScanResult.h.

◆ getFineScanMassPoints()

std::vector<float> getFineScanMassPoints ( ) const

inline

Return a std::vector containing the mass points used for the fine LL scane.

Returns: fineScanMassPoints the scan points

Definition at line 122 of file TOPLikelihoodScanResult.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.

◆ getMostLikelyBackgroundPhotonCount()

float getMostLikelyBackgroundPhotonCount ( ) const

inline

Return the number of expected photons at the LL maximum.

Returns: mostLikelyPhotonCount the expected number of photons at the LL maximum

Definition at line 102 of file TOPLikelihoodScanResult.h.

◆ getMostLikelyDeltaPhotonCount()

float getMostLikelyDeltaPhotonCount ( ) const

inline

Return the number of expected photons at the LL maximum.

Returns: mostLikelyPhotonCount the expected number of photons at the LL maximum

Definition at line 109 of file TOPLikelihoodScanResult.h.

◆ getMostLikelyMass()

float getMostLikelyMass ( ) const

inline

Return the most likely mass form the scan.

Returns: mostLikelyMass the location of the LL scan maximum

Definition at line 70 of file TOPLikelihoodScanResult.h.

◆ getMostLikelyMassIntervalLow()

float getMostLikelyMassIntervalLow ( ) const

inline

Return the lower limit of the mass interval.

Returns: mostLikelyMass the location of the LL scan maximum

Definition at line 76 of file TOPLikelihoodScanResult.h.

◆ getMostLikelyMassIntervalUp()

float getMostLikelyMassIntervalUp ( ) const

inline

Return the upper limit of the mass interval.

Returns: mostLikelyMass the location of the LL scan maximum

Definition at line 82 of file TOPLikelihoodScanResult.h.

◆ getMostLikelySignalPhotonCount()

float getMostLikelySignalPhotonCount ( ) const

inline

Return the number of expected photons at the LL maximum.

Returns: mostLikelyPhotonCount the expected number of photons at the LL maximum

Definition at line 95 of file TOPLikelihoodScanResult.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.

◆ getThreshold()

float getThreshold ( ) const

inline

Return the position of the Cherenkov threshold from the LL scan.

Returns: threshold the Cherenkov threshold

Definition at line 88 of file TOPLikelihoodScanResult.h.

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

top/dataobjects/include/TOPLikelihoodScanResult.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getCoarseScanExpectedPhotons()

◆ getCoarseScanLLValues()

◆ getCoarseScanMassPoints()

◆ getFineScanExpectedPhotons()

◆ getFineScanLLValues()

◆ getFineScanMassPoints()

◆ getInfo()

◆ getInfoHTML()

◆ getMostLikelyBackgroundPhotonCount()

◆ getMostLikelyDeltaPhotonCount()

◆ getMostLikelyMass()

◆ getMostLikelyMassIntervalLow()

◆ getMostLikelyMassIntervalUp()

◆ getMostLikelySignalPhotonCount()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getThreshold()