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

Public Member Functions

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

Private Attributes

double m_expected_value
 
double m_tolerance
 
Fit::Parameter m_parameter
 

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 23 of file ParameterPlan.h.

Constructor & Destructor Documentation

◆ ParameterPlan()

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

Definition at line 26 of file ParameterPlan.h.

27  : m_expected_value(expected_value), m_tolerance(tolerance), m_parameter(param)
28  {
29  }
ParameterPlan::m_parameter
Fit::Parameter m_parameter
initial parameter settings
Definition: ParameterPlan.h:40
ParameterPlan::m_expected_value
double m_expected_value
expected value to find in the fit
Definition: ParameterPlan.h:38
ParameterPlan::tolerance
double tolerance() const
Definition: ParameterPlan.h:33
ParameterPlan::m_tolerance
double m_tolerance
tolerance on found value wrt expected value
Definition: ParameterPlan.h:39

Member Function Documentation

◆ fitParameter()

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

Definition at line 31 of file ParameterPlan.h.

31 { return m_parameter; }

References m_parameter.

◆ expectedValue()

double ParameterPlan::expectedValue ( ) const
inline

Definition at line 32 of file ParameterPlan.h.

32 { return m_expected_value; }

References m_expected_value.

◆ tolerance()

double ParameterPlan::tolerance ( ) const
inline

Definition at line 33 of file ParameterPlan.h.

33 { return m_tolerance; }

References m_tolerance.

Referenced by setTolerance().

◆ setTolerance()

void ParameterPlan::setTolerance ( double  tolerance)
inline

Definition at line 35 of file ParameterPlan.h.

35 { m_tolerance = tolerance; }

References m_tolerance, and tolerance().

Here is the call graph for this function:

Member Data Documentation

◆ m_expected_value

double ParameterPlan::m_expected_value
private

expected value to find in the fit

Definition at line 38 of file ParameterPlan.h.

Referenced by expectedValue().

◆ m_tolerance

double ParameterPlan::m_tolerance
private

tolerance on found value wrt expected value

Definition at line 39 of file ParameterPlan.h.

Referenced by setTolerance(), and tolerance().

◆ m_parameter

Fit::Parameter ParameterPlan::m_parameter
private

initial parameter settings

Definition at line 40 of file ParameterPlan.h.

Referenced by fitParameter().

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