Class to collect log likelihoods from TOP, ARICH, dEdx, ECL and KLM aimed for output to mdst includes functions to return combined likelihood probability. More...

#include <PIDLikelihood.h>

Inheritance diagram for PIDLikelihood:

Public Member Functions
	PIDLikelihood ()
	Default constructor: log likelihoods and flags set to 0.

void	setLogLikelihood (Const::EDetector det, const Const::ChargedStable &part, float logl)
	Set log likelihood for a given detector and particle.

void	subtractMaximum ()
	Subtract the maximum of log likelihoods of each detector component in order to reduce the range of values.

bool	isAvailable (Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Check whether PID information is available for at least one of the detectors in a given set.

bool	areAllAvailable (Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Check whether PID information is available for all detectors in a given set.

float	getLogL (const Const::ChargedStable &part, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Return log likelihood for a given detector set and particle.

float	getDeltaLogL (const Const::ChargedStable &p1, const Const::ChargedStable &p2, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Return log likelihood difference between two particles for a given detector set.

double	getProbability (const Const::ChargedStable &p1, const Const::ChargedStable &p2, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Return combined likelihood probability for a particle being p1 and not p2, assuming equal prior probabilities.

double	getProbability (const Const::ChargedStable &p1, const Const::ChargedStable &p2, double ratio, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Return combined likelihood probability for a particle being p1 and not p2.

double	getProbability (const Const::ChargedStable &part, const double *fractions=nullptr, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Return combined likelihood probability for a particle according to chargedStableSet; if prior fractions not given equal prior probabilities assumed.

double	getLogarithmicProbability (const Const::ChargedStable &part, const double *fractions=nullptr, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Return logarithmic equivalent of likelihood probability defined as log(p/(1-p)), where p is the combined likelihood probability of a particle according to chargedStableSet.

Const::ChargedStable	getMostLikely (const double *fractions=nullptr, Const::PIDDetectorSet set=Const::PIDDetectorSet::set()) const
	Return most likely particle among chargedStableSet; if prior fractions not given equal prior probabilities assumed.

void	printArray () const
	Prints the content of a private array of log likelihoods.

std::string	getInfoHTML () const override
	Return HTML Info of PID Likelihoods.

void	addPreOfficialLikelihood (const std::string &preOfficialIdentifier, const double preOfficialLikelihood)
	Add the pre-official likelihood.

double	getPreOfficialLikelihood (const std::string &preOfficialIdentifier) const
	Get the pre-official likelihood.

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.

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
void	probability (double probabilities[], const double *fractions, Const::PIDDetectorSet detSet) const
	Calculate likelihood probabilities.

	ClassDefOverride (PIDLikelihood, 4)
	Collect log likelihoods from TOP, ARICH, dEdx, ECL and KLM.

	ClassDef (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

Private Attributes
Const::DetectorSet	m_detectors
	set of detectors with PID information

float	m_logl [Const::PIDDetectors::c_size][Const::ChargedStable::c_SetSize]
	log likelihoods

std::map< std::string, double >	m_preOfficialLikelihoods
	Internal storage of pre-official likelihood.

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 collect log likelihoods from TOP, ARICH, dEdx, ECL and KLM aimed for output to mdst includes functions to return combined likelihood probability.

Definition at line 29 of file PIDLikelihood.h.

Constructor & Destructor Documentation

◆ PIDLikelihood()

PIDLikelihood ( )

Default constructor: log likelihoods and flags set to 0.

Definition at line 25 of file PIDLikelihood.cc.

{
  for (unsigned short i = 0; i < Const::PIDDetectors::c_size; i++) {
    for (unsigned int k = 0; k < Const::ChargedStable::c_SetSize; k++) {
      m_logl[i][k] = 0.0;
    }
  }
}

Member Function Documentation

◆ addPreOfficialLikelihood()

void addPreOfficialLikelihood	(	const std::string &	preOfficialIdentifier,
		const double	preOfficialLikelihood
	)

Add the pre-official likelihood.

Parameters

preOfficialIdentifier	Name of the pre-official likelihood
preOfficialLikelihood	Value of the pre-official likelihood

Definition at line 329 of file PIDLikelihood.cc.

{
  m_preOfficialLikelihoods[preOfficialIdentifier] = preOfficialLikelihood;
}

◆ 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);
    }

◆ areAllAvailable()

bool areAllAvailable ( Const::PIDDetectorSet set = Const::PIDDetectorSet::set() ) const

inline

Check whether PID information is available for all detectors in a given set.

Was named isAvailable in release-8 or older.

Parameters

set	a set of PID detectors

Returns: true if all detectors in the set provide likelihoods

Definition at line 68 of file PIDLikelihood.h.

    {
      return  m_detectors.contains(set);
    }

◆ 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();
    }

◆ getDeltaLogL()

float getDeltaLogL	(	const Const::ChargedStable &	p1,
		const Const::ChargedStable &	p2,
		Const::PIDDetectorSet	set = `Const::PIDDetectorSet::set()`
	)		const

inline

Return log likelihood difference between two particles for a given detector set.

Parameters

p1	charged stable particle
p2	charged stable particle
set	a set of PID detectors to use

Returns: log likelihood difference between p1 and p2: logL(p1) - logL(p2)

Definition at line 89 of file PIDLikelihood.h.

    {
      return getLogL(p1, set) - getLogL(p2, set);
    }

◆ 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()

std::string getInfoHTML ( ) const

overridevirtual

Return HTML Info of PID Likelihoods.

Reimplemented from RelationsInterface< BASE >.

Definition at line 266 of file PIDLikelihood.cc.

{
  const string detectorName[Const::PIDDetectors::c_size] = {"SVD", "CDC", "TOP", "ARICH", "ECL", "KLM"};
 
  std::stringstream stream;
  stream << std::setprecision(4);
 
  //colors from event display
  std::string colour[Const::ChargedStable::c_SetSize];
  colour[0] = gROOT->GetColor(kAzure)->AsHexString();
  colour[1] = gROOT->GetColor(kCyan + 1)->AsHexString();
  colour[2] = gROOT->GetColor(kGray + 1)->AsHexString();
  colour[3] = gROOT->GetColor(kRed + 1)->AsHexString();
  colour[4] = gROOT->GetColor(kOrange - 2)->AsHexString();
  colour[5] = gROOT->GetColor(kMagenta)->AsHexString();
 
  stream << "<b>Probabilities</b><br>";
  stream << "<table border=0 width=100%>";
  stream << "<tr><td>All</td><td>";
  stream << "<table cellspacing=1 border=0 width=100%><tr>";
  for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++) {
    double p = getProbability(Const::chargedStableSet.at(i));
    stream << "<td bgcolor=\"" << colour[i] << "\" width=" << p * 100 << "%></td>";
  }
  stream << "</tr></table></td></tr>";
 
  for (Const::DetectorSet::Iterator it = Const::PIDDetectorSet::set().begin();
       it != Const::PIDDetectorSet::set().end(); ++it) {
    auto det = *it;
    stream << "<tr><td>" << detectorName[it.getIndex()] << "</td><td>";
    if (!isAvailable(det)) {
      stream << "</td></tr>";
      continue;
    }
    stream << "<table cellspacing=1 border=0 width=100%><tr>";
    for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++) {
      double p = getProbability(Const::chargedStableSet.at(i), 0, det);
      stream << "<td bgcolor=\"" << colour[i] << "\" width=" << p * 100 << "%></td>";
    }
    stream << "</tr></table></td></tr>";
  }
  stream << "</table>\n";
 
  stream << "<b>Log-Likelihoods</b><br>";
  stream << "<table>";
  stream << "<tr><th>PID / Detector</th>";
  for (unsigned k = 0; k < Const::PIDDetectors::c_size; k++)
    stream << "<th>" << detectorName[k] << "</th>";
  stream << "</tr>";
  for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++) {
    stream << "<tr>";
    stream << "<td bgcolor=\"" << colour[i] << "\">" << Const::chargedStableSet.at(i).getParticlePDG()->GetName() << "</td>";
    for (unsigned k = 0; k < Const::PIDDetectors::c_size; k++) {
      stream << "<td>" << m_logl[k][i] << "</td>";
    }
    stream << "</tr>";
  }
  stream << "</table>";
  stream << "<br>";
 
  return stream.str();
}

◆ getLogarithmicProbability()

double getLogarithmicProbability	(	const Const::ChargedStable &	part,
		const double *	fractions = `nullptr`,
		Const::PIDDetectorSet	set = `Const::PIDDetectorSet::set()`
	)		const

Return logarithmic equivalent of likelihood probability defined as log(p/(1-p)), where p is the combined likelihood probability of a particle according to chargedStableSet.

This one gives a smooth peak-like distribution (opposite to probability distribution which has spikes at 0 and 1). If prior fractions are not given, equal prior probabilities are assumed.

Parameters

part	charged stable particle
fractions	array of prior probabilities in the order defined in Const::ChargedStable
set	a set of PID detectors to use

Returns: logarithmic equivalent of global likelihood probability

Definition at line 122 of file PIDLikelihood.cc.

{
  // Defined as log(p / (1 - p)) where p is global PID probability.
  // In order to save the range of return values it must be implemented as below.
 
  int k = part.getIndex();
  if (k < 0) return -INFINITY; // p = 0
 
  if (fractions and fractions[k] <= 0) return -INFINITY; // p = 0
 
  double logL_part = getLogL(part, detSet);
  std::vector<double> logLs; // all other log likelihoods with priors > 0
  std::vector<double> priorRatios;
  for (int i = 0; i < static_cast<int>(Const::ChargedStable::c_SetSize); i++) {
    if (i == k) continue;
    double ratio = fractions ? fractions[i] / fractions[k] : 1;
    if (ratio <= 0) continue;
    priorRatios.push_back(ratio);
    logLs.push_back(getLogL(Const::chargedStableSet.at(i), detSet));
  }
  if (logLs.empty()) return +INFINITY; // p = 1
 
  double logL_max = logLs[0]; // maximal log likelihood of the others
  for (auto logl : logLs) logL_max = std::max(logl, logL_max);
 
  double sum = 0;
  for (size_t i = 0; i < logLs.size(); i++) sum += priorRatios[i] * exp(logLs[i] - logL_max);
  if (sum == 0) return +INFINITY; // to suppress cppckeck warning although this can never happen (see prev. return)
 
  return logL_part - logL_max - log(sum);
}

◆ getLogL()

float getLogL	(	const Const::ChargedStable &	part,
		Const::PIDDetectorSet	set = `Const::PIDDetectorSet::set()`
	)		const

Return log likelihood for a given detector set and particle.

Parameters

part	charged stable particle
set	a set of PID detectors to use

Returns: log likelihood

Definition at line 76 of file PIDLikelihood.cc.

{
  float result = 0;
  for (Const::DetectorSet::Iterator it = Const::PIDDetectorSet::set().begin();
       it != Const::PIDDetectorSet::set().end(); ++it) {
    if (set.contains(it))
      result += m_logl[it.getIndex()][part.getIndex()];
  }
  return result;
}

◆ getMostLikely()

Const::ChargedStable getMostLikely	(	const double *	fractions = `nullptr`,
		Const::PIDDetectorSet	set = `Const::PIDDetectorSet::set()`
	)		const

Return most likely particle among chargedStableSet; if prior fractions not given equal prior probabilities assumed.

Parameters

fractions	array of prior probabilities in the order defined in Const::ChargedStable
set	a set of PID detectors to use

Returns: most likely particle

Definition at line 157 of file PIDLikelihood.cc.

{
  const unsigned int n = Const::ChargedStable::c_SetSize;
  double prob[n];
  probability(prob, fractions, detSet);
 
  int k = 0;
  double maxProb = prob[k];
  for (unsigned i = 0; i < n; ++i) {
    if (prob[i] > maxProb) {maxProb = prob[i]; k = i;}
  }
  return Const::chargedStableSet.at(k);
 
}

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in Particle, MCParticle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getPreOfficialLikelihood()

double getPreOfficialLikelihood ( const std::string & preOfficialIdentifier ) const

Get the pre-official likelihood.

Parameters

preOfficialIdentifier Name of the pre-official likelihood

Returns: Value of the pre-official likelihood

Definition at line 334 of file PIDLikelihood.cc.

{
  if (m_preOfficialLikelihoods.count(preOfficialIdentifier) == 0) {
    B2WARNING("PIDLikelihood::getPreOfficialLikelihood: preOfficialIdentifier " << preOfficialIdentifier << " does not exist. ");
    return -1.0;
  }
  return m_preOfficialLikelihoods.at(preOfficialIdentifier);
}

◆ getProbability() [1/3]

double getProbability	(	const Const::ChargedStable &	p1,
		const Const::ChargedStable &	p2,
		Const::PIDDetectorSet	set = `Const::PIDDetectorSet::set()`
	)		const

inline

Return combined likelihood probability for a particle being p1 and not p2, assuming equal prior probabilities.

Parameters

p1	charged stable particle
p2	charged stable particle
set	a set of PID detectors to use

Returns: binary likelihood probability

Definition at line 104 of file PIDLikelihood.h.

    {
      return getProbability(p1, p2, 1.0, set);
    }

◆ getProbability() [2/3]

double getProbability	(	const Const::ChargedStable &	p1,
		const Const::ChargedStable &	p2,
		double	ratio,
		Const::PIDDetectorSet	set = `Const::PIDDetectorSet::set()`
	)		const

Return combined likelihood probability for a particle being p1 and not p2.

Parameters

p1	charged stable particle
p2	charged stable particle
ratio	ratio of prior probabilities (p1/p2)
set	a set of PID detectors to use

Returns: binary likelihood probability

Definition at line 89 of file PIDLikelihood.cc.

{
  if (ratio < 0) {
    B2ERROR("PIDLikelihood::probability argument 'ratio' is given with negative value");
    return 0;
  }
  if (ratio == 0) return 0;
 
  double dlogl = getLogL(p2, set) - getLogL(p1, set);
  double result = 0;
  if (dlogl < 0) {
    double elogl = exp(dlogl);
    result = ratio / (ratio + elogl);
  } else {
    double elogl = exp(-dlogl) * ratio; // to prevent overflow for very large dlogl
    result = elogl / (1.0 + elogl);
  }
 
  return result;
}

◆ getProbability() [3/3]

double getProbability	(	const Const::ChargedStable &	part,
		const double *	fractions = `nullptr`,
		Const::PIDDetectorSet	set = `Const::PIDDetectorSet::set()`
	)		const

Return combined likelihood probability for a particle according to chargedStableSet; if prior fractions not given equal prior probabilities assumed.

Parameters

part	charged stable particle
fractions	array of prior probabilities in the order defined in Const::ChargedStable
set	a set of PID detectors to use

Returns: global likelihood probability

Definition at line 114 of file PIDLikelihood.cc.

{
  return 1 / (1 + exp(-getLogarithmicProbability(part, fractions, detSet)));
}

◆ 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));
    }

◆ isAvailable()

bool isAvailable ( Const::PIDDetectorSet set = Const::PIDDetectorSet::set() ) const

Check whether PID information is available for at least one of the detectors in a given set.

Redefined after release-8.

Parameters

set	a set of PID detectors

Returns: true if at least one of the detectors in the set provides likelihoods

Definition at line 67 of file PIDLikelihood.cc.

{
  for (const auto& detector : set) {
    if (m_detectors.contains(detector)) return true;
  }
  return false;
}

◆ printArray()

void printArray ( ) const

Prints the content of a private array of log likelihoods.

Definition at line 214 of file PIDLikelihood.cc.

{
 
  const string detectorName[Const::PIDDetectors::c_size] =
  {"SVD", "CDC", "TOP", "ARICH", "ECL", "KLM"};
  string hline("-------");
  for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++)
    hline += "-----------";
  string Hline("=======");
  for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++)
    Hline += "===========";
 
  cout << Hline << endl;
 
  cout << "PDGcode";
  for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++)
    cout << setw(10) << Const::chargedStableSet.at(i).getPDGCode() << " ";
  cout << endl;
 
  cout << Hline << endl;
 
  float sum_logl[Const::ChargedStable::c_SetSize];
  for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++) sum_logl[i] = 0;
 
  for (unsigned k = 0; k < Const::PIDDetectors::c_size; k++) {
    cout << setw(7) << detectorName[k];
    for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++) {
      cout << setw(10) << setprecision(4) << m_logl[k][i] << " ";
      sum_logl[i] += m_logl[k][i];
    }
    cout << endl;
  }
 
  cout << hline << endl;
 
  cout << setw(7) << "sum";
  for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++)
    cout << setw(10) << setprecision(4) << sum_logl[i] << " ";
  cout << endl;
 
  if (isAvailable(Const::SVD) or isAvailable(Const::CDC) or isAvailable(Const::TOP) or
      isAvailable(Const::ARICH) or isAvailable(Const::ECL) or isAvailable(Const::KLM)) {
    unsigned k = 0;
    for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++)
      if (sum_logl[i] > sum_logl[k]) k = i;
    unsigned pos = 11 * (k + 1) + 3;
    Hline.replace(pos, 1, "^");
  }
  cout << Hline << endl;
 
}

◆ probability()

void probability	(	double	probabilities[],
		const double *	fractions,
		Const::PIDDetectorSet	detSet
	)		const

private

Calculate likelihood probabilities.

Parameters

fractions	array of prior fractions (not needed to be normalized)
probabilities	array of resulting probabilities
detSet	a set of PID detectors to use

Definition at line 174 of file PIDLikelihood.cc.

{
  const unsigned int n = Const::ChargedStable::c_SetSize;
  double frac[n];
  if (!fractions) {
    for (unsigned int i = 0; i < n; ++i) frac[i] = 1.0; // normalization not needed
    fractions = frac;
  }
 
  double logL[n];
  double logLmax = 0;
  bool hasMax = false;
  for (unsigned i = 0; i < n; ++i) {
    logL[i] = 0;
    if (fractions[i] > 0) {
      logL[i] = getLogL(Const::chargedStableSet.at(i), detSet);
      if (!hasMax || logL[i] > logLmax) {
        logLmax = logL[i];
        hasMax = true;
      }
    }
  }
 
  double norm = 0;
  for (unsigned i = 0; i < n; ++i) {
    probabilities[i] = 0;
    if (fractions[i] > 0) probabilities[i] = exp(logL[i] - logLmax) * fractions[i];
    norm += probabilities[i];
  }
  if (norm == 0) return;
 
  for (unsigned i = 0; i < n; ++i) {
    probabilities[i] /= norm;
  }
 
}

◆ setLogLikelihood()

void setLogLikelihood	(	Const::EDetector	det,
		const Const::ChargedStable &	part,
		float	logl
	)

Set log likelihood for a given detector and particle.

Parameters

det	detector enumerator
part	charged stable particle
logl	log likelihood

Definition at line 35 of file PIDLikelihood.cc.

{
  int index = Const::PIDDetectors::set().getIndex(det);
  if (index < 0) {
    B2ERROR("PIDLikelihood::setLogLikelihood: detector is not a PID device");
    return;
  }
  if (logl != logl or logl == INFINITY) {
    B2ERROR("PIDLikelihood::setLogLikelihood: log-likelihood for detector " << det << " is " << logl <<
            " (i.e. +inf or NaN)! Ignoring this value. ("
            << Const::SVD << "=SVD, " << Const::CDC << "=CDC, " << Const::TOP << "=TOP, "
            << Const::ARICH << "=ARICH, " << Const::ECL << "=ECL, " << Const::KLM << "=KLM)");
 
    return;
  }
  m_detectors += det;
  m_logl[index][part.getIndex()] = logl;
}

◆ subtractMaximum()

void subtractMaximum ( )

Subtract the maximum of log likelihoods of each detector component in order to reduce the range of values.

Definition at line 57 of file PIDLikelihood.cc.

{
  for (auto& detectorLLs : m_logl) {
    auto maxLL = detectorLLs[0];
    for (auto LL : detectorLLs) maxLL = std::max(maxLL, LL);
    for (auto& LL : detectorLLs) LL -= maxLL;
  }
}

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_detectors

Const::DetectorSet m_detectors

private

set of detectors with PID information

Definition at line 197 of file PIDLikelihood.h.

◆ m_logl

float m_logl[Const::PIDDetectors::c_size][Const::ChargedStable::c_SetSize]

private

log likelihoods

Definition at line 198 of file PIDLikelihood.h.

◆ m_preOfficialLikelihoods

std::map<std::string, double> m_preOfficialLikelihoods

private

Internal storage of pre-official likelihood.

Definition at line 201 of file PIDLikelihood.h.

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

mdst/dataobjects/include/PIDLikelihood.h
mdst/dataobjects/src/PIDLikelihood.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PIDLikelihood()

Member Function Documentation

◆ addPreOfficialLikelihood()

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ areAllAvailable()

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getDeltaLogL()

◆ getInfo()

◆ getInfoHTML()

◆ getLogarithmicProbability()

◆ getLogL()

◆ getMostLikely()

◆ getName()

◆ getPreOfficialLikelihood()

◆ getProbability() [1/3]

◆ getProbability() [2/3]

◆ getProbability() [3/3]

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ isAvailable()

◆ printArray()

◆ probability()

◆ setLogLikelihood()

◆ subtractMaximum()

Member Data Documentation

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_detectors

◆ m_logl

◆ m_preOfficialLikelihoods