Belle II Software development
ARICHLikelihood Class Reference

This is a class to store ARICH likelihoods in the datastore. More...

#include <ARICHLikelihood.h>

Inheritance diagram for ARICHLikelihood:
RelationsInterface< BASE >

Public Member Functions

 ARICHLikelihood ()
 default constructor
 
void setValues (int flag, const double *logL, int detPhot, const double *expPhot)
 Set values.
 
int getFlag () const
 Get reconstruction flag.
 
float getLogL (const Const::ChargedStable &part) const
 Return log likelihood for a given particle.
 
float getDetPhot () const
 Return number of detected photons for a given particle.
 
float getExpPhot (const Const::ChargedStable &part) const
 Return number of expected photons for a given particle.
 
double getLogL_e () const
 Get electron log likelihood.
 
double getLogL_mu () const
 Get muon log likelihood.
 
double getLogL_pi () const
 Get pion log likelihood.
 
double getLogL_K () const
 Get kaon log likelihood.
 
double getLogL_p () const
 Get proton log likelihood.
 
double getNphot_e () const
 Get number of expected photons for electron.
 
double getNphot_mu () const
 Get number of expected photons for muon.
 
double getNphot_pi () const
 Get number of expected photons for pion.
 
double getNphot_K () const
 Get number of expected photons for kaon.
 
double getNphot_p () const
 Get number of expected photons for proton.
 
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.
 
virtual std::string getInfoHTML () const
 Return a short summary of this object's contents in HTML format.
 
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

 ClassDef (ARICHLikelihood, 3)
 the class title
 

Private Attributes

int m_flag
 reconstruction flag
 
float m_logL [Const::ChargedStable::c_SetSize]
 log likelihoods
 
float m_expPhot [Const::ChargedStable::c_SetSize]
 expected number of photons
 
int m_detPhot
 detected number of photons
 
DataStore::StoreEntrym_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 is a class to store ARICH likelihoods in the datastore.

It is the output of reconstruction module (ARICHReconstructor).

Definition at line 28 of file ARICHLikelihood.h.

Constructor & Destructor Documentation

◆ ARICHLikelihood()

ARICHLikelihood ( )
inline

default constructor

Definition at line 34 of file ARICHLikelihood.h.

34 : m_flag(0)
35 {
36 for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++) m_logL[i] = 0;
37 for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++) m_expPhot[i] = 0;
38 m_detPhot = 0;
39 }
float m_logL[Const::ChargedStable::c_SetSize]
log likelihoods
float m_expPhot[Const::ChargedStable::c_SetSize]
expected number of photons
int m_flag
reconstruction flag
int m_detPhot
detected number of photons
static const unsigned int c_SetSize
Number of elements (for use in array bounds etc.)
Definition: Const.h:615

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
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

143 {
144 if (object)
146 object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
147 }
void addRelation(const TObject *fromObject, StoreEntry *&fromEntry, int &fromIndex, const TObject *toObject, StoreEntry *&toEntry, int &toIndex, float weight, const std::string &namedRelation)
Add a relation from an object in a store array to another object in a store array.
Definition: DataStore.cc:492
static DataStore & Instance()
Instance of singleton Store.
Definition: DataStore.cc:54
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.

◆ 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
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

156 {
157 StoreEntry* toEntry = nullptr;
158 int toIndex = -1;
159 DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
160 }

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

171 {
172 if (!sourceObj)
173 return;
174 auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
175 for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
176 fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
177 }
178
179 auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
180 for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
181 this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
182 }
183 }
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).

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

386 {
388 return m_cacheArrayIndex;
389 }
bool findStoreEntry(const TObject *object, StoreEntry *&entry, int &index)
Find an object in an array in the data store.
Definition: DataStore.cc:398

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

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

419 {
422 return nullptr;
424 }
TClonesArray * getPtrAsArray() const
Return ptr cast to TClonesArray.
Definition: StoreEntry.cc:83

◆ getDetPhot()

float getDetPhot ( ) const
inline

Return number of detected photons for a given particle.

Returns
detected photon number

Definition at line 82 of file ARICHLikelihood.h.

83 {
84 return m_detPhot;
85 }

◆ getExpPhot()

float getExpPhot ( const Const::ChargedStable part) const
inline

Return number of expected photons for a given particle.

Parameters
partcharged stable particle
Returns
detected photon number

Definition at line 92 of file ARICHLikelihood.h.

93 {
94 return m_expPhot[part.getIndex()];
95 }

◆ getFlag()

int getFlag ( ) const
inline

Get reconstruction flag.

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

Definition at line 66 of file ARICHLikelihood.h.

66{return m_flag;}

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

371 {
373 }
virtual std::string getInfoHTML() const
Return a short summary of this object's contents in HTML format.
std::string htmlToPlainText(const std::string &html)
See RelationsObject::getInfo()

◆ 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();
std::string getString(const TMatrixFBase &matrix, int precision=2, bool color=true)
get HTML table representing a matrix.
Definition: HTML.cc:24
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 Particle, Cluster, MCParticle, PIDLikelihood, SoftwareTriggerResult, Track, TrackFitResult, TRGSummary, and RecoTrack.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getLogL()

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

Return log likelihood for a given particle.

Parameters
partcharged stable particle
Returns
log likelihood

Definition at line 73 of file ARICHLikelihood.h.

74 {
75 return m_logL[part.getIndex()];
76 }

◆ getLogL_e()

double getLogL_e ( ) const
inline

Get electron log likelihood.

Returns
electron log likelihood

Definition at line 101 of file ARICHLikelihood.h.

int getIndex() const
This particle's index in the associated set.
Definition: Const.h:461
static const ChargedStable electron
electron particle
Definition: Const.h:659

◆ getLogL_K()

double getLogL_K ( ) const
inline

Get kaon log likelihood.

Returns
kaon log likelihood

Definition at line 116 of file ARICHLikelihood.h.

116{return m_logL[Const::kaon.getIndex()];}
static const ChargedStable kaon
charged kaon particle
Definition: Const.h:662

◆ getLogL_mu()

double getLogL_mu ( ) const
inline

Get muon log likelihood.

Returns
muon log likelihood

Definition at line 106 of file ARICHLikelihood.h.

106{return m_logL[Const::muon.getIndex()];}
static const ChargedStable muon
muon particle
Definition: Const.h:660

◆ getLogL_p()

double getLogL_p ( ) const
inline

Get proton log likelihood.

Returns
proton log likelihood

Definition at line 121 of file ARICHLikelihood.h.

121{return m_logL[Const::proton.getIndex()];}
static const ChargedStable proton
proton particle
Definition: Const.h:663

◆ getLogL_pi()

double getLogL_pi ( ) const
inline

Get pion log likelihood.

Returns
pion log likelihood

Definition at line 111 of file ARICHLikelihood.h.

111{return m_logL[Const::pion.getIndex()];}
static const ChargedStable pion
charged pion particle
Definition: Const.h:661

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

◆ getNphot_e()

double getNphot_e ( ) const
inline

Get number of expected photons for electron.

Returns
number of expected photons for electron

Definition at line 127 of file ARICHLikelihood.h.

◆ getNphot_K()

double getNphot_K ( ) const
inline

Get number of expected photons for kaon.

Returns
number of expected photons for kaon

Definition at line 142 of file ARICHLikelihood.h.

142{return m_expPhot[Const::kaon.getIndex()];}

◆ getNphot_mu()

double getNphot_mu ( ) const
inline

Get number of expected photons for muon.

Returns
number of expected photons for muon

Definition at line 132 of file ARICHLikelihood.h.

132{return m_expPhot[Const::muon.getIndex()];}

◆ getNphot_p()

double getNphot_p ( ) const
inline

Get number of expected photons for proton.

Returns
number of expected photons for proton

Definition at line 147 of file ARICHLikelihood.h.

◆ getNphot_pi()

double getNphot_pi ( ) const
inline

Get number of expected photons for pion.

Returns
number of expected photons for pion

Definition at line 137 of file ARICHLikelihood.h.

137{return m_expPhot[Const::pion.getIndex()];}

◆ 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
TThe class of objects to or from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

279 {
281 T::Class(), name, namedRelation).object);
282 }
@ c_BothSides
Combination of c_FromSide and c_ToSide.
Definition: DataStore.h:79
Belle2::RelationEntry getRelationWith(ESearchSide searchSide, const TObject *object, StoreEntry *&entry, int &index, const TClass *withClass, const std::string &withName, const std::string &namedRelation)
Get the first relation between an object and another object in a store array.
Definition: DataStore.cc:597
TObject * object
Pointer to the object.
Definition: RelationEntry.h:32

◆ 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
FROMThe class of objects from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

264 {
266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
267 }
@ c_FromSide
Return relations/objects pointed from (to a given object).
Definition: DataStore.h:77

◆ 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
FROMThe class of objects from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

316 {
318 FROM::Class(), name, namedRelation);
319 return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
320 }

◆ 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
TOThe class of objects to which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

249 {
251 TO::Class(), name, namedRelation).object);
252 }
@ c_ToSide
Return relations/objects pointed to (from a given object).
Definition: DataStore.h:78

◆ 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
TOThe class of objects to which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

299 {
301 TO::Class(), name, namedRelation);
302 return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
303 }

◆ 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
TThe class of objects to or from which the relation points.
Parameters
nameThe 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.
namedRelationAdditional 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.

333 {
335 T::Class(), name, namedRelation);
336 return std::make_pair(static_cast<T*>(entry.object), entry.weight);
337 }

◆ 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
FROMThe class of objects from which the relations point.
Parameters
nameThe 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.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 212 of file RelationsObject.h.

214 {
216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));
217 }
RelationVector< T > getRelationsWith(const std::string &name="", const std::string &namedRelation="") const
Get the relations between this object and another store array.

◆ 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
TOThe class of objects to which the relations point.
Parameters
nameThe 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.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 197 of file RelationsObject.h.

198 {
200 m_cacheArrayIndex, TO::Class(), name, namedRelation));
201 }

◆ 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
TThe class of objects to or from which the relations point.
Parameters
nameThe 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.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 230 of file RelationsObject.h.

231 {
233 m_cacheArrayIndex, T::Class(), name, namedRelation));
234 }

◆ setValues()

void setValues ( int  flag,
const double *  logL,
int  detPhot,
const double *  expPhot 
)
inline

Set values.

Parameters
flagreconstruction flag
logLlog likelihoods in the order of Const::ChargedStableSet
expPhotexpected number of photons in the order of Const::ChargedStableSet
detPhotdetected number of photons in the order of Const::ChargedStableSet

Definition at line 48 of file ARICHLikelihood.h.

53 {
54 m_flag = flag;
55 for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++)
56 m_logL[i] = logL[i];
57 for (unsigned i = 0; i < Const::ChargedStable::c_SetSize; i++)
58 m_expPhot[i] = expPhot[i];
59
60 m_detPhot = detPhot;
61 }

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_detPhot

int m_detPhot
private

detected number of photons

Definition at line 153 of file ARICHLikelihood.h.

◆ m_expPhot

float m_expPhot[Const::ChargedStable::c_SetSize]
private

expected number of photons

Definition at line 152 of file ARICHLikelihood.h.

◆ m_flag

int m_flag
private

reconstruction flag

Definition at line 150 of file ARICHLikelihood.h.

◆ m_logL

float m_logL[Const::ChargedStable::c_SetSize]
private

log likelihoods

Definition at line 151 of file ARICHLikelihood.h.


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