SourceXtractor::FlexibleModelFittingFreeParameter Class Reference

#include <FlexibleModelFittingParameter.h>

Inheritance diagram for SourceXtractor::FlexibleModelFittingFreeParameter:

Collaboration diagram for SourceXtractor::FlexibleModelFittingFreeParameter:

Public Types
using	InitialValueFunc = std::function<double(const SourceInterface&)>

Public Member Functions
	FlexibleModelFittingFreeParameter (int id, InitialValueFunc initial_value, std::shared_ptr< FlexibleModelFittingConverterFactory > converter_factory)
std::shared_ptr< ModelFitting::BasicParameter >	create (FlexibleModelFittingParameterManager &parameter_manager, ModelFitting::EngineParameterManager &engine_manager, const SourceInterface &source) const override
std::shared_ptr< ModelFitting::BasicParameter >	create (FlexibleModelFittingParameterManager &parameter_manager, ModelFitting::EngineParameterManager &engine_manager, const SourceInterface &source, double initial_value, double current_value) const
double	getSigma (FlexibleModelFittingParameterManager &parameter_manager, const SourceInterface &source, const std::vector< double > &free_parameter_sigmas) const override
double	getInitialValue (const SourceInterface &source) const
Public Member Functions inherited from SourceXtractor::FlexibleModelFittingParameter
	FlexibleModelFittingParameter (int id)
virtual	~FlexibleModelFittingParameter ()=default
virtual int	getId () const final
Public Member Functions inherited from std::enable_shared_from_this< FlexibleModelFittingParameter >
T	enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)
T	~enable_shared_from_this (T... args)

Private Attributes
InitialValueFunc	m_initial_value
std::shared_ptr< FlexibleModelFittingConverterFactory >	m_converter_factory

Detailed Description

Definition at line 94 of file FlexibleModelFittingParameter.h.

Member Typedef Documentation

InitialValueFunc

using SourceXtractor::FlexibleModelFittingFreeParameter::InitialValueFunc = std::function<double(const SourceInterface&)>

The signature of a function providing the initial value. It gets as a parameter a source and returns the initial value.

Definition at line 99 of file FlexibleModelFittingParameter.h.

Constructor & Destructor Documentation

FlexibleModelFittingFreeParameter()

SourceXtractor::FlexibleModelFittingFreeParameter::FlexibleModelFittingFreeParameter ( int id, InitialValueFunc initial_value, std::shared_ptr< FlexibleModelFittingConverterFactory > converter_factory )

inline

Definition at line 101 of file FlexibleModelFittingParameter.h.

References SourceXtractor::FlexibleModelFittingParameter::FlexibleModelFittingParameter(), m_converter_factory, and m_initial_value.

Here is the call graph for this function:

Member Function Documentation

create() [1/2]

std::shared_ptr< ModelFitting::BasicParameter > SourceXtractor::FlexibleModelFittingFreeParameter::create ( FlexibleModelFittingParameterManager & parameter_manager, ModelFitting::EngineParameterManager & engine_manager, const SourceInterface & source ) const

overridevirtual

Implements SourceXtractor::FlexibleModelFittingParameter.

Definition at line 77 of file FlexibleModelFittingParameter.cpp.

References m_converter_factory, m_initial_value, std::make_shared(), std::move(), and ModelFitting::EngineParameterManager::registerParameter().

Here is the call graph for this function:

create() [2/2]

std::shared_ptr< ModelFitting::BasicParameter > SourceXtractor::FlexibleModelFittingFreeParameter::create	(	FlexibleModelFittingParameterManager &	parameter_manager,
		ModelFitting::EngineParameterManager &	engine_manager,
		const SourceInterface &	source,
		double	initial_value,
		double	current_value ) const

Definition at line 90 of file FlexibleModelFittingParameter.cpp.

References m_converter_factory, std::make_shared(), std::move(), and ModelFitting::EngineParameterManager::registerParameter().

Here is the call graph for this function:

getInitialValue()

double SourceXtractor::FlexibleModelFittingFreeParameter::getInitialValue

(

const SourceInterface &

source

)

const

Definition at line 108 of file FlexibleModelFittingParameter.cpp.

References m_initial_value.

getSigma()

double SourceXtractor::FlexibleModelFittingFreeParameter::getSigma ( FlexibleModelFittingParameterManager & parameter_manager, const SourceInterface & source, const std::vector< double > & free_parameter_sigmas ) const

overridevirtual

Implements SourceXtractor::FlexibleModelFittingParameter.

Definition at line 102 of file FlexibleModelFittingParameter.cpp.

References SourceXtractor::FlexibleModelFittingParameterManager::getParameter(), SourceXtractor::FlexibleModelFittingParameterManager::getParameterIndex(), and std::enable_shared_from_this< FlexibleModelFittingParameter >::shared_from_this().

Here is the call graph for this function:

Member Data Documentation

m_converter_factory

std::shared_ptr<FlexibleModelFittingConverterFactory> SourceXtractor::FlexibleModelFittingFreeParameter::m_converter_factory

private

Definition at line 126 of file FlexibleModelFittingParameter.h.

Referenced by create(), create(), and FlexibleModelFittingFreeParameter().

m_initial_value

InitialValueFunc SourceXtractor::FlexibleModelFittingFreeParameter::m_initial_value

private

Definition at line 125 of file FlexibleModelFittingParameter.h.

Referenced by create(), FlexibleModelFittingFreeParameter(), and getInitialValue().

---

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

• SEImplementation/SEImplementation/Plugin/FlexibleModelFitting/FlexibleModelFittingParameter.h
• SEImplementation/src/lib/Plugin/FlexibleModelFitting/FlexibleModelFittingParameter.cpp