ModelFitting::SigmoidConverter Class Reference

CoordinateConverter implementation using the sigmoid function. More...

#include <SigmoidConverter.h>

Inheritance diagram for ModelFitting::SigmoidConverter:

Collaboration diagram for ModelFitting::SigmoidConverter:

Public Member Functions
	SigmoidConverter (const double min_value, const double max_value)
double	worldToEngine (const double world_value) const override
	World to engine coordinate converter.
double	engineToWorld (const double engine_value) const override
	Engine to world coordinate converter.
double	getEngineToWorldDerivative (const double value) const override
virtual	~SigmoidConverter ()
	Destructor.
Public Member Functions inherited from ModelFitting::CoordinateConverter
virtual	~CoordinateConverter ()
	Destructor.

Private Attributes
const double	m_min_value
	minimum model value in world coordinates
const double	m_max_value
	maximum model value in world coordinates

Detailed Description

CoordinateConverter implementation using the sigmoid function.

Definition at line 38 of file SigmoidConverter.h.

Constructor & Destructor Documentation

SigmoidConverter()

ModelFitting::SigmoidConverter::SigmoidConverter ( const double min_value, const double max_value )

inline

Definition at line 42 of file SigmoidConverter.h.

References m_max_value, and m_min_value.

~SigmoidConverter()

ModelFitting::SigmoidConverter::~SigmoidConverter ( )

virtualdefault

Destructor.

Member Function Documentation

engineToWorld()

double ModelFitting::SigmoidConverter::engineToWorld ( const double engine_value ) const

overridevirtual

Engine to world coordinate converter.

Parameters

engine_value

Returns

world_value

Implements ModelFitting::CoordinateConverter.

Definition at line 48 of file SigmoidConverter.cpp.

References std::exp(), m_max_value, m_min_value, std::max(), and std::min().

Here is the call graph for this function:

getEngineToWorldDerivative()

double ModelFitting::SigmoidConverter::getEngineToWorldDerivative ( const double value ) const

overridevirtual

Implements ModelFitting::CoordinateConverter.

Definition at line 53 of file SigmoidConverter.cpp.

References m_max_value, and m_min_value.

worldToEngine()

double ModelFitting::SigmoidConverter::worldToEngine ( const double world_value ) const

overridevirtual

World to engine coordinate converter.

Parameters

world_value

The value of the parameter in world coordinate

Returns

engine_value The value of the parameter in engine coordinate

Implements ModelFitting::CoordinateConverter.

Definition at line 38 of file SigmoidConverter.cpp.

References std::log(), ModelFitting::logger, m_max_value, and m_min_value.

Here is the call graph for this function:

Member Data Documentation

m_max_value

const double ModelFitting::SigmoidConverter::m_max_value

private

maximum model value in world coordinates

Definition at line 88 of file SigmoidConverter.h.

Referenced by engineToWorld(), getEngineToWorldDerivative(), SigmoidConverter(), and worldToEngine().

m_min_value

const double ModelFitting::SigmoidConverter::m_min_value

private

minimum model value in world coordinates

Definition at line 85 of file SigmoidConverter.h.

Referenced by engineToWorld(), getEngineToWorldDerivative(), SigmoidConverter(), and worldToEngine().

---

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

• ModelFitting/ModelFitting/Parameters/SigmoidConverter.h
• ModelFitting/src/lib/Parameters/SigmoidConverter.cpp