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.

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.

void	setMinimumPValue (const float minimumPValue)
	Set the minimum PValue used for the convergence criterion.

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.

float	getMinimumPValue () const
	Get the minimum PValue used for the convergence criterion.

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.

float	m_MinimumPValue = 0.
	The minimum allowed pValue for the convergence criterion.

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 124 of file DAFParameters.h.

    {
      return std::tuple<float, float, int>(m_TemperatureStart, m_TemperatureFinal, m_NumberOfIterations);
    }

◆ getDeltaPValue()

float getDeltaPValue ( ) const

inline

Get the DeltaPValue for p-value convergence criterion.

Definition at line 105 of file DAFParameters.h.

    {
      return m_DeltaPValue;
    }

◆ getDeltaWeight()

float getDeltaWeight ( ) const

inline

Get the DeltaWeight for weight convergence criterion.

Definition at line 111 of file DAFParameters.h.

    {
      return m_DeltaWeight;
    }

◆ 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 150 of file DAFParameters.h.

    {
      return m_MaximumFailedHits;
    }

◆ getMaximumIterations()

int getMaximumIterations ( ) const

inline

Get the maximum number of iterations of annealing scheme.

Definition at line 136 of file DAFParameters.h.

    {
      return m_MaximumIterations;
    }

◆ getMinimumIterations()

int getMinimumIterations ( ) const

inline

Get the minimum number of iterations of annealing scheme.

Definition at line 130 of file DAFParameters.h.

    {
      return m_MinimumIterations;
    }

◆ getMinimumIterationsForPVal()

int getMinimumIterationsForPVal ( ) const

inline

Get the minimum number of iterations for pValue check.

Definition at line 142 of file DAFParameters.h.

    {
      return m_MinimumIterationsForPVal;
    }

◆ getMinimumPValue()

float getMinimumPValue ( ) const

inline

Get the minimum PValue used for the convergence criterion.

(The PValue of the two iterations must be greater than a minimum value, to be considered for the fit convergence)

Definition at line 157 of file DAFParameters.h.

    {
      return m_MinimumPValue;
    }

◆ getProbabilityCut()

float getProbabilityCut ( ) const

inline

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

Definition at line 117 of file DAFParameters.h.

    {
      return m_ProbabilityCut;
    }

◆ 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

temperaturestart	Starting temperature for annealing scheme
temperaturefinal	Final temperature for annealing scheme
numberofiterations	number of iterations for annealing scheme

Definition at line 56 of file DAFParameters.h.

    {
      m_TemperatureStart = temperaturestart;
      m_TemperatureFinal = temperaturefinal;
      m_NumberOfIterations = numberofiterations;
    }

◆ setDeltaPValue()

void setDeltaPValue ( const float pvalue )

inline

Set the DeltaPValue for p-value convergence criterion.

Parameters

pvalue Delta pvalue for convergence; [0,1]

Definition at line 33 of file DAFParameters.h.

    {
      m_DeltaPValue = pvalue;
    }

◆ setDeltaWeight()

void setDeltaWeight ( const float weight )

inline

Set the DeltaWeight for weights convergence criterion.

Parameters

weight Delta weight for convergence; [0,1]

Definition at line 40 of file DAFParameters.h.

    {
      m_DeltaWeight = weight;
    }

◆ 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

maximumfailedhits max number of failed hits

Definition at line 89 of file DAFParameters.h.

    {
      m_MaximumFailedHits = maximumfailedhits;
    }

◆ setMaximumIterations()

void setMaximumIterations ( const int maximumiterations )

inline

Set the maximum number of iterations.

Parameters

maximumiterations max number of iterations of annealing scheme We suggest to avoid setting MaxIter < NIter

Definition at line 73 of file DAFParameters.h.

    {
      m_MaximumIterations = maximumiterations;
    }

◆ setMinimumIterations()

void setMinimumIterations ( const int minimumiterations )

inline

Set the minimum number of iterations for pValue check.

Parameters

minimumiterations number of iterations for annealing scheme

Definition at line 65 of file DAFParameters.h.

    {
      m_MinimumIterations = minimumiterations;
    }

◆ setMinimumIterationsForPVal()

void setMinimumIterationsForPVal ( const int minimumiterationsforpval )

inline

Set the minimum number of iterations for pValue check.

Parameters

minimumiterationsforpval min number of iterations of annealing scheme before pvalue check

Definition at line 80 of file DAFParameters.h.

    {
      m_MinimumIterationsForPVal = minimumiterationsforpval;
    }

◆ setMinimumPValue()

void setMinimumPValue ( const float minimumPValue )

inline

Set the minimum PValue used for the convergence criterion.

(The PValue of the two iterations must be greater than a minimum value, to be considered for the fit convergence)

Parameters

minimumPValue minimum PValue

Definition at line 97 of file DAFParameters.h.

    {
      m_MinimumPValue = minimumPValue;
    }

◆ setProbabilityCut()

void setProbabilityCut ( const float probabilitycut )

inline

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

Parameters

probabilitycut probability cut used in setProbCut and addProbCut method from DAF

Definition at line 47 of file DAFParameters.h.

    {
      m_ProbabilityCut = probabilitycut;
    }

Member Data Documentation

◆ m_DeltaPValue

float m_DeltaPValue = 1

private

The DeltaPValue for p-value convergence criterion.

Definition at line 164 of file DAFParameters.h.

◆ m_DeltaWeight

float m_DeltaWeight = 0.001

private

The DeltaWeight for weights convergence criterion.

Definition at line 166 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 183 of file DAFParameters.h.

◆ m_MaximumIterations

int m_MaximumIterations = 9

private

The maximum number of iterations of annealing scheme.

Definition at line 179 of file DAFParameters.h.

◆ m_MinimumIterations

int m_MinimumIterations = 5

private

The minimum number of iterations of annealing scheme.

Definition at line 177 of file DAFParameters.h.

◆ m_MinimumIterationsForPVal

int m_MinimumIterationsForPVal = 5

private

The minimum number of iterations for pValue check.

Definition at line 181 of file DAFParameters.h.

◆ m_MinimumPValue

float m_MinimumPValue = 0.

private

The minimum allowed pValue for the convergence criterion.

Definition at line 185 of file DAFParameters.h.

◆ m_NumberOfIterations

int m_NumberOfIterations = 5

private

Number of iterations.

Definition at line 175 of file DAFParameters.h.

◆ m_ProbabilityCut

float m_ProbabilityCut = 0.001

private

The probability cut for weight calculation.

Definition at line 168 of file DAFParameters.h.

◆ m_TemperatureFinal

float m_TemperatureFinal = 0.1

private

End temperature.

Definition at line 173 of file DAFParameters.h.

◆ m_TemperatureStart

float m_TemperatureStart = 100

private

The annealing scheme : Start temperature.

Definition at line 171 of file DAFParameters.h.

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

tracking/dbobjects/include/DAFParameters.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DAFParameters()

◆ ~DAFParameters()

Member Function Documentation

◆ getAnnealingScheme()

◆ getDeltaPValue()

◆ getDeltaWeight()

◆ getMaximumFailedHits()

◆ getMaximumIterations()

◆ getMinimumIterations()

◆ getMinimumIterationsForPVal()

◆ getMinimumPValue()

◆ getProbabilityCut()

◆ setAnnealingScheme()

◆ setDeltaPValue()

◆ setDeltaWeight()

◆ setMaximumFailedHits()

◆ setMaximumIterations()

◆ setMinimumIterations()

◆ setMinimumIterationsForPVal()

◆ setMinimumPValue()

◆ setProbabilityCut()

Member Data Documentation

◆ m_DeltaPValue

◆ m_DeltaWeight

◆ m_MaximumFailedHits

◆ m_MaximumIterations

◆ m_MinimumIterations

◆ m_MinimumIterationsForPVal

◆ m_MinimumPValue

◆ m_NumberOfIterations

◆ m_ProbabilityCut

◆ m_TemperatureFinal

◆ m_TemperatureStart