go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
elastix::TransformRigidityPenalty< TElastix > Class Template Reference

A penalty term based on non-rigidity. More...

#include <elxTransformRigidityPenaltyTerm.h>

Inheritance diagram for elastix::TransformRigidityPenalty< TElastix >:
Inheritance graph
[legend]
Collaboration diagram for elastix::TransformRigidityPenalty< TElastix >:
Collaboration graph
[legend]

Public Types

typedef
Superclass1::CoefficientImageType 
CoefficientImageType
typedef
Superclass2::ConfigurationPointer 
ConfigurationPointer
typedef
Superclass2::ConfigurationType 
ConfigurationType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass1::CoordinateRepresentationType 
CoordinateRepresentationType
typedef Superclass1::DerivativeType DerivativeType
typedef Superclass2::ElastixPointer ElastixPointer
typedef Superclass2::ElastixType ElastixType
typedef
Superclass1::FixedImageConstPointer 
FixedImageConstPointer
typedef
Superclass1::FixedImageLimiterOutputType 
FixedImageLimiterOutputType
typedef
Superclass1::FixedImageLimiterType 
FixedImageLimiterType
typedef
Superclass1::FixedImageMaskPointer 
FixedImageMaskPointer
typedef
Superclass1::FixedImageMaskType 
FixedImageMaskType
typedef
Superclass1::FixedImagePixelType 
FixedImagePixelType
typedef
Superclass1::FixedImageRegionType 
FixedImageRegionType
typedef Superclass1::FixedImageType FixedImageType
typedef
Superclass1::GradientImageFilterPointer 
GradientImageFilterPointer
typedef
Superclass1::GradientImageFilterType 
GradientImageFilterType
typedef
Superclass1::GradientImagePointer 
GradientImagePointer
typedef
Superclass1::GradientImageType 
GradientImageType
typedef
Superclass1::GradientPixelType 
GradientPixelType
typedef
Superclass1::ImageSampleContainerPointer 
ImageSampleContainerPointer
typedef
Superclass1::ImageSampleContainerType 
ImageSampleContainerType
typedef
Superclass1::ImageSamplerPointer 
ImageSamplerPointer
typedef
Superclass1::ImageSamplerType 
ImageSamplerType
typedef Superclass1::InputPointType InputPointType
typedef
Superclass1::InterpolatorPointer 
InterpolatorPointer
typedef
Superclass1::InterpolatorType 
InterpolatorType
typedef Superclass2::ITKBaseType ITKBaseType
typedef Superclass1::MeasureType MeasureType
typedef
Superclass1::MovingImageConstPointer 
MovingImageConstPointer
typedef
Superclass1::MovingImageLimiterOutputType 
MovingImageLimiterOutputType
typedef
Superclass1::MovingImageLimiterType 
MovingImageLimiterType
typedef
Superclass1::MovingImageMaskPointer 
MovingImageMaskPointer
typedef
Superclass1::MovingImageMaskType 
MovingImageMaskType
typedef
Superclass1::MovingImagePixelType 
MovingImagePixelType
typedef
Superclass1::MovingImageRegionType 
MovingImageRegionType
typedef
Superclass1::MovingImageType 
MovingImageType
typedef
Superclass1::OutputPointType 
OutputPointType
typedef Superclass1::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef Superclass1::RealType RealType
typedef
Superclass2::RegistrationPointer 
RegistrationPointer
typedef
Superclass2::RegistrationType 
RegistrationType
typedef TransformRigidityPenalty Self
typedef
TransformRigidityPenaltyTerm
< typename MetricBase
< TElastix >::FixedImageType,
double
Superclass1
typedef MetricBase< TElastix > Superclass2
typedef TimerType::Pointer TimerPointer
typedef tmr::Timer TimerType
typedef
Superclass1::TransformJacobianType 
TransformJacobianType
typedef
Superclass1::TransformParametersType 
TransformParametersType
typedef
Superclass1::TransformPointer 
TransformPointer
typedef Superclass1::TransformType TransformType

Public Member Functions

virtual void AfterEachIteration (void)
virtual void BeforeEachResolution (void)
virtual void BeforeRegistration (void)
 elxClassNameMacro ("TransformRigidityPenalty")
virtual const char * GetClassName () const
virtual void Initialize (void) throw (ExceptionObject)
 itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
 itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
virtual void SelectNewSamples (void)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 TransformRigidityPenalty ()
virtual ~TransformRigidityPenalty ()

Private Member Functions

void operator= (const Self &)
 TransformRigidityPenalty (const Self &)

Detailed Description

template<class TElastix>
class elastix::TransformRigidityPenalty< TElastix >

A penalty term based on non-rigidity.

For more information check the paper:
M. Staring, S. Klein and J.P.W. Pluim, "A Rigidity Penalty Term for Nonrigid Registration," Medical Physics, vol. 34, no. 11, pp. 4098 - 4108, November 2007.

The parameters used in this class are:

Parameters:
Metric: Select this metric as follows:
(Metric "TransformRigidityPenalty")
Parameters:
LinearityConditionWeight: A parameter to weigh the linearity condition term of the rigidity term.
example: (LinearityConditionWeight 2.0)
Default is 1.0.
Parameters:
OrthonormalityConditionWeight: A parameter to weigh the orthonormality condition term of the rigidity term.
example: (OrthonormalityConditionWeight 2.0)
Default is 1.0.
Parameters:
PropernessConditionWeight: A parameter to weigh the properness condition term of the rigidity term.
example: (PropernessConditionWeight 2.0)
Default is 1.0.
Parameters:
UseLinearityCondition: A flag to specify the usage of the linearity condition term for optimisation.
example: (UseLinearityCondition "false")
Default is "true".
Parameters:
UseOrthonormalityCondition: A flag to specify the usage of the orthonormality condition term for optimisation.
example: (UseOrthonormalityCondition "false")
Default is "true".
Parameters:
UsePropernessCondition: A flag to specify the usage of the properness condition term for optimisation.
example: (UsePropernessCondition "false")
Default is "true".
Parameters:
CalculateLinearityCondition: A flag to specify if the linearity condition should still be calculated, even if it is not used for optimisation.
example: (CalculateLinearityCondition "false")
Default is "true".
Parameters:
CalculateOrthonormalityCondition: A flag to specify if the orthonormality condition should still be calculated, even if it is not used for optimisation.
example: (CalculateOrthonormalityCondition "false")
Default is "true".
Parameters:
CalculatePropernessCondition: A flag to specify if the properness condition should still be calculated, even if it is not used for optimisation.
example: (CalculatePropernessCondition "false")
Default is "true".
Parameters:
FixedRigidityImageName: the name of a coefficient image to specify the rigidity index of voxels in the fixed image.
example: (FixedRigidityImageName "fixedRigidityImage.mhd")
If not supplied the rigidity coefficient is not based on the fixed image, which is recommended.
If neither FixedRigidityImageName nor MovingRigidityImageName are supplied, the rigidity penalty term is evaluated on the whole transform input domain.
Parameters:
MovingRigidityImageName: the name of a coefficient image to specify the rigidity index of voxels in the moving image.
example: (MovingRigidityImageName "movingRigidityImage.mhd")
If not supplied the rigidity coefficient is not based on the moving image, which is NOT recommended.
If neither FixedRigidityImageName nor MovingRigidityImageName are supplied, the rigidity penalty term is evaluated on the whole transform input domain.
Parameters:
DilateRigidityImages: flag to specify the dilation of the rigidity coefficient images. With this the region of rigidity can be extended to force rigidity of the inner region.
example: (DilateRigidityImages "false" "false" "true")
Default is "true".
Parameters:
DilationRadiusMultiplier: the dilation radius is a multiplier times the grid spacing of the B-spline transform.
example: (DilationRadiusMultiplier 1.0 1.0 2.0)
Default is 1.0.

Definition at line 109 of file elxTransformRigidityPenaltyTerm.h.


Member Typedef Documentation

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 192 of file elxTransformRigidityPenaltyTerm.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 191 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef SmartPointer<const Self> elastix::TransformRigidityPenalty< TElastix >::ConstPointer

Typedefs from the superclass.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 139 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass1::DerivativeType elastix::TransformRigidityPenalty< TElastix >::DerivativeType
template<class TElastix >
typedef Superclass2::ElastixPointer elastix::TransformRigidityPenalty< TElastix >::ElastixPointer

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 190 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass2::ElastixType elastix::TransformRigidityPenalty< TElastix >::ElastixType

Typedef's inherited from elastix.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 189 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass1::FixedImageType elastix::TransformRigidityPenalty< TElastix >::FixedImageType

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 143 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass1::InputPointType elastix::TransformRigidityPenalty< TElastix >::InputPointType
template<class TElastix >
typedef Superclass2::ITKBaseType elastix::TransformRigidityPenalty< TElastix >::ITKBaseType

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 195 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass1::MeasureType elastix::TransformRigidityPenalty< TElastix >::MeasureType

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 164 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass1::MovingImageType elastix::TransformRigidityPenalty< TElastix >::MovingImageType

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 140 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass1::OutputPointType elastix::TransformRigidityPenalty< TElastix >::OutputPointType
template<class TElastix >
typedef Superclass1::ParametersType elastix::TransformRigidityPenalty< TElastix >::ParametersType

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 166 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef SmartPointer<Self> elastix::TransformRigidityPenalty< TElastix >::Pointer
template<class TElastix >
typedef Superclass1::RealType elastix::TransformRigidityPenalty< TElastix >::RealType

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 194 of file elxTransformRigidityPenaltyTerm.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 193 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef TransformRigidityPenalty elastix::TransformRigidityPenalty< TElastix >::Self

Standard ITK-stuff.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 118 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef TransformRigidityPenaltyTerm< typename MetricBase<TElastix>::FixedImageType, double > elastix::TransformRigidityPenalty< TElastix >::Superclass1

Definition at line 121 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef MetricBase<TElastix> elastix::TransformRigidityPenalty< TElastix >::Superclass2

Definition at line 122 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef TimerType::Pointer elastix::TransformRigidityPenalty< TElastix >::TimerPointer

Typedef for timer.

Definition at line 200 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef tmr::Timer elastix::TransformRigidityPenalty< TElastix >::TimerType

Typedef for timer.

Definition at line 198 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
typedef Superclass1::TransformType elastix::TransformRigidityPenalty< TElastix >::TransformType

Constructor & Destructor Documentation

template<class TElastix >
elastix::TransformRigidityPenalty< TElastix >::TransformRigidityPenalty ( ) [inline, protected]

The constructor.

Definition at line 236 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
virtual elastix::TransformRigidityPenalty< TElastix >::~TransformRigidityPenalty ( ) [inline, protected, virtual]

The destructor.

Definition at line 239 of file elxTransformRigidityPenaltyTerm.h.

template<class TElastix >
elastix::TransformRigidityPenalty< TElastix >::TransformRigidityPenalty ( const Self ) [private]

The private constructor.


Member Function Documentation

template<class TElastix >
virtual void elastix::TransformRigidityPenalty< TElastix >::AfterEachIteration ( void  ) [virtual]

Do some things after each iteration:

  • Print the OC, PC, LC parts of the rigidity term.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::TransformRigidityPenalty< TElastix >::BeforeEachResolution ( void  ) [virtual]

Do some things before each resolution:

  • Read all parameters.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
virtual void elastix::TransformRigidityPenalty< TElastix >::BeforeRegistration ( void  ) [virtual]

Do some things before registration:

  • Read the fixed rigidity image.
  • Read the moving rigidity image.
  • Setup some extra target cells.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
elastix::TransformRigidityPenalty< TElastix >::elxClassNameMacro ( "TransformRigidityPenalty< TElastix >"  )

Name of this class. Use this name in the parameter file to select this specific metric.
example: (Metric "TransformRigidityPenalty")

template<class TElastix >
virtual const char* elastix::TransformRigidityPenalty< TElastix >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
virtual void elastix::TransformRigidityPenalty< TElastix >::Initialize ( void  ) throw (ExceptionObject) [virtual]

Sets up a timer to measure the initialization time and calls the Superclass' implementation.

Reimplemented from itk::TransformRigidityPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >.

template<class TElastix >
elastix::TransformRigidityPenalty< TElastix >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned  int,
FixedImageType::ImageDimension   
)

The fixed image dimension.

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
elastix::TransformRigidityPenalty< TElastix >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned  int,
MovingImageType::ImageDimension   
)

The moving image dimension.

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
static Pointer elastix::TransformRigidityPenalty< TElastix >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::TransformRigidityPenaltyTerm< MetricBase< TElastix >::FixedImageType, double >.

template<class TElastix >
void elastix::TransformRigidityPenalty< TElastix >::operator= ( const Self ) [private]

The private copy constructor.

template<class TElastix >
virtual void elastix::TransformRigidityPenalty< TElastix >::SelectNewSamples ( void  ) [inline, virtual]

This metric is advanced (so it has a sampling possibility), but it purposely does not use samplers. The MetricBase class, however, issues a warning if this is the case, so we overwrite that function.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 231 of file elxTransformRigidityPenaltyTerm.h.



Generated on 24-10-2011 for elastix by doxygen 1.7.4 elastix logo