AnalyzingAlgorithmResidualPosition< DataType, TCInfoType, VectorType > Class Template Reference

Class for storing an algorithm determining the residual (ref-test) of the seed position in 3D. More...

#include <AnalyzingAlgorithmResiduals.h>

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

Public Member Functions
	AnalyzingAlgorithmResidualPosition ()
	constructor
DataType	calcData (const TCInfoType &aTC) override
	returns the residual (ref-test) of the seed position in 3D
	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.
virtual const TcPair	chooseCorrectPairOfTCs (const TCInfoType &aTC) const
	makes sure that TcPair.refTC and .testTC are correctly set - throws exception 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::AnalyzingAlgorithmResidualPosition< DataType, TCInfoType, VectorType >

Class for storing an algorithm determining the residual (ref-test) of the seed position in 3D.

Definition at line 194 of file AnalyzingAlgorithmResiduals.h.

Constructor & Destructor Documentation

AnalyzingAlgorithmResidualPosition()

AnalyzingAlgorithmResidualPosition ( )

inline

constructor

Definition at line 197 of file AnalyzingAlgorithmResiduals.h.

                                         : AnalyzingAlgorithmBase<DataType, TCInfoType, VectorType>
      (AlgoritmType::AnalyzingAlgorithmResidualPosition) {}

Member Function Documentation

calcData()

DataType calcData ( const TCInfoType &  aTC )

inlineoverridevirtual

returns the residual (ref-test) of the seed position in 3D

Reimplemented from AnalyzingAlgorithmBase< DataType, TCInfoType, VectorType >.

Definition at line 201 of file AnalyzingAlgorithmResiduals.h.

    {
      const auto tcs = AnalyzingAlgorithmBase<DataType, TCInfoType, VectorType>::chooseCorrectPairOfTCs(aTC);
      return (tcs.refTC->posSeed - tcs.testTC->posSeed).R();
    }

chooseCorrectPairOfTCs()

virtual const TcPair chooseCorrectPairOfTCs ( const TCInfoType &  aTC ) const

inlineprotectedvirtualinherited

makes sure that TcPair.refTC and .testTC are correctly set - throws exception 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

inlineprotectedvirtualinherited

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

• throws exception 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

inlineinherited

returns unique ID

Definition at line 131 of file AnalyzingAlgorithmBase.h.

{ return m_iD; }

getIDName()

std::string getIDName ( ) const

inlineinherited

returns unique ID as a string

Definition at line 134 of file AnalyzingAlgorithmBase.h.

{ return AlgoritmType::getTypeName(m_iD); }

getOrigin()

static VectorType & getOrigin ( )

inlinestaticinherited

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

inlineinherited

operator for comparison.

Definition at line 127 of file AnalyzingAlgorithmBase.h.

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

setOrigin()

static void setOrigin ( VectorType  newOrigin )

inlinestaticinherited

set origin for all inherited classes

Definition at line 141 of file AnalyzingAlgorithmBase.h.

{ s_origin = newOrigin; }

setWillRefTCdataBeUsed4TestTCs()

static void setWillRefTCdataBeUsed4TestTCs ( bool  newBehavior )

inlinestaticinherited

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

inlinestaticinherited

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

protectedinherited

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/AnalyzingAlgorithmResiduals.h