Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
mitk::ConstraintCheckerInterface Class Referenceabstract

#include <mitkConstraintCheckerInterface.h>

Inheritance diagram for mitk::ConstraintCheckerInterface:
Inheritance graph
[legend]

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 class that is implemented by all constraint checkers that are used in the context of model fitting.

Remarks
All functions of the interface must be implemented thread save because it will be used in a multi threaded environment.

Definition at line 26 of file mitkConstraintCheckerInterface.h.

Member Typedef Documentation

◆ ParametersType

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

Definition at line 35 of file mitkConstraintCheckerInterface.h.

◆ PenaltyArrayType

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

Definition at line 33 of file mitkConstraintCheckerInterface.h.

◆ PenaltyValueType

typedef double mitk::ConstraintCheckerInterface::PenaltyValueType

Definition at line 32 of file mitkConstraintCheckerInterface.h.

◆ Self

typedef ConstraintCheckerInterface mitk::ConstraintCheckerInterface::Self

Definition at line 30 of file mitkConstraintCheckerInterface.h.

◆ SignalType

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

Definition at line 34 of file mitkConstraintCheckerInterface.h.

Constructor & Destructor Documentation

◆ ConstraintCheckerInterface()

mitk::ConstraintCheckerInterface::ConstraintCheckerInterface ( )
inlineprotected

Definition at line 56 of file mitkConstraintCheckerInterface.h.

◆ ~ConstraintCheckerInterface()

virtual mitk::ConstraintCheckerInterface::~ConstraintCheckerInterface ( )
inlineprotectedvirtual

Definition at line 59 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: