Base cost function class to handle maximum likelihood estimation. More...

#include <animaBaseMCMCost.h>

Inheritance diagram for anima::BaseMCMCost:

Collaboration diagram for anima::BaseMCMCost:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::Array2D< double >	DerivativeMatrixType

typedef itk::Array< double >	DerivativeType

typedef MCMType::ListType	ListType

typedef MCMType::Pointer	MCMPointer

typedef anima::MultiCompartmentModel	MCMType

typedef itk::Array< double >	MeasureType

typedef itk::OptimizerParameters< double >	ParametersType

typedef itk::SmartPointer< Self >	Pointer

typedef BaseMCMCost	Self

typedef itk::LightObject	Superclass

typedef MCMType::Vector3DType	Vector3DType

Public Member Functions
virtual double	GetCurrentCostValue ()=0
	For the current set of parameters, compute the cost function value, requires GetValues to be called first. More...

virtual void	GetCurrentDerivative (DerivativeMatrixType &derivativeMatrix, DerivativeType &derivative)=0
	Get cost function derivatives from a derivative matrix obtained from GetDerivativeMatrix. More...

virtual void	GetDerivativeMatrix (const ParametersType &parameters, DerivativeMatrixType &derivative)=0
	Get residual derivatives for a given set of parameters, returns a matrix of residuals derivatives. More...

MCMPointer &	GetMCMStructure ()

virtual const char *	GetNameOfClass () const

unsigned int	GetNumberOfObservations () const

unsigned int	GetNumberOfParameters () const
	Returns number of optimized parameters. More...

virtual double	GetSigmaSquare ()

virtual MeasureType	GetValues (const ParametersType &parameters)=0
	Get residual values for a given set of parameters, returns a vector of residuals. More...

void	SetBigDelta (double val)

void	SetGradients (std::vector< Vector3DType > &value)

void	SetGradientStrengths (ListType &value)

void	SetMCMStructure (MCMType *model)

void	SetObservedSignals (ListType &value)

void	SetSmallDelta (double val)

Protected Member Functions
	BaseMCMCost ()

virtual	~BaseMCMCost ()

Protected Attributes
double	m_BigDelta

std::vector< Vector3DType >	m_Gradients

ListType	m_GradientStrengths

MCMPointer	m_MCMStructure

ListType	m_ObservedSignals

std::vector< double >	m_PredictedSignals

double	m_SigmaSquare

double	m_SmallDelta

ListType	m_TestedParameters

Detailed Description

Base cost function class to handle maximum likelihood estimation.

Definition at line 16 of file animaBaseMCMCost.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> anima::BaseMCMCost::ConstPointer

Definition at line 23 of file animaBaseMCMCost.h.

◆ DerivativeMatrixType

typedef itk::Array2D<double> anima::BaseMCMCost::DerivativeMatrixType

Definition at line 28 of file animaBaseMCMCost.h.

◆ DerivativeType

typedef itk::Array<double> anima::BaseMCMCost::DerivativeType

Definition at line 30 of file animaBaseMCMCost.h.

◆ ListType

typedef MCMType::ListType anima::BaseMCMCost::ListType

Definition at line 36 of file animaBaseMCMCost.h.

◆ MCMPointer

typedef MCMType::Pointer anima::BaseMCMCost::MCMPointer

Definition at line 34 of file animaBaseMCMCost.h.

◆ MCMType

typedef anima::MultiCompartmentModel anima::BaseMCMCost::MCMType

Definition at line 33 of file animaBaseMCMCost.h.

◆ MeasureType

typedef itk::Array<double> anima::BaseMCMCost::MeasureType

Definition at line 29 of file animaBaseMCMCost.h.

◆ ParametersType

typedef itk::OptimizerParameters<double> anima::BaseMCMCost::ParametersType

Definition at line 31 of file animaBaseMCMCost.h.

◆ Pointer

typedef itk::SmartPointer<Self> anima::BaseMCMCost::Pointer

Definition at line 22 of file animaBaseMCMCost.h.

◆ Self

typedef BaseMCMCost anima::BaseMCMCost::Self

Standard class typedefs.

Definition at line 20 of file animaBaseMCMCost.h.

◆ Superclass

typedef itk::LightObject anima::BaseMCMCost::Superclass

Definition at line 21 of file animaBaseMCMCost.h.

◆ Vector3DType

typedef MCMType::Vector3DType anima::BaseMCMCost::Vector3DType

Definition at line 35 of file animaBaseMCMCost.h.

Constructor & Destructor Documentation

◆ BaseMCMCost()

anima::BaseMCMCost::BaseMCMCost ( )

protected

Definition at line 7 of file animaBaseMCMCost.cxx.

References anima::DiffusionBigDelta, anima::DiffusionSmallDelta, m_BigDelta, m_SigmaSquare, and m_SmallDelta.

◆ ~BaseMCMCost()

virtual anima::BaseMCMCost::~BaseMCMCost ( )

inlineprotectedvirtual

Definition at line 78 of file animaBaseMCMCost.h.

Member Function Documentation

◆ GetCurrentCostValue()

virtual double anima::BaseMCMCost::GetCurrentCostValue ( )

pure virtual

For the current set of parameters, compute the cost function value, requires GetValues to be called first.

Implemented in anima::GaussianMCMVariableProjectionCost, and anima::GaussianMCMCost.

◆ GetCurrentDerivative()

virtual void anima::BaseMCMCost::GetCurrentDerivative	(	DerivativeMatrixType &	derivativeMatrix,
		DerivativeType &	derivative
	)

pure virtual

Get cost function derivatives from a derivative matrix obtained from GetDerivativeMatrix.

Implemented in anima::GaussianMCMVariableProjectionCost, and anima::GaussianMCMCost.

◆ GetDerivativeMatrix()

virtual void anima::BaseMCMCost::GetDerivativeMatrix	(	const ParametersType &	parameters,
		DerivativeMatrixType &	derivative
	)

pure virtual

Get residual derivatives for a given set of parameters, returns a matrix of residuals derivatives.

Implemented in anima::GaussianMCMVariableProjectionCost, and anima::GaussianMCMCost.

◆ GetMCMStructure()

MCMPointer& anima::BaseMCMCost::GetMCMStructure ( )

inline

Definition at line 43 of file animaBaseMCMCost.h.

Referenced by anima::MCMSingleValuedCostFunction::GetMCMStructure(), and anima::MCMMultipleValuedCostFunction::GetMCMStructure().

◆ GetNameOfClass()

virtual const char* anima::BaseMCMCost::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented in anima::GaussianMCMVariableProjectionCost, and anima::GaussianMCMCost.

◆ GetNumberOfObservations()

unsigned int anima::BaseMCMCost::GetNumberOfObservations ( ) const

inline

Definition at line 66 of file animaBaseMCMCost.h.

◆ GetNumberOfParameters()

unsigned int anima::BaseMCMCost::GetNumberOfParameters ( ) const

inline

Returns number of optimized parameters.

Definition at line 58 of file animaBaseMCMCost.h.

◆ GetSigmaSquare()

virtual double anima::BaseMCMCost::GetSigmaSquare ( )

inlinevirtual

Definition at line 71 of file animaBaseMCMCost.h.

◆ GetValues()

virtual MeasureType anima::BaseMCMCost::GetValues ( const ParametersType & parameters )

pure virtual

Get residual values for a given set of parameters, returns a vector of residuals.

Implemented in anima::GaussianMCMVariableProjectionCost, and anima::GaussianMCMCost.

◆ SetBigDelta()

void anima::BaseMCMCost::SetBigDelta ( double val )

inline

Definition at line 74 of file animaBaseMCMCost.h.

◆ SetGradients()

void anima::BaseMCMCost::SetGradients ( std::vector< Vector3DType > & value )

inline

Definition at line 39 of file animaBaseMCMCost.h.

◆ SetGradientStrengths()

void anima::BaseMCMCost::SetGradientStrengths ( ListType & value )

inline

Definition at line 40 of file animaBaseMCMCost.h.

◆ SetMCMStructure()

void anima::BaseMCMCost::SetMCMStructure ( MCMType * model )

inline

Definition at line 42 of file animaBaseMCMCost.h.

◆ SetObservedSignals()

void anima::BaseMCMCost::SetObservedSignals ( ListType & value )

inline

Definition at line 38 of file animaBaseMCMCost.h.

◆ SetSmallDelta()

void anima::BaseMCMCost::SetSmallDelta ( double val )

inline

Definition at line 73 of file animaBaseMCMCost.h.

Member Data Documentation

◆ m_BigDelta

double anima::BaseMCMCost::m_BigDelta

protected

Definition at line 89 of file animaBaseMCMCost.h.

Referenced by BaseMCMCost(), anima::GaussianMCMCost::GetDerivativeMatrix(), anima::GaussianMCMCost::GetValues(), anima::GaussianMCMVariableProjectionCost::PrepareDataForDerivative(), and anima::GaussianMCMVariableProjectionCost::PrepareDataForLLS().

◆ m_Gradients

std::vector<Vector3DType> anima::BaseMCMCost::m_Gradients

protected

Definition at line 86 of file animaBaseMCMCost.h.

Referenced by anima::GaussianMCMCost::GetDerivativeMatrix(), anima::GaussianMCMCost::GetValues(), anima::GaussianMCMVariableProjectionCost::PrepareDataForDerivative(), anima::GaussianMCMVariableProjectionCost::PrepareDataForLLS(), and anima::GaussianMCMVariableProjectionCost::SolveLinearLeastSquares().

◆ m_GradientStrengths

ListType anima::BaseMCMCost::m_GradientStrengths

protected

Definition at line 90 of file animaBaseMCMCost.h.

Referenced by anima::GaussianMCMCost::GetDerivativeMatrix(), anima::GaussianMCMCost::GetValues(), anima::GaussianMCMVariableProjectionCost::PrepareDataForDerivative(), and anima::GaussianMCMVariableProjectionCost::PrepareDataForLLS().

◆ m_MCMStructure

MCMPointer anima::BaseMCMCost::m_MCMStructure

protected

Definition at line 92 of file animaBaseMCMCost.h.

Referenced by anima::GaussianMCMCost::GetDerivativeMatrix(), anima::GaussianMCMCost::GetValues(), anima::GaussianMCMVariableProjectionCost::GetValues(), anima::GaussianMCMVariableProjectionCost::PrepareDataForDerivative(), and anima::GaussianMCMVariableProjectionCost::PrepareDataForLLS().

◆ m_ObservedSignals

ListType anima::BaseMCMCost::m_ObservedSignals

protected

Definition at line 85 of file animaBaseMCMCost.h.

Referenced by anima::GaussianMCMCost::GetDerivativeMatrix(), anima::GaussianMCMVariableProjectionCost::GetDerivativeMatrix(), anima::GaussianMCMCost::GetValues(), anima::GaussianMCMVariableProjectionCost::PrepareDataForLLS(), and anima::GaussianMCMVariableProjectionCost::SolveLinearLeastSquares().

◆ m_PredictedSignals

std::vector<double> anima::BaseMCMCost::m_PredictedSignals

protected

Definition at line 81 of file animaBaseMCMCost.h.

Referenced by anima::GaussianMCMCost::GetValues().

◆ m_SigmaSquare

double anima::BaseMCMCost::m_SigmaSquare

protected

Definition at line 80 of file animaBaseMCMCost.h.

Referenced by BaseMCMCost(), anima::GaussianMCMCost::GetCurrentCostValue(), anima::GaussianMCMVariableProjectionCost::GetCurrentCostValue(), anima::GaussianMCMCost::GetCurrentDerivative(), anima::GaussianMCMVariableProjectionCost::GetCurrentDerivative(), anima::GaussianMCMCost::GetValues(), and anima::GaussianMCMVariableProjectionCost::SolveLinearLeastSquares().

◆ m_SmallDelta

double anima::BaseMCMCost::m_SmallDelta

protected

Definition at line 88 of file animaBaseMCMCost.h.

Referenced by BaseMCMCost(), anima::GaussianMCMCost::GetDerivativeMatrix(), anima::GaussianMCMCost::GetValues(), anima::GaussianMCMVariableProjectionCost::PrepareDataForDerivative(), and anima::GaussianMCMVariableProjectionCost::PrepareDataForLLS().

◆ m_TestedParameters

ListType anima::BaseMCMCost::m_TestedParameters

protected

Definition at line 83 of file animaBaseMCMCost.h.

Referenced by anima::GaussianMCMCost::GetDerivativeMatrix(), anima::GaussianMCMVariableProjectionCost::GetDerivativeMatrix(), anima::GaussianMCMCost::GetValues(), and anima::GaussianMCMVariableProjectionCost::GetValues().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ DerivativeMatrixType

◆ DerivativeType

◆ ListType

◆ MCMPointer

◆ MCMType

◆ MeasureType

◆ ParametersType

◆ Pointer

◆ Self

◆ Superclass

◆ Vector3DType

Constructor & Destructor Documentation

◆ BaseMCMCost()

◆ ~BaseMCMCost()

Member Function Documentation

◆ GetCurrentCostValue()

◆ GetCurrentDerivative()

◆ GetDerivativeMatrix()

◆ GetMCMStructure()

◆ GetNameOfClass()

◆ GetNumberOfObservations()

◆ GetNumberOfParameters()

◆ GetSigmaSquare()

◆ GetValues()

◆ SetBigDelta()

◆ SetGradients()

◆ SetGradientStrengths()

◆ SetMCMStructure()

◆ SetObservedSignals()

◆ SetSmallDelta()

Member Data Documentation

◆ m_BigDelta

◆ m_Gradients

◆ m_GradientStrengths

◆ m_MCMStructure

◆ m_ObservedSignals

◆ m_PredictedSignals

◆ m_SigmaSquare

◆ m_SmallDelta

◆ m_TestedParameters