AlgoritmType Class Reference

Small class for classifying types of analyzing algorithms. More...

#include <AlgoritmType.h>

Public Types
enum	Type {   UnknownType ,   AnalyzingAlgorithmBase ,   AnalyzingAlgorithmValuePX ,   AnalyzingAlgorithmValuePY ,   AnalyzingAlgorithmValuePZ ,   AnalyzingAlgorithmValuePT ,   AnalyzingAlgorithmValueP ,   AnalyzingAlgorithmValuePTheta ,   AnalyzingAlgorithmValuePPhi ,   AnalyzingAlgorithmValueDistSeed2IP ,   AnalyzingAlgorithmValueDistSeed2IPZ ,   AnalyzingAlgorithmValueDistSeed2IPXY ,   AnalyzingAlgorithmValueQI ,   AnalyzingAlgorithmResidualPX ,   AnalyzingAlgorithmResidualPY ,   AnalyzingAlgorithmResidualPZ ,   AnalyzingAlgorithmResidualPT ,   AnalyzingAlgorithmResidualP ,   AnalyzingAlgorithmResidualPTheta ,   AnalyzingAlgorithmResidualPPhi ,   AnalyzingAlgorithmResidualPAngle ,   AnalyzingAlgorithmResidualPTAngle ,   AnalyzingAlgorithmResidualPosition ,   AnalyzingAlgorithmResidualPositionXY ,   AnalyzingAlgorithmLostUClusters ,   AnalyzingAlgorithmLostVClusters ,   AnalyzingAlgorithmTotalUClusters ,   AnalyzingAlgorithmTotalVClusters ,   AnalyzingAlgorithmLostUEDep ,   AnalyzingAlgorithmLostVEDep ,   AnalyzingAlgorithmTotalUEDep ,   AnalyzingAlgorithmTotalVEDep ,   NTypes }
	allows classifying Analyzing algorithms More...

Static Public Member Functions
static bool	isValidType (AlgoritmType::Type type)
	checks if a type given is a valid type for an AlgoritmType
static bool	isValidName (std::string type)
	checks if the name given is a valid name for an AlgoritmType
static std::string	getTypeName (AlgoritmType::Type type)
	for given AlgoritmType the corresponding string-name will be returned.
static AlgoritmType::Type	getTypeEnum (std::string type)
	for given string name of a AlgoritmType the corresponding AlgoritmType will be returned.
static bool	isValueDoubleType (AlgoritmType::Type aType)
	returns true if given AlgoritmType is a an algorithm which calculates a value in double for each TC passed, false if not
static bool	isResidualDoubleType (AlgoritmType::Type aType)
	returns true if given AlgoritmType is a an algorithm which calculates a residual in double for each TC passed, false if not
static bool	isHitValueIntType (AlgoritmType::Type aType)
	returns true if given AlgoritmType is a an algorithm which calculates a value in int based on hits of each TC passed, false if not
static bool	isHitValueVecDoubleType (AlgoritmType::Type aType)
	returns true if given AlgoritmType is a an algorithm which calculates a value in vector< double> based on hits of each TC passed, false if not

Static Protected Attributes
static std::map< Type, std::string >	s_fromTypeToString
	static map allowing translation from a given type to its name stored as a string
static std::map< std::string, Type >	s_fromStringToType
	static map allowing translation from a given name stored as a string to its type

Detailed Description

Small class for classifying types of analyzing algorithms.

Contains enums and converter from and to strings

Definition at line 25 of file AlgoritmType.h.

Member Enumeration Documentation

Type

enum Type

allows classifying Analyzing algorithms

Enumerator
AnalyzingAlgorithmBase	base type, template for all the other analyzing algorithms, contains essential functions for all algorithms:
AnalyzingAlgorithmValuePX	value type, stores double. defined in ..tracking/trackFindingVXD/analyzingTools/algorithms/AnalyzingAlgorithmValues.h:
AnalyzingAlgorithmResidualPX	residual type, stores double. defined in ..tracking/trackFindingVXD/analyzingTools/algorithms/AnalyzingAlgorithmResiduals.h:
AnalyzingAlgorithmLostUClusters	value type hit (with access to clusters via relations), stores int. defined in ..tracking/trackFindingVXD/analyzingTools/algorithms/AnalyzingAlgorithmClusterBased.h:
AnalyzingAlgorithmLostUEDep	value type hit (with access to clusters via relations), stores vector< double >. defined in ..tracking/trackFindingVXD/analyzingTools/algorithms/AnalyzingAlgorithmClusterBased.h:

Definition at line 29 of file AlgoritmType.h.

              {
      UnknownType, // defines unknown types
      AnalyzingAlgorithmBase,
      AnalyzingAlgorithmValuePX,
      AnalyzingAlgorithmValuePY,
      AnalyzingAlgorithmValuePZ,
      AnalyzingAlgorithmValuePT,
      AnalyzingAlgorithmValueP,
      AnalyzingAlgorithmValuePTheta,
      AnalyzingAlgorithmValuePPhi,
      AnalyzingAlgorithmValueDistSeed2IP,
      AnalyzingAlgorithmValueDistSeed2IPZ,
      AnalyzingAlgorithmValueDistSeed2IPXY,
      AnalyzingAlgorithmValueQI,
      AnalyzingAlgorithmResidualPX,
      AnalyzingAlgorithmResidualPY,
      AnalyzingAlgorithmResidualPZ,
      AnalyzingAlgorithmResidualPT,
      AnalyzingAlgorithmResidualP,
      AnalyzingAlgorithmResidualPTheta,
      AnalyzingAlgorithmResidualPPhi,
      AnalyzingAlgorithmResidualPAngle,
      AnalyzingAlgorithmResidualPTAngle,
      AnalyzingAlgorithmResidualPosition,
      AnalyzingAlgorithmResidualPositionXY,
      AnalyzingAlgorithmLostUClusters,
      AnalyzingAlgorithmLostVClusters,
      AnalyzingAlgorithmTotalUClusters,
      AnalyzingAlgorithmTotalVClusters,
      AnalyzingAlgorithmLostUEDep,
      AnalyzingAlgorithmLostVEDep,
      AnalyzingAlgorithmTotalUEDep,
      AnalyzingAlgorithmTotalVEDep,
      NTypes // number of analyzingAlgorithmTypes available
    };

Member Function Documentation

getTypeEnum()

static AlgoritmType::Type getTypeEnum ( std::string  type )

inlinestatic

for given string name of a AlgoritmType the corresponding AlgoritmType will be returned.

For invalid types, UnknownType will be passed

Definition at line 98 of file AlgoritmType.h.

    {
      auto pos = AlgoritmType::s_fromStringToType.find(type);
      if (pos == AlgoritmType::s_fromStringToType.end()) {
        B2ERROR("AlgoritmType::getTypeName(): given iD " << type << " is not a valid AlgoritmType, return AlgoritmType::UnknownType!");
        return AlgoritmType::s_fromStringToType[std::string("UnknownType")];
      }
      return pos->second;
    }

getTypeName()

static std::string getTypeName ( AlgoritmType::Type  type )

inlinestatic

for given AlgoritmType the corresponding string-name will be returned.

For invalid types, UnknownType will be passed

Definition at line 86 of file AlgoritmType.h.

    {
      auto pos = AlgoritmType::s_fromTypeToString.find(type);
      if (pos == AlgoritmType::s_fromTypeToString.end()) {
        B2ERROR("AlgoritmType::getTypeName(): given iD " << type << " is not a valid AlgoritmType, return AlgoritmType::UnknownType!");
        return AlgoritmType::s_fromTypeToString[UnknownType];
      }
      return pos->second;
    }

isHitValueIntType()

static bool isHitValueIntType ( AlgoritmType::Type  aType )

inlinestatic

returns true if given AlgoritmType is a an algorithm which calculates a value in int based on hits of each TC passed, false if not

Definition at line 118 of file AlgoritmType.h.

    { return aType > AlgoritmType::AnalyzingAlgorithmResidualPositionXY and aType < AlgoritmType::AnalyzingAlgorithmLostUEDep; }

isHitValueVecDoubleType()

static bool isHitValueVecDoubleType ( AlgoritmType::Type  aType )

inlinestatic

returns true if given AlgoritmType is a an algorithm which calculates a value in vector< double> based on hits of each TC passed, false if not

Definition at line 122 of file AlgoritmType.h.

    { return aType > AlgoritmType::AnalyzingAlgorithmTotalVClusters and aType < AlgoritmType::NTypes; }

isResidualDoubleType()

static bool isResidualDoubleType ( AlgoritmType::Type  aType )

inlinestatic

returns true if given AlgoritmType is a an algorithm which calculates a residual in double for each TC passed, false if not

Definition at line 114 of file AlgoritmType.h.

    { return aType < AlgoritmType::AnalyzingAlgorithmLostUClusters and aType > AlgoritmType::AnalyzingAlgorithmValueQI; }

isValidName()

static bool isValidName ( std::string  type )

inlinestatic

checks if the name given is a valid name for an AlgoritmType

Definition at line 79 of file AlgoritmType.h.

    {
      return ((AlgoritmType::s_fromStringToType.find(type) == AlgoritmType::s_fromStringToType.end()) ? false : true);
    }

isValidType()

static bool isValidType ( AlgoritmType::Type  type )

inlinestatic

checks if a type given is a valid type for an AlgoritmType

Definition at line 72 of file AlgoritmType.h.

    {
      return ((AlgoritmType::s_fromTypeToString.find(type) == AlgoritmType::s_fromTypeToString.end()) ? false : true);
    }

isValueDoubleType()

static bool isValueDoubleType ( AlgoritmType::Type  aType )

inlinestatic

returns true if given AlgoritmType is a an algorithm which calculates a value in double for each TC passed, false if not

Definition at line 110 of file AlgoritmType.h.

    { return aType < AlgoritmType::AnalyzingAlgorithmResidualPX and aType > AlgoritmType::AnalyzingAlgorithmBase; }

Member Data Documentation

s_fromStringToType

std::map< std::string, Belle2::AlgoritmType::Type > s_fromStringToType

staticprotected

static map allowing translation from a given name stored as a string to its type

setting static dictionary translating string -> type

Definition at line 130 of file AlgoritmType.h.

s_fromTypeToString

std::map< Belle2::AlgoritmType::Type, std::string > s_fromTypeToString

staticprotected

static map allowing translation from a given type to its name stored as a string

setting static dictionary translating type -> string

Definition at line 127 of file AlgoritmType.h.

---

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

• tracking/trackFindingVXD/analyzingTools/include/AlgoritmType.h
• tracking/trackFindingVXD/analyzingTools/src/AlgoritmType.cc