itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter > Class Template Reference

#include <itkVariationalRegistrationStopCriterion.h>

Inheritance diagram for itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >:

Collaboration diagram for itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >:

Detailed Description

template<typename TRegistrationFilter, typename TMRFilter>
class itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >

A flexible stop criterion for the variational registration framework.

This stop criterion is realised as an observer for the VariationalRegistrationFilter and VariationalRegistrationMultiResolutionFilter. It allows testing for

• Number of increase counts for the associated metric
• Slope of a line fitted to the last metric values

For the line fitting, three different modes can be chosen:

• Original: Metric values are used as they are provided by the registration filter
• Normalized: [min,max] are scaled to [0,1]
• Scaled: [0,max] are scaled to [0,1]

In multi resolution settings, it can be useful to use different stopping criteria for each MR level. Therefore, different multi resolution policies can be chosen:

• Default: Don't change criterion depending on the multi resolution level
• Simple graduated: Line fitting and increase count check on finest level, only increase count check on other levels
• Graduated: Line fitting and increase count check on finest level, only increase count check on second finest level, no check (maximum number of iterations) on other levels

See Also

VariationalRegistrationFilter

VariationalRegistrationMultiResolutionFilter

Note

This class was developed with funding from the German Research Foundation (DFG: EH 224/3-1 and HA 235/9-1).

Author

Alexander Schmidt-Richberg

Rene Werner

Jan Ehrhardt

Definition at line 68 of file itkVariationalRegistrationStopCriterion.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
enum	LineFittingMode {   LINE_FITTING_MODE_ORIGINAL = 0,   LINE_FITTING_MODE_NORMALIZED = 1,   LINE_FITTING_MODE_SCALED = 2 }
using	MRFilterType = TMRFilter
enum	MultiResolutionPolicy {   MULTI_RESOLUTION_POLICY_DEFAULT = 0,   MULTI_RESOLUTION_POLICY_SIMPLE_GRADUATED = 1,   MULTI_RESOLUTION_POLICY_GRADUATED = 2 }
using	Pointer = SmartPointer< Self >
using	RegistrationFilterType = TRegistrationFilter
using	Self = VariationalRegistrationStopCriterion
using	Superclass = Command
Public Types inherited from itk::Command
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Command
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	Execute (itk::Object *caller, const itk::EventObject &event) override
void	Execute (const itk::Object *caller, const itk::EventObject &event) override
virtual int	GetIterationModulus ()
virtual LineFittingMode	GetLineFittingMode () const
virtual double	GetMaxDistanceToRegressionLine ()
virtual int	GetMaximumIncreaseCount ()
virtual MultiResolutionPolicy	GetMultiResolutionPolicy () const
virtual int	GetNumberOfFittingIterations ()
virtual double	GetRegressionLineSlopeThreshold ()
virtual void	SetIterationModulus (int _arg)
virtual void	SetLineFittingMode (const LineFittingMode _arg)
virtual void	SetLineFittingModeToNormalizedValues ()
virtual void	SetLineFittingModeToOriginalValues ()
virtual void	SetLineFittingModeToScaledValues ()
virtual void	SetMaxDistanceToRegressionLine (double _arg)
virtual void	SetMaximumIncreaseCount (int _arg)
virtual void	SetMultiResolutionPolicy (const MultiResolutionPolicy _arg)
virtual void	SetMultiResolutionPolicyToDefault ()
virtual void	SetMultiResolutionPolicyToGraduated ()
virtual void	SetMultiResolutionPolicyToSimpleGraduated ()
virtual void	SetNumberOfFittingIterations (const int it)
virtual void	SetRegressionLineSlopeThreshold (double _arg)
virtual void	SetPerformIncreaseCountCheck (bool _arg)
virtual bool	GetPerformIncreaseCountCheck ()
virtual void	PerformIncreaseCountCheckOn ()
virtual void	PerformIncreaseCountCheckOff ()
virtual void	SetPerformLineFittingCheck (bool _arg)
virtual bool	GetPerformLineFittingCheck ()
virtual void	PerformLineFittingCheckOn ()
virtual void	PerformLineFittingCheckOff ()
virtual void	SetPerformLineFittingMaxDistanceCheck (bool _arg)
virtual bool	GetPerformLineFittingMaxDistanceCheck ()
virtual void	PerformLineFittingMaxDistanceCheckOn ()
virtual void	PerformLineFittingMaxDistanceCheckOff ()
virtual void	SetLineFittingUseAbsoluteValues (bool _arg)
virtual bool	GetLineFittingUseAbsoluteValues ()
virtual void	LineFittingUseAbsoluteValuesOn ()
virtual void	LineFittingUseAbsoluteValuesOff ()
Public Member Functions inherited from itk::Command
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
virtual bool	CheckStopRegistration ()
virtual void	FitLine (const double *const x, const double *const y, const int n, double *m, double *b)
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	ResetFittingData ()
virtual void	SetModeForNextLevel (const unsigned int nextLevel, const unsigned int numberOfLevels)
virtual void	SetNextMetricValue (const double value)
	VariationalRegistrationStopCriterion ()
	~VariationalRegistrationStopCriterion () override
Protected Member Functions inherited from itk::Command
	Command ()
	~Command () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Attributes
int	m_CurrentIncreaseCount
double *	m_DistanceArray
double *	m_DistanceArrayForFitting
int	m_ElapsedIterations
double *	m_IterationArray
int	m_IterationModulus
LineFittingMode	m_LineFittingMode
bool	m_LineFittingUseAbsoluteValues
double	m_MaxDistanceToRegressionLine
int	m_MaximumIncreaseCount
double	m_MaxMetricValue
double	m_MinMetricValue
MultiResolutionPolicy	m_MultiResolutionPolicy
int	m_NumberOfFittingIterations
bool	m_PerformIncreaseCountCheck
bool	m_PerformLineFittingCheck
bool	m_PerformLineFittingMaxDistanceCheck
double	m_RegressionLineSlopeThreshold

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TRegistrationFilter , typename TMRFilter >

using itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::ConstPointer = SmartPointer<const Self>

Definition at line 78 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

using itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::MRFilterType = TMRFilter

Definition at line 82 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

using itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::Pointer = SmartPointer<Self>

Definition at line 77 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

using itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::RegistrationFilterType = TRegistrationFilter

Registration and MR filter types

Definition at line 81 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

using itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::Self = VariationalRegistrationStopCriterion

Standard class type alias.

Definition at line 75 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

using itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::Superclass = Command

Definition at line 76 of file itkVariationalRegistrationStopCriterion.h.

Member Enumeration Documentation

template<typename TRegistrationFilter , typename TMRFilter >

enum itk::VariationalRegistrationStopCriterion::LineFittingMode

Enumerate for the different line fitting modes.

Enumerator
LINE_FITTING_MODE_ORIGINAL
LINE_FITTING_MODE_NORMALIZED
LINE_FITTING_MODE_SCALED

Definition at line 155 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

enum itk::VariationalRegistrationStopCriterion::MultiResolutionPolicy

Enumerate for the different multi resolution policies.

Enumerator
MULTI_RESOLUTION_POLICY_DEFAULT
MULTI_RESOLUTION_POLICY_SIMPLE_GRADUATED
MULTI_RESOLUTION_POLICY_GRADUATED

Definition at line 184 of file itkVariationalRegistrationStopCriterion.h.

Constructor & Destructor Documentation

template<typename TRegistrationFilter , typename TMRFilter >

itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::VariationalRegistrationStopCriterion ( )

protected

template<typename TRegistrationFilter , typename TMRFilter >

itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::~VariationalRegistrationStopCriterion ( )

overrideprotected

Member Function Documentation

template<typename TRegistrationFilter , typename TMRFilter >

virtual bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::CheckStopRegistration ( )

protectedvirtual

Perform the checking of the stop criterion.

Returns

Result of the stopping check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual::itk::LightObject::Pointer itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<typename TRegistrationFilter , typename TMRFilter >

void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::Execute ( itk::Object *  caller, const itk::EventObject &  event  )

overridevirtual

Abstract method that defines the action to be taken by the command.

Implements itk::Command.

template<typename TRegistrationFilter , typename TMRFilter >

void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::Execute ( const itk::Object *  caller, const itk::EventObject &  event  )

overridevirtual

Abstract method that defines the action to be taken by the command. This variant is expected to be used when requests comes from a const Object

Implements itk::Command.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::FitLine ( const double *const  x, const double *const  y, const int  n, double *  m, double *  b  )

protectedvirtual

Calculate linear regression line.

template<typename TRegistrationFilter , typename TMRFilter >

virtual int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetIterationModulus ( )

virtual

Get iteration modulus.

template<typename TRegistrationFilter , typename TMRFilter >

virtual LineFittingMode itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetLineFittingMode ( ) const

virtual

Get the line fitting mode.

template<typename TRegistrationFilter , typename TMRFilter >

virtual bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetLineFittingUseAbsoluteValues ( )

virtual

Use the absolute metric value for the line fitting.

 m_LineFittingUseAbsoluteValues must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

virtual double itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetMaxDistanceToRegressionLine ( )

virtual

Get maximum distance to regression line.

template<typename TRegistrationFilter , typename TMRFilter >

virtual int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetMaximumIncreaseCount ( )

virtual

Get maximum increase count.

template<typename TRegistrationFilter , typename TMRFilter >

virtual MultiResolutionPolicy itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetMultiResolutionPolicy ( ) const

virtual

Get the multi resolution policy.

template<typename TRegistrationFilter , typename TMRFilter >

virtual int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetNumberOfFittingIterations ( )

virtual

Get number of fitting iterations.

template<typename TRegistrationFilter , typename TMRFilter >

virtual bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetPerformIncreaseCountCheck ( )

virtual

Perform increase count check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetPerformLineFittingCheck ( )

virtual

Perform line fitting check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetPerformLineFittingMaxDistanceCheck ( )

virtual

Perform line fitting max distance check.

 m_PerformLineFittingCheck must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

virtual double itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::GetRegressionLineSlopeThreshold ( )

virtual

Get gradient threshold.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::LineFittingUseAbsoluteValuesOff ( )

virtual

Use the absolute metric value for the line fitting.

 m_LineFittingUseAbsoluteValues must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::LineFittingUseAbsoluteValuesOn ( )

virtual

Use the absolute metric value for the line fitting.

 m_LineFittingUseAbsoluteValues must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

static Pointer itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::New ( )

static

Method for creation through the object factory.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::PerformIncreaseCountCheckOff ( )

virtual

Perform increase count check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::PerformIncreaseCountCheckOn ( )

virtual

Perform increase count check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::PerformLineFittingCheckOff ( )

virtual

Perform line fitting check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::PerformLineFittingCheckOn ( )

virtual

Perform line fitting check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::PerformLineFittingMaxDistanceCheckOff ( )

virtual

Perform line fitting max distance check.

 m_PerformLineFittingCheck must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::PerformLineFittingMaxDistanceCheckOn ( )

virtual

Perform line fitting max distance check.

 m_PerformLineFittingCheck must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Print information about the filter.

Reimplemented from itk::Object.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::ResetFittingData ( )

protectedvirtual

Reset the fitting data.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetIterationModulus ( int  _arg )

virtual

Set iteration modulus.

The iteration modulus determines, if check is only performed every modulus iterations.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingMode ( const LineFittingMode  _arg )

virtual

Set the line fitting mode. Three modes are provided:

• Original: Metric values are used as they are provided by the registration filter
• Normalized: [min,max] are scaled to [0,1]
• Scaled: [0,max] are scaled to [0,1]

Referenced by itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingModeToNormalizedValues(), itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingModeToOriginalValues(), and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingModeToScaledValues().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingModeToNormalizedValues ( )

inlinevirtual

Set line fitting mode to normalized values.

Definition at line 176 of file itkVariationalRegistrationStopCriterion.h.

References itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::LINE_FITTING_MODE_NORMALIZED, and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingMode().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingModeToOriginalValues ( )

inlinevirtual

Set line fitting mode to original.

Definition at line 172 of file itkVariationalRegistrationStopCriterion.h.

References itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::LINE_FITTING_MODE_ORIGINAL, and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingMode().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingModeToScaledValues ( )

inlinevirtual

Set line fitting mode to scaled values.

Definition at line 180 of file itkVariationalRegistrationStopCriterion.h.

References itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::LINE_FITTING_MODE_SCALED, and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingMode().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetLineFittingUseAbsoluteValues ( bool  _arg )

virtual

Use the absolute metric value for the line fitting.

 m_LineFittingUseAbsoluteValues must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMaxDistanceToRegressionLine ( double  _arg )

virtual

Set maximum distance to regression line.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMaximumIncreaseCount ( int  _arg )

virtual

Set maximum increase count.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetModeForNextLevel ( const unsigned int  nextLevel, const unsigned int  numberOfLevels  )

protectedvirtual

Set the flags according to the multi-resolution policy for the next level.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicy ( const MultiResolutionPolicy  _arg )

virtual

Set the multi resolution policy. Three different multi resolution policies are provided:

• Default: Don't change criterion depending on the multi resolution level
• Simple graduated: Line fitting and increase count check on finest level, only increase count check on other levels
• Graduated: Line fitting and increase count check on finest level, only increase count check on second finest level, no check (maximum number of iterations) on other levels

Referenced by itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicyToDefault(), itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicyToGraduated(), and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicyToSimpleGraduated().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicyToDefault ( )

inlinevirtual

In each level, use the default stop criterion of the registration filter.

Definition at line 204 of file itkVariationalRegistrationStopCriterion.h.

References itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::MULTI_RESOLUTION_POLICY_DEFAULT, and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicy().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicyToGraduated ( )

inlinevirtual

Apply a graduated policy:

• On coarser levels, perform no check at all, i.e. always execute the max number of iterations.
• On the second finest level, perform increase count check.
• On finest level, also apply line fitting.

Definition at line 218 of file itkVariationalRegistrationStopCriterion.h.

References itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::MULTI_RESOLUTION_POLICY_GRADUATED, and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicy().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicyToSimpleGraduated ( )

inlinevirtual

Apply a simple graduated policy:

• On coarser levels, perform increase count check.
• On finest level, also apply line fitting.

Definition at line 210 of file itkVariationalRegistrationStopCriterion.h.

References itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::MULTI_RESOLUTION_POLICY_SIMPLE_GRADUATED, and itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetMultiResolutionPolicy().

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetNextMetricValue ( const double  value )

protectedvirtual

Set the metric value for the current iteration.

Parameters

value

The metric value of the current iteration.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetNumberOfFittingIterations ( const int  it )

virtual

Set number of fitting iterations. This will call Reset().

For the previous m_NumberOfFittingIterations iterations a linear regression to the (normalized) values is calculated. If the absolute value the gradient is smaller then DistanceGradientThresh, the stop criterion is satisfied.

Parameters

it	Number of fitting iterations.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetPerformIncreaseCountCheck ( bool  _arg )

virtual

Perform increase count check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetPerformLineFittingCheck ( bool  _arg )

virtual

Perform line fitting check.

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetPerformLineFittingMaxDistanceCheck ( bool  _arg )

virtual

Perform line fitting max distance check.

 m_PerformLineFittingCheck must be true for this taking effect.  

template<typename TRegistrationFilter , typename TMRFilter >

virtual void itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::SetRegressionLineSlopeThreshold ( double  _arg )

virtual

Set gradient threshold.

Member Data Documentation

template<typename TRegistrationFilter , typename TMRFilter >

int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_CurrentIncreaseCount

private

Definition at line 263 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

double* itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_DistanceArray

private

Definition at line 281 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

double* itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_DistanceArrayForFitting

private

Definition at line 283 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_ElapsedIterations

private

Definition at line 258 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

double* itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_IterationArray

private

Definition at line 282 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_IterationModulus

private

Definition at line 257 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

LineFittingMode itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_LineFittingMode

private

Definition at line 274 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_LineFittingUseAbsoluteValues

private

Definition at line 272 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

double itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_MaxDistanceToRegressionLine

private

Definition at line 278 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_MaximumIncreaseCount

private

Definition at line 264 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

double itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_MaxMetricValue

private

Definition at line 266 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

double itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_MinMetricValue

private

Definition at line 267 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

MultiResolutionPolicy itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_MultiResolutionPolicy

private

Definition at line 254 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

int itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_NumberOfFittingIterations

private

Definition at line 276 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_PerformIncreaseCountCheck

private

Definition at line 261 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_PerformLineFittingCheck

private

Definition at line 270 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

bool itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_PerformLineFittingMaxDistanceCheck

private

Definition at line 271 of file itkVariationalRegistrationStopCriterion.h.

template<typename TRegistrationFilter , typename TMRFilter >

double itk::VariationalRegistrationStopCriterion< TRegistrationFilter, TMRFilter >::m_RegressionLineSlopeThreshold

private

Definition at line 277 of file itkVariationalRegistrationStopCriterion.h.

---

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

• itkVariationalRegistrationStopCriterion.h