Belle II Software development
Public Member Functions | Protected Attributes | List of all members
TrackerAlgorithmBase< ContainerType, ValidatorType > Class Template Reference
Packages » tracking

base class for TrackerAlgorithms. shall allow a common base for algorithms like the cellular automaton More...

#include <TrackerAlgorithmBase.h>

Inheritance diagram for TrackerAlgorithmBase< ContainerType, ValidatorType >:
CellularAutomaton< DirectedNodeNetwork< Belle2::Segment< Belle2::TrackNode >, Belle2::CACell >, Belle2::CAValidator< Belle2::CACell > > CellularAutomaton< ContainerType, ValidatorType >

Public Member Functions

virtual ValidatorType & getValidator ()
 getter
 
virtual std::string printStatistics ()
 returns current logging info of the algorithm (some stuff one wants to log about that algorithm
 
virtual void setValidator (ValidatorType &aValidator)
 setter
 
virtual int apply (ContainerType &)
 applies actual algorithm on parameter passed, returns some debuging results
 
virtual unsigned int findSeeds (ContainerType &, bool)
 searches for seeds among the entries of parameter passed (bool sets strictnes for finding seeds), uses m_validator for determining them, returns number of seeds found
 

Protected Attributes

ValidatorType m_validator
 something which checks the quality of the test so far (will be applied by the apply-function
 

Detailed Description

template<class ContainerType, class ValidatorType>
class Belle2::TrackerAlgorithmBase< ContainerType, ValidatorType >

base class for TrackerAlgorithms. shall allow a common base for algorithms like the cellular automaton

Definition at line 20 of file TrackerAlgorithmBase.h.

Member Function Documentation

◆ apply()

virtual int apply ( ContainerType &  )
inlinevirtual

applies actual algorithm on parameter passed, returns some debuging results

Reimplemented in CellularAutomaton< ContainerType, ValidatorType >.

Definition at line 38 of file TrackerAlgorithmBase.h.

38{ return 0; }

◆ findSeeds()

virtual unsigned int findSeeds ( ContainerType &  ,
bool   
)
inlinevirtual

searches for seeds among the entries of parameter passed (bool sets strictnes for finding seeds), uses m_validator for determining them, returns number of seeds found

Reimplemented in CellularAutomaton< ContainerType, ValidatorType >.

Definition at line 42 of file TrackerAlgorithmBase.h.

42{ return 0; }

◆ getValidator()

virtual ValidatorType & getValidator ( )
inlinevirtual

getter

returns the validator of the algorithm

Definition at line 28 of file TrackerAlgorithmBase.h.

28{ return m_validator; }
Belle2::TrackerAlgorithmBase::m_validator
ValidatorType m_validator
something which checks the quality of the test so far (will be applied by the apply-function
Definition: TrackerAlgorithmBase.h:23

◆ printStatistics()

virtual std::string printStatistics ( )
inlinevirtual

returns current logging info of the algorithm (some stuff one wants to log about that algorithm

Definition at line 31 of file TrackerAlgorithmBase.h.

31{ return ""; }

◆ setValidator()

virtual void setValidator ( ValidatorType &  aValidator)
inlinevirtual

setter

allows to set some condition for validating the algorithm

Definition at line 35 of file TrackerAlgorithmBase.h.

35{ m_validator = aValidator; }

Member Data Documentation

◆ m_validator

ValidatorType m_validator
protected

something which checks the quality of the test so far (will be applied by the apply-function

Definition at line 23 of file TrackerAlgorithmBase.h.

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