Belle II Software  release-08-01-10
DAFparameters Class Reference

The payload containing the DAF parameters. More...

#include <DAFparameters.h>

Inheritance diagram for DAFparameters:
Collaboration diagram for DAFparameters:

Public Member Functions

 DAFparameters ()
 Default constructor.
 
 ~DAFparameters ()
 Destructor.
 
void setDeltaPValue (const float pvalue)
 Set the DeltaPValue for p-value convergence criterion. More...
 
void setDeltaWeight (const float weight)
 Set the DeltaWeight for weights convergence criterion. More...
 
void setProbabilityCut (const float probabilitycut)
 Set the probability cut for the weight calculation for the hits. More...
 
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. More...
 
void setMinimumIterations (const int minimumiterations)
 Set the minimum number of iterations for pValue check. More...
 
void setMaximumIterations (const int maximumiterations)
 Set the maximum number of iterations. More...
 
void setMinimumIterationsForPVal (const int minimumiterationsforpval)
 Set the minimum number of iterations for pValue check. More...
 
void setMaximumFailedHits (const int maximumfailedhits)
 Set the maximum number of failed hits after which the fit should be cancelled. More...
 
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. More...
 

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.

Member Function Documentation

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.


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