mitk::ConstraintCheckerBase Class Reference

Base class for constraint checkers used in model fitting. More...

#include <mitkConstraintCheckerBase.h>

Inheritance diagram for mitk::ConstraintCheckerBase:

Collaboration diagram for mitk::ConstraintCheckerBase:

Public Types
typedef ConstraintCheckerBase	Self
typedef ConstraintCheckerInterface	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::PenaltyValueType	PenaltyValueType
typedef Superclass::PenaltyArrayType	PenaltyArrayType
typedef Superclass::SignalType	SignalType
typedef Superclass::ParametersType	ParametersType
Public Types inherited from mitk::ConstraintCheckerInterface
typedef ConstraintCheckerInterface	Self
typedef double	PenaltyValueType
typedef itk::Array< PenaltyValueType >	PenaltyArrayType
typedef itk::Array< double >	SignalType
typedef ModelBase::ParametersType	ParametersType

Public Member Functions
PenaltyValueType	GetPenaltySum (const ParametersType &parameters) const override
Public Member Functions inherited from mitk::ConstraintCheckerInterface
virtual PenaltyArrayType	GetPenalties (const ParametersType &parameters) const =0
virtual unsigned int	GetNumberOfConstraints () const =0
virtual PenaltyValueType	GetFailedConstraintValue () const =0

Protected Member Functions
	ConstraintCheckerBase ()
	~ConstraintCheckerBase () override
Protected Member Functions inherited from mitk::ConstraintCheckerInterface
	ConstraintCheckerInterface ()
virtual	~ConstraintCheckerInterface ()

Detailed Description

Base class for constraint checkers used in model fitting.

Provides a default implementation of GetPenaltySum() that sums all penalty values.

Remarks

All functions of the ConstraintCheckerInterface must be implemented thread-safe because they are used in a multi-threaded environment.

See also

ConstraintCheckerInterface, SimpleBarrierConstraintChecker

Definition at line 37 of file mitkConstraintCheckerBase.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer< const Self > mitk::ConstraintCheckerBase::ConstPointer

Definition at line 44 of file mitkConstraintCheckerBase.h.

ParametersType

typedef Superclass::ParametersType mitk::ConstraintCheckerBase::ParametersType

Definition at line 49 of file mitkConstraintCheckerBase.h.

PenaltyArrayType

typedef Superclass::PenaltyArrayType mitk::ConstraintCheckerBase::PenaltyArrayType

Definition at line 47 of file mitkConstraintCheckerBase.h.

PenaltyValueType

typedef Superclass::PenaltyValueType mitk::ConstraintCheckerBase::PenaltyValueType

Definition at line 46 of file mitkConstraintCheckerBase.h.

Pointer

typedef itk::SmartPointer< Self > mitk::ConstraintCheckerBase::Pointer

Definition at line 43 of file mitkConstraintCheckerBase.h.

Self

typedef ConstraintCheckerBase mitk::ConstraintCheckerBase::Self

Definition at line 41 of file mitkConstraintCheckerBase.h.

SignalType

typedef Superclass::SignalType mitk::ConstraintCheckerBase::SignalType

Definition at line 48 of file mitkConstraintCheckerBase.h.

Superclass

typedef ConstraintCheckerInterface mitk::ConstraintCheckerBase::Superclass

Definition at line 42 of file mitkConstraintCheckerBase.h.

Constructor & Destructor Documentation

ConstraintCheckerBase()

mitk::ConstraintCheckerBase::ConstraintCheckerBase ( )

inlineprotected

Definition at line 55 of file mitkConstraintCheckerBase.h.

~ConstraintCheckerBase()

mitk::ConstraintCheckerBase::~ConstraintCheckerBase ( )

inlineoverrideprotected

Definition at line 59 of file mitkConstraintCheckerBase.h.

Member Function Documentation

GetPenaltySum()

PenaltyValueType mitk::ConstraintCheckerBase::GetPenaltySum ( const ParametersType &  parameters ) const

overridevirtual

Returns the sum of all penalties.

Precondition

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

Implements mitk::ConstraintCheckerInterface.

---

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

• mitkConstraintCheckerBase.h