ANIMA  4.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
anima::GaussianMCMCost Class Reference

Class for computing marginal and profile costs and derivatives. This is not thread safe at all so be sure to intantiate one per thread. More...

#include <animaGaussianMCMCost.h>

+ Inheritance diagram for anima::GaussianMCMCost:
+ Collaboration diagram for anima::GaussianMCMCost:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef GaussianMCMCost Self
 
typedef anima::BaseMCMCost Superclass
 
- Public Types inherited from anima::BaseMCMCost
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef BaseMCMCost Self
 
typedef itk::LightObject Superclass
 
typedef MCMType::Vector3DType Vector3DType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
double GetCurrentCostValue () ITK_OVERRIDE
 For the current set of parameters, compute the cost function value, requires GetValues to be called first. More...
 
void GetCurrentDerivative (DerivativeMatrixType &derivativeMatrix, DerivativeType &derivative) ITK_OVERRIDE
 Get cost function derivatives from a derivative matrix obtained from GetDerivativeMatrix. More...
 
void GetDerivativeMatrix (const ParametersType &parameters, DerivativeMatrixType &derivative) ITK_OVERRIDE
 Get residual derivatives for a given set of parameters, returns a matrix of residuals derivatives. More...
 
virtual const char * GetNameOfClass () const
 
MeasureType GetValues (const ParametersType &parameters) ITK_OVERRIDE
 Get residual values for a given set of parameters, returns a vector of residuals. More...
 
void SetMarginalEstimation (bool val)
 
- Public Member Functions inherited from anima::BaseMCMCost
MCMPointerGetMCMStructure ()
 
unsigned int GetNumberOfObservations () const
 
unsigned int GetNumberOfParameters () const
 Returns number of optimized parameters. More...
 
virtual double GetSigmaSquare ()
 
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)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 GaussianMCMCost ()
 
virtual ~GaussianMCMCost ()
 
- Protected Member Functions inherited from anima::BaseMCMCost
 BaseMCMCost ()
 
virtual ~BaseMCMCost ()
 

Additional Inherited Members

- Protected Attributes inherited from anima::BaseMCMCost
double m_BigDelta
 
std::vector< Vector3DTypem_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

Class for computing marginal and profile costs and derivatives. This is not thread safe at all so be sure to intantiate one per thread.

Definition at line 18 of file animaGaussianMCMCost.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 25 of file animaGaussianMCMCost.h.

◆ Pointer

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

Definition at line 24 of file animaGaussianMCMCost.h.

◆ Self

Standard class typedefs.

Definition at line 22 of file animaGaussianMCMCost.h.

◆ Superclass

Definition at line 23 of file animaGaussianMCMCost.h.

Constructor & Destructor Documentation

◆ GaussianMCMCost()

anima::GaussianMCMCost::GaussianMCMCost ( )
inlineprotected

Definition at line 47 of file animaGaussianMCMCost.h.

◆ ~GaussianMCMCost()

virtual anima::GaussianMCMCost::~GaussianMCMCost ( )
inlineprotectedvirtual

Definition at line 52 of file animaGaussianMCMCost.h.

Member Function Documentation

◆ CreateAnother()

virtual::itk::LightObject::Pointer anima::GaussianMCMCost::CreateAnother ( void  ) const

◆ GetCurrentCostValue()

double anima::GaussianMCMCost::GetCurrentCostValue ( )
virtual

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

Implements anima::BaseMCMCost.

Definition at line 47 of file animaGaussianMCMCost.cxx.

References anima::BaseMCMCost::m_SigmaSquare.

◆ GetCurrentDerivative()

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

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

Implements anima::BaseMCMCost.

Definition at line 96 of file animaGaussianMCMCost.cxx.

References anima::BaseMCMCost::m_SigmaSquare.

◆ GetDerivativeMatrix()

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

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from anima::BaseMCMCost.

◆ GetValues()

GaussianMCMCost::MeasureType anima::GaussianMCMCost::GetValues ( const ParametersType parameters)
virtual

◆ New()

static Pointer anima::GaussianMCMCost::New ( )
static

◆ SetMarginalEstimation()

void anima::GaussianMCMCost::SetMarginalEstimation ( bool  val)
inline

Definition at line 44 of file animaGaussianMCMCost.h.


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