BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Private Attributes | List of all members
ParameterPlan Class Reference

Defines initial settings of single fit parameter and the final value which has to be found in the course of the fit. More...

Collaboration diagram for ParameterPlan:
[legend]

Public Member Functions

 ParameterPlan (const mumufit::Parameter &param, double expected_value, double tolerance=0.01)
 
double expectedValue () const
 
mumufit::Parameter fitParameter () const
 
void setTolerance (double tolerance)
 
double tolerance () const
 

Private Attributes

double m_expected_value
 expected value to find in the fit More...
 
mumufit::Parameter m_parameter
 initial parameter settings More...
 
double m_tolerance
 tolerance on found value wrt expected value More...
 

Detailed Description

Defines initial settings of single fit parameter and the final value which has to be found in the course of the fit.

Definition at line 28 of file ParameterPlan.h.

Constructor & Destructor Documentation

◆ ParameterPlan()

ParameterPlan::ParameterPlan ( const mumufit::Parameter &  param,
double  expected_value,
double  tolerance = 0.01 
)
inline

Definition at line 30 of file ParameterPlan.h.

31  : m_expected_value(expected_value), m_tolerance(tolerance), m_parameter(param)
32  {
33  }
ParameterPlan::m_expected_value
double m_expected_value
expected value to find in the fit
Definition: ParameterPlan.h:42
ParameterPlan::tolerance
double tolerance() const
Definition: ParameterPlan.h:37
ParameterPlan::m_tolerance
double m_tolerance
tolerance on found value wrt expected value
Definition: ParameterPlan.h:43
ParameterPlan::m_parameter
mumufit::Parameter m_parameter
initial parameter settings
Definition: ParameterPlan.h:44

Member Function Documentation

◆ expectedValue()

double ParameterPlan::expectedValue ( ) const
inline

Definition at line 36 of file ParameterPlan.h.

36 { return m_expected_value; }

References m_expected_value.

◆ fitParameter()

mumufit::Parameter ParameterPlan::fitParameter ( ) const
inline

Definition at line 35 of file ParameterPlan.h.

35 { return m_parameter; }

References m_parameter.

◆ setTolerance()

void ParameterPlan::setTolerance ( double  tolerance)
inline

Definition at line 39 of file ParameterPlan.h.

39 { m_tolerance = tolerance; }

References m_tolerance, and tolerance().

Here is the call graph for this function:

◆ tolerance()

double ParameterPlan::tolerance ( ) const
inline

Definition at line 37 of file ParameterPlan.h.

37 { return m_tolerance; }

References m_tolerance.

Referenced by setTolerance().

Member Data Documentation

◆ m_expected_value

double ParameterPlan::m_expected_value
private

expected value to find in the fit

Definition at line 42 of file ParameterPlan.h.

Referenced by expectedValue().

◆ m_parameter

mumufit::Parameter ParameterPlan::m_parameter
private

initial parameter settings

Definition at line 44 of file ParameterPlan.h.

Referenced by fitParameter().

◆ m_tolerance

double ParameterPlan::m_tolerance
private

tolerance on found value wrt expected value

Definition at line 43 of file ParameterPlan.h.

Referenced by setTolerance(), and tolerance().

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