KiTrack  1.7.0
Static Public Member Functions | List of all members
KiTrack::Criteria Class Reference

Information about all Criteria. More...

#include <Criteria.h>

Static Public Member Functions

static std::set< std::string > getTypes ()
 
static std::set< std::string > getCriteriaNames (std::string type)
 
static std::set< std::string > getAllCriteriaNames ()
 
static std::vector< std::string > getAllCriteriaNamesVec ()
 A convenience method to get all the criteria in a vector (gives the same result as getAllCriteriaNames, but instead of a set, returns it as a vector) More...
 
static ICriterioncreateCriterion (std::string critName, float min=0., float max=0.) throw (UnknownCriterion)
 Creates a Criterion with the name and the min and max values. More...
 
static void getLeftRight (std::string critName, float &left, float &right)
 Sets values for the passed referneced floats left and right. More...
 

Detailed Description

Information about all Criteria.

For example bundles the includes.

Author: Robin Glattauer, HEPHY

Member Function Documentation

ICriterion * Criteria::createCriterion ( std::string  critName,
float  min = 0.,
float  max = 0. 
)
throw (UnknownCriterion
)
static

Creates a Criterion with the name and the min and max values.

Returns
a "new" Criterion (i.e. needs to be deleted later on)

Referenced by getCriteriaNames(), and getTypes().

std::set< std::string > Criteria::getAllCriteriaNames ( )
static
Returns
the names of all Criteria in a set

Referenced by getAllCriteriaNamesVec(), getCriteriaNames(), and getTypes().

std::vector< std::string > Criteria::getAllCriteriaNamesVec ( )
static

A convenience method to get all the criteria in a vector (gives the same result as getAllCriteriaNames, but instead of a set, returns it as a vector)

Returns
the names of all Criteria in a vector

References getAllCriteriaNames().

std::set< std::string > Criteria::getCriteriaNames ( std::string  type)
static
Returns
a vector of all Criteria of a certain type
Parameters
typethe type of Criteria, that is wanted (e.g. "2Hit")

References createCriterion(), getAllCriteriaNames(), and KiTrack::ICriterion::getType().

void Criteria::getLeftRight ( std::string  critName,
float &  left,
float &  right 
)
static

Sets values for the passed referneced floats left and right.

They indicate how the specified criterion should be cut, if necessary. Say you want for example a 99% quantile, so that 99% of your true tracks are within it. A criterion like the angle between two segments then needs to define a boarder like: between an angle of 1° and of 9° there will be 99%. So 1% is outside. But should 1% be the ones with a bigger angle or with a smaller angle or should this be 50:50?

This is defined by left and right. Left is the proportion, that is taken away on the left side and right is the one that is taken away on the right side. In the case of an angle we will most probably have lots around 0° and a long tail to the right, so left = 0 and right = 1 seems like a good idea. Standard is of course 0.5 and 0.5

std::set< std::string > Criteria::getTypes ( )
static
Returns
a vector of strings that represent all types of criteria stored. For example: "2Hit" or "3Hit" or "4Hit"

References createCriterion(), getAllCriteriaNames(), and KiTrack::ICriterion::getType().


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