Belle II Software  release-05-02-19
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
AnalyzingAlgorithmTotalVClusters< DataType, TCInfoType, VectorType > Class Template Reference
Packages » tracking

Class for storing an algorithm to find out how many v-type-clusters the given TC had. More...

#include <AnalyzingAlgorithmClusterBased.h>

Inheritance diagram for AnalyzingAlgorithmTotalVClusters< DataType, TCInfoType, VectorType >:
Inheritance graph
[legend]
Collaboration diagram for AnalyzingAlgorithmTotalVClusters< DataType, TCInfoType, VectorType >:
Collaboration graph
[legend]

Public Member Functions

 AnalyzingAlgorithmTotalVClusters ()
 constructor
 
DataType calcData (const TCInfoType &aTC) override
 returns how many v-type-clusters the given TC had More...
 
 BELLE2_DEFINE_EXCEPTION (No_refTC_Attached, "To given testTC no refTC was attached, could not provide valid data for algorithm - no value returned!")
 this exception is thrown if m_storeRefTCDataForTestTC is true and no refTC could be found
 
bool operator== (const AnalyzingAlgorithmBase &b) const
 operator for comparison.
 
AlgoritmType::Type getID () const
 returns unique ID
 
std::string getIDName () const
 returns unique ID as a string
 

Static Public Member Functions

static VectorType & getOrigin ()
 returns current value for the origin
 
static void setOrigin (VectorType newOrigin)
 set origin for all inherited classes
 
static bool willRefTCdataBeUsed4TestTCs ()
 returns current choice for behavior of algorithms in terms of storing reference or testData for successfully matched TCs
 
static void setWillRefTCdataBeUsed4TestTCs (bool newBehavior)
 set behavior of algorithms in terms of storing reference or testData for successfully matched TCs
 

Protected Member Functions

virtual const TCInfoType & chooseCorrectTC (const TCInfoType &aTC) const
 virtual class to determine the correct TC to be used for algorithm calculation. More...
 
virtual const TcPair chooseCorrectPairOfTCs (const TCInfoType &aTC) const
 makes sure that TcPair.refTC and .testTC are correctly set - throws exeption if there are problems
 

Protected Attributes

AlgoritmType::Type m_iD
 carries unique ID
 

Static Protected Attributes

static VectorType s_origin = VectorType(0, 0, 0)
 stores the origin used for some calculations, can be set here More...
 
static bool m_storeRefTCDataForTestTC = false
 if true, for testTC the values of attached refTC will be stored instead of own values. More...
 

Detailed Description

template<class DataType, class TCInfoType, class VectorType>
class Belle2::AnalyzingAlgorithmTotalVClusters< DataType, TCInfoType, VectorType >

Class for storing an algorithm to find out how many v-type-clusters the given TC had.

Definition at line 213 of file AnalyzingAlgorithmClusterBased.h.

Member Function Documentation

◆ calcData()

DataType calcData ( const TCInfoType &  aTC)
inlineoverridevirtual

returns how many v-type-clusters the given TC had

TODO

Reimplemented from AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType >.

Definition at line 220 of file AnalyzingAlgorithmClusterBased.h.

◆ chooseCorrectTC()

virtual const TCInfoType& chooseCorrectTC ( const TCInfoType &  aTC) const
inlineprotectedvirtualinherited

virtual class to determine the correct TC to be used for algorithm calculation.

  • throws exeption if there are problems. More explanations @ m_storeRefTCDataForTestTC.

Definition at line 94 of file AnalyzingAlgorithmBase.h.

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