AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType > Class Template Reference

Base class for storing an algorithm determining the data one wants to have. More...

#include <AnalyzingAlgorithmBase.h>

Inheritance diagram for AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType >:

Classes
struct	TcPair
	minimal struct for keeping track which tc is which More...

Public Member Functions
	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
	AnalyzingAlgorithmBase ()
	constructor
virtual	~AnalyzingAlgorithmBase ()
	virtual destructor - derived classes need to write their own destructors if any other data members are added.
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
virtual DataType	calcData (const TCInfoType &)
	virtual class to calculate data.

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
	AnalyzingAlgorithmBase (const AlgoritmType::Type &newID)
	constructor used for inheriting classes
	AnalyzingAlgorithmBase (const std::string &newID)
	constructor used for inheriting classes
	AnalyzingAlgorithmBase (const AnalyzingAlgorithmBase &algo)=delete
	copy constructor should not be used so delete it
AnalyzingAlgorithmBase &	operator= (const AnalyzingAlgorithmBase &algo)=delete
	also assignement constructor should not be used
virtual const TCInfoType &	chooseCorrectTC (const TCInfoType &aTC) const
	virtual class to determine the correct TC to be used for algorithm calculation.
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
static bool	m_storeRefTCDataForTestTC = false
	if true, for testTC the values of attached refTC will be stored instead of own values.

Detailed Description

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

Base class for storing an algorithm determining the data one wants to have.

Definition at line 31 of file AnalyzingAlgorithmBase.h.

Constructor & Destructor Documentation

AnalyzingAlgorithmBase() [1/3]

AnalyzingAlgorithmBase ( const AlgoritmType::Type &  newID )

inlineexplicitprotected

constructor used for inheriting classes

Definition at line 68 of file AnalyzingAlgorithmBase.h.

: m_iD(newID) {}

AnalyzingAlgorithmBase() [2/3]

AnalyzingAlgorithmBase ( const std::string &  newID )

inlineexplicitprotected

constructor used for inheriting classes

Definition at line 71 of file AnalyzingAlgorithmBase.h.

: m_iD(AlgoritmType::getTypeEnum(newID)) {}

AnalyzingAlgorithmBase() [3/3]

AnalyzingAlgorithmBase ( )

inline

constructor

Definition at line 119 of file AnalyzingAlgorithmBase.h.

: m_iD(AlgoritmType::AnalyzingAlgorithmBase) {}

~AnalyzingAlgorithmBase()

virtual ~AnalyzingAlgorithmBase ( )

inlinevirtual

virtual destructor - derived classes need to write their own destructors if any other data members are added.

Definition at line 123 of file AnalyzingAlgorithmBase.h.

{}

Member Function Documentation

calcData()

virtual DataType calcData ( const TCInfoType &  )

inlinevirtual

virtual class to calculate data.

takes two TCInfos

Reimplemented in AnalyzingAlgorithmLostUClusters< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmLostVClusters< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmLostUEDep< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmLostVEDep< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmTotalUClusters< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmTotalVClusters< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmTotalUEDep< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmTotalVEDep< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPX< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPY< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPZ< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPT< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualP< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPTheta< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPPhi< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPAngle< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPTAngle< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPosition< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmResidualPositionXY< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValuePX< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValuePY< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValuePZ< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValuePT< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValueP< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValuePTheta< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValuePPhi< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValueDistSeed2IP< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValueDistSeed2IPXY< DataType, TCInfoType, VectorType >, AnalyzingAlgorithmValueDistSeed2IPZ< DataType, TCInfoType, VectorType >, and AnalyzingAlgorithmValueQI< DataType, TCInfoType, VectorType >.

Definition at line 153 of file AnalyzingAlgorithmBase.h.

    {
      B2ERROR(" AnalyzingAlgorithmBase::calcData: if you can see this, the code tried to return the actual baseClass instead of the inherited ones - this is unintended behavior!");
      return DataType();
    }

chooseCorrectPairOfTCs()

virtual const TcPair chooseCorrectPairOfTCs ( const TCInfoType &  aTC ) const

inlineprotectedvirtual

makes sure that TcPair.refTC and .testTC are correctly set - throws exeption if there are problems

Definition at line 100 of file AnalyzingAlgorithmBase.h.

    {
      // capture bad case, where second TC is missing:
      if (aTC.assignedTC == nullptr) { throw AnalyzingAlgorithmBase::No_refTC_Attached(); }
 
      if (aTC.tcType == TCType::Reference or aTC.tcType == TCType::Lost) {
        return TcPair(aTC, *aTC.assignedTC);
      }
      return TcPair(*aTC.assignedTC, aTC);
    }

chooseCorrectTC()

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

inlineprotectedvirtual

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 84 of file AnalyzingAlgorithmBase.h.

    {
      // capture cases of aTC == referenceTC first:
      if (TCType::isReference(aTC.tcType)) { return aTC; }
 
      // is no reference TC and own data usage is allowed:
      if (m_storeRefTCDataForTestTC == false) { return aTC; }
 
      // handle cases when attached reference TC has to be used instead of own data:
      if (aTC.assignedTC != nullptr) { return *aTC.assignedTC; }
 
      throw AnalyzingAlgorithmBase::No_refTC_Attached();
    }

getID()

AlgoritmType::Type getID ( ) const

inline

returns unique ID

Definition at line 131 of file AnalyzingAlgorithmBase.h.

{ return m_iD; }

getIDName()

std::string getIDName ( ) const

inline

returns unique ID as a string

Definition at line 134 of file AnalyzingAlgorithmBase.h.

{ return AlgoritmType::getTypeName(m_iD); }

getOrigin()

static VectorType & getOrigin ( )

inlinestatic

returns current value for the origin

Definition at line 137 of file AnalyzingAlgorithmBase.h.

{ return s_origin; }

operator==()

bool operator== ( const AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType > &  b ) const

inline

operator for comparison.

Definition at line 127 of file AnalyzingAlgorithmBase.h.

{ return m_iD == b.getID(); }

setOrigin()

static void setOrigin ( VectorType  newOrigin )

inlinestatic

set origin for all inherited classes

Definition at line 141 of file AnalyzingAlgorithmBase.h.

{ s_origin = newOrigin; }

setWillRefTCdataBeUsed4TestTCs()

static void setWillRefTCdataBeUsed4TestTCs ( bool  newBehavior )

inlinestatic

set behavior of algorithms in terms of storing reference or testData for successfully matched TCs

Definition at line 149 of file AnalyzingAlgorithmBase.h.

{ m_storeRefTCDataForTestTC = newBehavior; }

willRefTCdataBeUsed4TestTCs()

static bool willRefTCdataBeUsed4TestTCs ( )

inlinestatic

returns current choice for behavior of algorithms in terms of storing reference or testData for successfully matched TCs

Definition at line 145 of file AnalyzingAlgorithmBase.h.

{ return m_storeRefTCDataForTestTC; }

Member Data Documentation

m_iD

AlgoritmType::Type m_iD

protected

carries unique ID

Definition at line 51 of file AnalyzingAlgorithmBase.h.

---

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

• tracking/trackFindingVXD/analyzingTools/algorithms/include/AnalyzingAlgorithmBase.h