SourceXtractorPlusPlus  0.15
Please provide a description of the project.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
ModelFitting::EngineParameter Class Reference

EngineParameter are those derived from the minimization process. More...

#include <EngineParameter.h>

Inheritance diagram for ModelFitting::EngineParameter:
[legend]
Collaboration diagram for ModelFitting::EngineParameter:
[legend]

Public Member Functions

 EngineParameter (const double world_value, std::unique_ptr< CoordinateConverter > converter)
 
double getEngineValue () const
 
void setEngineValue (const double engine_value)
 
double getEngineToWorldDerivative () const
 
void setValue (const double value) override
 
- Public Member Functions inherited from ModelFitting::BasicParameter
virtual ~BasicParameter ()
 
 BasicParameter (const BasicParameter &)=delete
 
BasicParameteroperator= (const BasicParameter &)=delete
 
 BasicParameter (BasicParameter &&)=delete
 
BasicParameteroperator= (BasicParameter &&)=delete
 
virtual double getValue () const
 
std::size_t addObserver (ParameterObserver observer)
 The addObserver method adding observer to the member list. More...
 
bool removeObserver (std::size_t id)
 
bool isObserved () const
 

Private Attributes

double m_engine_value
 The parameter value in Engine coordinates. More...
 
std::unique_ptr
< CoordinateConverter
m_converter
 The parameter converter. More...
 

Additional Inherited Members

- Public Types inherited from ModelFitting::BasicParameter
using ParameterObserver = std::function< void(double)>
 
- Protected Types inherited from ModelFitting::BasicParameter
typedef std::function< void(void)> GetValueHook
 
- Protected Member Functions inherited from ModelFitting::BasicParameter
 BasicParameter (const double value)
 
- Protected Attributes inherited from ModelFitting::BasicParameter
GetValueHook m_get_value_hook
 
double m_value
 

Detailed Description

EngineParameter are those derived from the minimization process.

EngineParameter is an extension of the BasicParameter class, involving coordinate transformation. It provides parameters with unbounded range which can be better handled in the minimization process. The "engine" terminology is in opposition with the "world" one, referring to parameter in physical units. Different possible conversions are implemented through the CoordinateConverter abstract base class.

Definition at line 47 of file EngineParameter.h.

Constructor & Destructor Documentation

ModelFitting::EngineParameter::EngineParameter ( const double  world_value,
std::unique_ptr< CoordinateConverter converter 
)
inline

Definition at line 51 of file EngineParameter.h.

Member Function Documentation

double ModelFitting::EngineParameter::getEngineToWorldDerivative ( ) const

Definition at line 35 of file EngineParameter.cpp.

double ModelFitting::EngineParameter::getEngineValue ( ) const
inline

Definition at line 56 of file EngineParameter.h.

References m_engine_value.

Referenced by ModelFitting::EngineValueResidual::EngineValueResidual().

void ModelFitting::EngineParameter::setEngineValue ( const double  engine_value)

Definition at line 30 of file EngineParameter.cpp.

References ModelFitting::BasicParameter::setValue().

Referenced by SourceXtractor::FlexibleModelFittingTask::computeProperties().

Here is the call graph for this function:

void ModelFitting::EngineParameter::setValue ( const double  value)
overridevirtual

Reimplemented from ModelFitting::BasicParameter.

Definition at line 39 of file EngineParameter.cpp.

References ModelFitting::BasicParameter::setValue().

Here is the call graph for this function:

Member Data Documentation

std::unique_ptr<CoordinateConverter> ModelFitting::EngineParameter::m_converter
private

The parameter converter.

Definition at line 72 of file EngineParameter.h.

double ModelFitting::EngineParameter::m_engine_value
private

The parameter value in Engine coordinates.

Definition at line 69 of file EngineParameter.h.

Referenced by getEngineValue().


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