Belle II Software development
DAFparameters Class Reference

The payload containing the DAF parameters. More...

#include <DAFparameters.h>

Inheritance diagram for DAFparameters:

Public Member Functions

 DAFparameters ()
 Default constructor.
 
 ~DAFparameters ()
 Destructor.
 
void setDeltaPValue (const float pvalue)
 Set the DeltaPValue for p-value convergence criterion.
 
void setDeltaWeight (const float weight)
 Set the DeltaWeight for weights convergence criterion.
 
void setProbabilityCut (const float probabilitycut)
 Set the probability cut for the weight calculation for the hits.
 
void setAnnealingScheme (const float temperaturestart, const float temperaturefinal, const int numberofiterations)
 Set the start and end temperatures, and the number of iterations for the annealing scheme.
 
void setMinimumIterations (const int minimumiterations)
 Set the minimum number of iterations for pValue check.
 
void setMaximumIterations (const int maximumiterations)
 Set the maximum number of iterations.
 
void setMinimumIterationsForPVal (const int minimumiterationsforpval)
 Set the minimum number of iterations for pValue check.
 
void setMaximumFailedHits (const int maximumfailedhits)
 Set the maximum number of failed hits after which the fit should be cancelled.
 
float getDeltaPValue () const
 Get the DeltaPValue for p-value convergence criterion.
 
float getDeltaWeight () const
 Get the DeltaWeight for weight convergence criterion.
 
float getProbabilityCut () const
 Get the probability cut for the weight calculation for the hits.
 
std::tuple< float, float, int > getAnnealingScheme () const
 Get the start and end temperatures and number of iterations for the annealing scheme returns a tuple with the elements in the following order: (TStart, TEnd, NIter)
 
int getMinimumIterations () const
 Get the minimum number of iterations of annealing scheme.
 
int getMaximumIterations () const
 Get the maximum number of iterations of annealing scheme.
 
int getMinimumIterationsForPVal () const
 Get the minimum number of iterations for pValue check.
 
int getMaximumFailedHits () const
 Get the maximum number of failed hits after which the fit should be cancelled.
 

Private Member Functions

 ClassDef (DAFparameters, 1)
 ClassDef, necessary for ROOT.
 

Private Attributes

float m_DeltaPValue = 1
 The DeltaPValue for p-value convergence criterion.
 
float m_DeltaWeight = 0.001
 The DeltaWeight for weights convergence criterion.
 
float m_ProbabilityCut = 0.001
 The probability cut for weight calculation.
 
float m_TemperatureStart = 100
 The annealing scheme : Start temperature.
 
float m_TemperatureFinal = 0.1
 End temperature.
 
int m_NumberOfIterations = 5
 Number of iterations.
 
int m_MinimumIterations = 5
 The minimum number of iterations of annealing scheme.
 
int m_MaximumIterations = 9
 The maximum number of iterations of annealing scheme.
 
int m_MinimumIterationsForPVal = 5
 The minimum number of iterations for pValue check.
 
int m_MaximumFailedHits = 5
 The maximum number of failed hits after which the fit should be cancelled.
 

Detailed Description

The payload containing the DAF parameters.

Definition at line 21 of file DAFparameters.h.

Constructor & Destructor Documentation

◆ DAFparameters()

DAFparameters ( )
inline

Default constructor.

Definition at line 26 of file DAFparameters.h.

26{}

◆ ~DAFparameters()

~DAFparameters ( )
inline

Destructor.

Definition at line 28 of file DAFparameters.h.

28{}

Member Function Documentation

◆ getAnnealingScheme()

std::tuple< float, float, int > getAnnealingScheme ( ) const
inline

Get the start and end temperatures and number of iterations for the annealing scheme returns a tuple with the elements in the following order: (TStart, TEnd, NIter)

Definition at line 117 of file DAFparameters.h.

118 {
119 return std::tuple<float, float, int>(m_TemperatureStart, m_TemperatureFinal, m_NumberOfIterations);
120 }
float m_TemperatureStart
The annealing scheme : Start temperature.
float m_TemperatureFinal
End temperature.
int m_NumberOfIterations
Number of iterations.

◆ getDeltaPValue()

float getDeltaPValue ( ) const
inline

Get the DeltaPValue for p-value convergence criterion.

Definition at line 98 of file DAFparameters.h.

99 {
100 return m_DeltaPValue;
101 }
float m_DeltaPValue
The DeltaPValue for p-value convergence criterion.

◆ getDeltaWeight()

float getDeltaWeight ( ) const
inline

Get the DeltaWeight for weight convergence criterion.

Definition at line 104 of file DAFparameters.h.

105 {
106 return m_DeltaWeight;
107 }
float m_DeltaWeight
The DeltaWeight for weights convergence criterion.

◆ getMaximumFailedHits()

int getMaximumFailedHits ( ) const
inline

Get the maximum number of failed hits after which the fit should be cancelled.

(exception during construction of plane, extrapolation etc.) -1 means don't cancel

Definition at line 143 of file DAFparameters.h.

144 {
145 return m_MaximumFailedHits;
146 }
int m_MaximumFailedHits
The maximum number of failed hits after which the fit should be cancelled.

◆ getMaximumIterations()

int getMaximumIterations ( ) const
inline

Get the maximum number of iterations of annealing scheme.

Definition at line 129 of file DAFparameters.h.

130 {
131 return m_MaximumIterations;
132 }
int m_MaximumIterations
The maximum number of iterations of annealing scheme.

◆ getMinimumIterations()

int getMinimumIterations ( ) const
inline

Get the minimum number of iterations of annealing scheme.

Definition at line 123 of file DAFparameters.h.

124 {
125 return m_MinimumIterations;
126 }
int m_MinimumIterations
The minimum number of iterations of annealing scheme.

◆ getMinimumIterationsForPVal()

int getMinimumIterationsForPVal ( ) const
inline

Get the minimum number of iterations for pValue check.

Definition at line 135 of file DAFparameters.h.

136 {
138 }
int m_MinimumIterationsForPVal
The minimum number of iterations for pValue check.

◆ getProbabilityCut()

float getProbabilityCut ( ) const
inline

Get the probability cut for the weight calculation for the hits.

Definition at line 110 of file DAFparameters.h.

111 {
112 return m_ProbabilityCut;
113 }
float m_ProbabilityCut
The probability cut for weight calculation.

◆ setAnnealingScheme()

void setAnnealingScheme ( const float  temperaturestart,
const float  temperaturefinal,
const int  numberofiterations 
)
inline

Set the start and end temperatures, and the number of iterations for the annealing scheme.

Parameters
temperaturestartStarting temperature for annealing scheme
temperaturefinalFinal temperature for annealing scheme
numberofiterationsnumber of iterations for annealing scheme

Definition at line 56 of file DAFparameters.h.

57 {
58 m_TemperatureStart = temperaturestart;
59 m_TemperatureFinal = temperaturefinal;
60 m_NumberOfIterations = numberofiterations;
61 }

◆ setDeltaPValue()

void setDeltaPValue ( const float  pvalue)
inline

Set the DeltaPValue for p-value convergence criterion.

Parameters
pvalueDelta pvalue for convergence; [0,1]

Definition at line 33 of file DAFparameters.h.

34 {
35 m_DeltaPValue = pvalue;
36 }

◆ setDeltaWeight()

void setDeltaWeight ( const float  weight)
inline

Set the DeltaWeight for weights convergence criterion.

Parameters
weightDelta weight for convergence; [0,1]

Definition at line 40 of file DAFparameters.h.

41 {
42 m_DeltaWeight = weight;
43 }

◆ setMaximumFailedHits()

void setMaximumFailedHits ( const int  maximumfailedhits)
inline

Set the maximum number of failed hits after which the fit should be cancelled.

(exception during construction of plane, extrapolation etc.) -1 means don't cancel

Parameters
maximumfailedhitsmax number of failed hits

Definition at line 89 of file DAFparameters.h.

90 {
91 m_MaximumFailedHits = maximumfailedhits;
92 }

◆ setMaximumIterations()

void setMaximumIterations ( const int  maximumiterations)
inline

Set the maximum number of iterations.

Parameters
maximumiterationsmax number of iterations of annealing scheme We suggest to avoid setting MaxIter < NIter

Definition at line 73 of file DAFparameters.h.

74 {
75 m_MaximumIterations = maximumiterations;
76 }

◆ setMinimumIterations()

void setMinimumIterations ( const int  minimumiterations)
inline

Set the minimum number of iterations for pValue check.

Parameters
minimumiterationsnumber of iterations for annealing scheme

Definition at line 65 of file DAFparameters.h.

66 {
67 m_MinimumIterations = minimumiterations;
68 }

◆ setMinimumIterationsForPVal()

void setMinimumIterationsForPVal ( const int  minimumiterationsforpval)
inline

Set the minimum number of iterations for pValue check.

Parameters
minimumiterationsforpvalmin number of iterations of annealing scheme before pvalue check

Definition at line 80 of file DAFparameters.h.

81 {
82 m_MinimumIterationsForPVal = minimumiterationsforpval;
83 }

◆ setProbabilityCut()

void setProbabilityCut ( const float  probabilitycut)
inline

Set the probability cut for the weight calculation for the hits.

Parameters
probabilitycutprobability cut used in setProbCut and addProbCut method from DAF

Definition at line 47 of file DAFparameters.h.

48 {
49 m_ProbabilityCut = probabilitycut;
50 }

Member Data Documentation

◆ m_DeltaPValue

float m_DeltaPValue = 1
private

The DeltaPValue for p-value convergence criterion.

Definition at line 150 of file DAFparameters.h.

◆ m_DeltaWeight

float m_DeltaWeight = 0.001
private

The DeltaWeight for weights convergence criterion.

Definition at line 152 of file DAFparameters.h.

◆ m_MaximumFailedHits

int m_MaximumFailedHits = 5
private

The maximum number of failed hits after which the fit should be cancelled.

Definition at line 169 of file DAFparameters.h.

◆ m_MaximumIterations

int m_MaximumIterations = 9
private

The maximum number of iterations of annealing scheme.

Definition at line 165 of file DAFparameters.h.

◆ m_MinimumIterations

int m_MinimumIterations = 5
private

The minimum number of iterations of annealing scheme.

Definition at line 163 of file DAFparameters.h.

◆ m_MinimumIterationsForPVal

int m_MinimumIterationsForPVal = 5
private

The minimum number of iterations for pValue check.

Definition at line 167 of file DAFparameters.h.

◆ m_NumberOfIterations

int m_NumberOfIterations = 5
private

Number of iterations.

Definition at line 161 of file DAFparameters.h.

◆ m_ProbabilityCut

float m_ProbabilityCut = 0.001
private

The probability cut for weight calculation.

Definition at line 154 of file DAFparameters.h.

◆ m_TemperatureFinal

float m_TemperatureFinal = 0.1
private

End temperature.

Definition at line 159 of file DAFparameters.h.

◆ m_TemperatureStart

float m_TemperatureStart = 100
private

The annealing scheme : Start temperature.

Definition at line 157 of file DAFparameters.h.


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