Belle II Software  release-08-01-10
MLHANDOVER_NAME< PointType, Ndims > Class Template Reference

SelectionVariable that is used for the Machine Learning (ML) based filters. More...

#include <MLHandover.h>

Inheritance diagram for MLHANDOVER_NAME< PointType, Ndims >:
Collaboration diagram for MLHANDOVER_NAME< PointType, Ndims >:

Public Types

typedef std::array< double, 9 > variableType
 Type of the returned object. More...
 
typedef PointType argumentType
 Type of the argument object. More...
 
typedef FunctionOf< Nargs, variableType, const argumentType & >::functionType functionType
 Type of the function returning the value. More...
 

Public Member Functions

 PUT_NAME_FUNCTION (MLHANDOVER_NAME)
 is replaced by "static const std:string name(void)" frunction which returns name of the Class
 

Static Public Member Functions

static std::array< double, Ndims > value (const PointType &innerHit, const PointType &centerHit, const PointType &outerHit)
 Getter for coordinate values of the three hits used in a three hit filter. More...
 
static variableType value (const PointType &arg1, const PointType &arg2)
 Static method that return the variable associated to: More...
 

Static Public Attributes

static const size_t c_Nargs
 Number of arguments.
 

Detailed Description

template<typename PointType, size_t Ndims = 9>
class Belle2::MLHANDOVER_NAME< PointType, Ndims >

SelectionVariable that is used for the Machine Learning (ML) based filters.

Does nothing else than handing over the 3x3 git coordinates to the MLRange, where all the ML magic happens. This has to be done this way since this class provides only a static function and we need different instances of ML classifiers. We do however have access to the constructor of the Range classes.

Definition at line 30 of file MLHandover.h.

Member Typedef Documentation

◆ argumentType

typedef PointType argumentType
inherited

Type of the argument object.

Needed for SFINAE in Filter.hh

Definition at line 84 of file SelectionVariable.h.

◆ functionType

typedef FunctionOf<Nargs, variableType, const argumentType&>::functionType functionType
inherited

Type of the function returning the value.

Needed for the automated training

Definition at line 88 of file SelectionVariable.h.

◆ variableType

typedef std::array< double, 9 > variableType
inherited

Type of the returned object.

Needed for SFINAE in Filter.hh

Definition at line 81 of file SelectionVariable.h.

Member Function Documentation

◆ value() [1/2]

static variableType value ( const PointType &  arg1,
const PointType &  arg2 
)
inlinestaticinherited

Static method that return the variable associated to:

Parameters
arg1first object of the pair
arg2second object of the pair

N.B. this method must be static.

◆ value() [2/2]

static std::array<double, Ndims> value ( const PointType &  innerHit,
const PointType &  centerHit,
const PointType &  outerHit 
)
inlinestatic

Getter for coordinate values of the three hits used in a three hit filter.

Parameters
innerHit: the inner hit
centerHit: the center hit
outerHit: the outer hit
Returns
array containing the coordinates of the three hits in the order x, y, z for inner, x, y, y for center, outer

Definition at line 43 of file MLHandover.h.

44  {
45  return std::array<double, Ndims> {{
46  innerHit.X(), innerHit.Y(), innerHit.Z(),
47  centerHit.X(), centerHit.Y(), centerHit.Z(),
48  outerHit.X(), outerHit.Y(), outerHit.Z()
49  }
50  };
51  }

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