NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Constraint Class Referenceabstract

Abstract Base class for constraints, which are objects that return a single double value, such as might be used for a regulariser in a deformable registration algorithm. In practice you create any subclass of this. Then the base similarity measure itkImageToImageMetricWithConstraint will evaluate the cost function, for example, the mutual information of your two images is X, then, if the itkImageToImageMetricWithConstraint has a pointer to a constraint, it will call EvaluateConstraint, which will return a value Y, then itkImageToImageMetricWithConstraint will combine those two numbers together. So, in principal, the itkImageToImageMetricWithConstraint (and derived subclasses) need not even know what or how a constraint works, only that it provides a number. More...

Inheritance diagram for itk::Constraint:
Inheritance graph
[legend]
Collaboration diagram for itk::Constraint:
Collaboration graph
[legend]

Public Types

typedef Constraint Self
 
typedef Object Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef
SingleValuedCostFunction::MeasureType 
MeasureType
 
typedef
SingleValuedCostFunction::DerivativeType 
DerivativeType
 
typedef
SingleValuedCostFunction::ParametersType 
ParametersType
 

Public Member Functions

virtual const char * GetClassName () const
 
virtual MeasureType EvaluateConstraint (const ParametersType &parameters)=0
 
virtual void EvaluateDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
 

Protected Member Functions

 Constraint ()
 
virtual ~Constraint ()
 

Detailed Description

Abstract Base class for constraints, which are objects that return a single double value, such as might be used for a regulariser in a deformable registration algorithm. In practice you create any subclass of this. Then the base similarity measure itkImageToImageMetricWithConstraint will evaluate the cost function, for example, the mutual information of your two images is X, then, if the itkImageToImageMetricWithConstraint has a pointer to a constraint, it will call EvaluateConstraint, which will return a value Y, then itkImageToImageMetricWithConstraint will combine those two numbers together. So, in principal, the itkImageToImageMetricWithConstraint (and derived subclasses) need not even know what or how a constraint works, only that it provides a number.

Member Typedef Documentation

typedef SmartPointer<const Self> itk::Constraint::ConstPointer
typedef SingleValuedCostFunction::DerivativeType itk::Constraint::DerivativeType
typedef SingleValuedCostFunction::MeasureType itk::Constraint::MeasureType
typedef SingleValuedCostFunction::ParametersType itk::Constraint::ParametersType
typedef SmartPointer<Self> itk::Constraint::Pointer

Standard "Self" typedef.

Constructor & Destructor Documentation

itk::Constraint::Constraint ( )
inlineprotected
virtual itk::Constraint::~Constraint ( )
inlineprotectedvirtual

Member Function Documentation

virtual MeasureType itk::Constraint::EvaluateConstraint ( const ParametersType parameters)
pure virtual
virtual void itk::Constraint::EvaluateDerivative ( const ParametersType parameters,
DerivativeType derivative 
) const
pure virtual
virtual const char* itk::Constraint::GetClassName ( ) const
virtual

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