ModelFitting::WorldValueResidual Class Reference

ResidualBlockProvider implementation for adding a prior to a parameter world value. More...

#include <WorldValueResidual.h>

Inheritance diagram for ModelFitting::WorldValueResidual:

Collaboration diagram for ModelFitting::WorldValueResidual:

Public Member Functions
	WorldValueResidual (std::shared_ptr< BasicParameter > parameter, double expected_value, double weight=1.)
	Constructs a new instance of WorldValueResidual.
virtual	~WorldValueResidual ()
	Destructor.
std::size_t	numberOfResiduals () const override
	Always returns 1, as this class creates a single residual.
void	populateResidualBlock (IterType output_iter) override
Public Member Functions inherited from ModelFitting::ResidualBlockProvider
virtual	~ResidualBlockProvider ()=default
	Destructor.

Private Attributes
std::shared_ptr< BasicParameter >	m_parameter
std::size_t	m_observer_id
double	m_residual

Additional Inherited Members
Public Types inherited from ModelFitting::ResidualBlockProvider
using	IterType = double*

Detailed Description

ResidualBlockProvider implementation for adding a prior to a parameter world value.

The residual is calculated as:

\[ r = w*(P_c-P_p) \]

where:

• \(w\): is the weight of the residual
• \(P_c\): is the current world value of the parameter
• \(P_p\): is the prior expected world value of the parameter

Definition at line 46 of file WorldValueResidual.h.

Constructor & Destructor Documentation

WorldValueResidual()

ModelFitting::WorldValueResidual::WorldValueResidual	(	std::shared_ptr< BasicParameter >	parameter,
		double	expected_value,
		double	weight = 1. )

Constructs a new instance of WorldValueResidual.

Note that this class will add an observer to the parameter which requires that the WorldValueResidual instance is still alive when it is called. For this reason, any updates of a parameter value after a related WorldValueResidual is deleted, leeds to undefined behavior.

Parameters

parameter	A reference to the parameter the residual is calculated for
expected_value	The prior expected world value
weight	The weight or the residual

Definition at line 35 of file WorldValueResidual.cpp.

References ModelFitting::computeResidual(), m_observer_id, m_parameter, and m_residual.

Here is the call graph for this function:

~WorldValueResidual()

ModelFitting::WorldValueResidual::~WorldValueResidual ( )

virtual

Destructor.

Definition at line 27 of file WorldValueResidual.cpp.

References m_observer_id, and m_parameter.

Member Function Documentation

numberOfResiduals()

std::size_t ModelFitting::WorldValueResidual::numberOfResiduals ( ) const

overridevirtual

Always returns 1, as this class creates a single residual.

Implements ModelFitting::ResidualBlockProvider.

Definition at line 45 of file WorldValueResidual.cpp.

populateResidualBlock()

void ModelFitting::WorldValueResidual::populateResidualBlock ( IterType output_iter )

overridevirtual

Updates the value where the iterator points with the value of the residual for the current value of the parameter

Implements ModelFitting::ResidualBlockProvider.

Definition at line 49 of file WorldValueResidual.cpp.

References m_residual.

Member Data Documentation

m_observer_id

std::size_t ModelFitting::WorldValueResidual::m_observer_id

private

Definition at line 81 of file WorldValueResidual.h.

Referenced by WorldValueResidual(), and ~WorldValueResidual().

m_parameter

std::shared_ptr<BasicParameter> ModelFitting::WorldValueResidual::m_parameter

private

Definition at line 80 of file WorldValueResidual.h.

Referenced by WorldValueResidual(), and ~WorldValueResidual().

m_residual

double ModelFitting::WorldValueResidual::m_residual

private

Definition at line 83 of file WorldValueResidual.h.

Referenced by populateResidualBlock(), and WorldValueResidual().

---

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

• ModelFitting/ModelFitting/Engine/WorldValueResidual.h
• ModelFitting/src/lib/Engine/WorldValueResidual.cpp