mitk::ConstraintCheckerInterface Class Reference

Interface for all constraint checkers used in model fitting. More...

#include <mitkConstraintCheckerInterface.h>

Inheritance diagram for mitk::ConstraintCheckerInterface:

Public Types
typedef ConstraintCheckerInterface	Self
typedef double	PenaltyValueType
typedef itk::Array< PenaltyValueType >	PenaltyArrayType
typedef itk::Array< double >	SignalType
typedef ModelBase::ParametersType	ParametersType

Public Member Functions
virtual PenaltyArrayType	GetPenalties (const ParametersType &parameters) const =0
virtual PenaltyValueType	GetPenaltySum (const ParametersType &parameters) const =0
virtual unsigned int	GetNumberOfConstraints () const =0
virtual PenaltyValueType	GetFailedConstraintValue () const =0

Protected Member Functions
	ConstraintCheckerInterface ()
virtual	~ConstraintCheckerInterface ()

Detailed Description

Interface for all constraint checkers used in model fitting.

Constraint checkers evaluate parameter vectors and return penalty values for constraint violations. They are used by cost function decorators to enforce parameter bounds during optimization.

Note

All functions must be implemented thread-safe as they are used in a multi-threaded environment.

See also

ConstraintCheckerBase, SimpleBarrierConstraintChecker

Definition at line 35 of file mitkConstraintCheckerInterface.h.

Member Typedef Documentation

ParametersType

typedef ModelBase::ParametersType mitk::ConstraintCheckerInterface::ParametersType

Definition at line 44 of file mitkConstraintCheckerInterface.h.

PenaltyArrayType

typedef itk::Array<PenaltyValueType> mitk::ConstraintCheckerInterface::PenaltyArrayType

Definition at line 42 of file mitkConstraintCheckerInterface.h.

PenaltyValueType

typedef double mitk::ConstraintCheckerInterface::PenaltyValueType

Definition at line 41 of file mitkConstraintCheckerInterface.h.

Self

typedef ConstraintCheckerInterface mitk::ConstraintCheckerInterface::Self

Definition at line 39 of file mitkConstraintCheckerInterface.h.

SignalType

typedef itk::Array<double> mitk::ConstraintCheckerInterface::SignalType

Definition at line 43 of file mitkConstraintCheckerInterface.h.

Constructor & Destructor Documentation

ConstraintCheckerInterface()

mitk::ConstraintCheckerInterface::ConstraintCheckerInterface ( )

inlineprotected

Definition at line 65 of file mitkConstraintCheckerInterface.h.

~ConstraintCheckerInterface()

virtual mitk::ConstraintCheckerInterface::~ConstraintCheckerInterface ( )

inlineprotectedvirtual

Definition at line 68 of file mitkConstraintCheckerInterface.h.

Member Function Documentation

GetFailedConstraintValue()

virtual PenaltyValueType mitk::ConstraintCheckerInterface::GetFailedConstraintValue ( ) const

pure virtual

Returns the penalty value that indicates at least one failed constrained.

Implemented in mitk::SimpleBarrierConstraintChecker.

GetNumberOfConstraints()

virtual unsigned int mitk::ConstraintCheckerInterface::GetNumberOfConstraints ( ) const

pure virtual

Returns the number of defined constraints, that will be checked. Thus also the size of the penalty vector.

Implemented in mitk::SimpleBarrierConstraintChecker.

GetPenalties()

virtual PenaltyArrayType mitk::ConstraintCheckerInterface::GetPenalties ( const ParametersType &  parameters ) const

pure virtual

Returns the penalties for all defined constraints.

Precondition

defined constraints must address valid parameters in the passed parameters set.

Postcondition

the result vector has the size given by GetNumberOfConstraints().

GetPenaltySum()

virtual PenaltyValueType mitk::ConstraintCheckerInterface::GetPenaltySum ( const ParametersType &  parameters ) const

pure virtual

Returns the sum of all penalties.

Precondition

defined constraints must address valid parameters in the passed parameters set.

Implemented in mitk::ConstraintCheckerBase.

---

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

• mitkConstraintCheckerInterface.h