#include <itkRegistrationParameterScalesFromShift.h>

Inheritance diagram for itk::RegistrationParameterScalesFromShift< TMetric >:

Collaboration diagram for itk::RegistrationParameterScalesFromShift< TMetric >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FixedTransformType	FixedTransformType
typedef Superclass::FloatType	FloatType
typedef Superclass::JacobianType	JacobianType
typedef Superclass::MovingTransformType	MovingTransformType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalesType	ScalesType
typedef RegistrationParameterScalesFromShift	Self
typedef RegistrationParameterScalesEstimator < TMetric >	Superclass
typedef Superclass::VirtualImageConstPointer	VirtualImageConstPointer
typedef Superclass::VirtualIndexType	VirtualIndexType
typedef Superclass::VirtualPointType	VirtualPointType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)
virtual void	EstimateScales (ScalesType &scales)
virtual FloatType	EstimateStepScale (const ParametersType &step)
virtual const char *	GetNameOfClass () const

virtual void	SetUsePhysicalSpaceForShift (bool _arg)
virtual bool	GetUsePhysicalSpaceForShift () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
virtual FloatType	ComputeMaximumVoxelShift (const ParametersType &deltaParameters)
template<class TTransform >
void	ComputeSampleIndexShifts (const ParametersType &deltaParameters, ScalesType &localShifts)
template<class TTransform >
void	ComputeSamplePhysicalShifts (const ParametersType &deltaParameters, ScalesType &localShifts)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	RegistrationParameterScalesFromShift ()
	~RegistrationParameterScalesFromShift ()
Private Member Functions
void	operator= (const Self &)
	RegistrationParameterScalesFromShift (const Self &)
Private Attributes
ParametersType::ValueType	m_SmallParameterVariation
bool	m_UsePhysicalSpaceForShift

Detailed Description

template<class TMetric>
class itk::RegistrationParameterScalesFromShift< TMetric >

Implements a registration helper class for estimating scales of transform parameters from the maximum voxel shift caused by a parameter change.

Its input includes the fixed/moving images and transform objects, which can be obtained from the metric object.

The scale of a parameter is estimated from the maximum voxel shift produced from a small variation of this parameter. The maximization is done by checking the pixels of the image domain. By defaults, all pixels will be checked. For affine transforms, we may check only the corners by calling SetSamplingStrategy(CornerSampling).

Definition at line 43 of file itkRegistrationParameterScalesFromShift.h.

Member Typedef Documentation

template<class TMetric >

typedef SmartPointer<const Self> itk::RegistrationParameterScalesFromShift< TMetric >::ConstPointer

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 51 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::FixedTransformType itk::RegistrationParameterScalesFromShift< TMetric >::FixedTransformType

Type of the transform to initialize

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 71 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::FloatType itk::RegistrationParameterScalesFromShift< TMetric >::FloatType

Type of float

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 66 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::JacobianType itk::RegistrationParameterScalesFromShift< TMetric >::JacobianType

Type of Jacobian of transform.

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 72 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::MovingTransformType itk::RegistrationParameterScalesFromShift< TMetric >::MovingTransformType

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 70 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::ParametersType itk::RegistrationParameterScalesFromShift< TMetric >::ParametersType

Type of paramters of the optimizer

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 63 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef SmartPointer<Self> itk::RegistrationParameterScalesFromShift< TMetric >::Pointer

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 50 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::ScalesType itk::RegistrationParameterScalesFromShift< TMetric >::ScalesType

Type of scales

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 57 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef RegistrationParameterScalesFromShift itk::RegistrationParameterScalesFromShift< TMetric >::Self

Standard class typedefs.

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 48 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef RegistrationParameterScalesEstimator< TMetric > itk::RegistrationParameterScalesFromShift< TMetric >::Superclass

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 49 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::VirtualImageConstPointer itk::RegistrationParameterScalesFromShift< TMetric >::VirtualImageConstPointer

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 73 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::VirtualIndexType itk::RegistrationParameterScalesFromShift< TMetric >::VirtualIndexType

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 69 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

typedef Superclass::VirtualPointType itk::RegistrationParameterScalesFromShift< TMetric >::VirtualPointType

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 68 of file itkRegistrationParameterScalesFromShift.h.

Constructor & Destructor Documentation

template<class TMetric >

itk::RegistrationParameterScalesFromShift< TMetric >::RegistrationParameterScalesFromShift ( ) [protected]

template<class TMetric >

itk::RegistrationParameterScalesFromShift< TMetric >::~RegistrationParameterScalesFromShift ( ) [inline, protected]

Definition at line 92 of file itkRegistrationParameterScalesFromShift.h.

template<class TMetric >

itk::RegistrationParameterScalesFromShift< TMetric >::RegistrationParameterScalesFromShift ( const Self & ) [private]

Member Function Documentation

template<class TMetric >

virtual FloatType itk::RegistrationParameterScalesFromShift< TMetric >::ComputeMaximumVoxelShift ( const ParametersType & deltaParameters ) [protected, virtual]

Compute the shift in voxels when deltaParameters is applied onto the current parameters.

template<class TMetric >

template<class TTransform >

void itk::RegistrationParameterScalesFromShift< TMetric >::ComputeSampleIndexShifts	(	const ParametersType &	deltaParameters,
		ScalesType &	localShifts
	)		`[protected]`

The templated method of compute the sample shifts in continuous index. The template argument TTransform may be either MovingTransformType or FixedTransformType.

template<class TMetric >

template<class TTransform >

void itk::RegistrationParameterScalesFromShift< TMetric >::ComputeSamplePhysicalShifts	(	const ParametersType &	deltaParameters,
		ScalesType &	localShifts
	)		`[protected]`

The templated method of compute the sample shifts in the phyiscal space. The template argument TTransform may be either MovingTransformType or FixedTransformType.

template<class TMetric >

virtual::itk::LightObject::Pointer itk::RegistrationParameterScalesFromShift< TMetric >::CreateAnother ( void ) 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<class TMetric >

virtual void itk::RegistrationParameterScalesFromShift< TMetric >::EstimateLocalStepScales	(	const ParametersType &	step,
		ScalesType &	localStepScales
	)		`[virtual]`

Estimate the scales of local steps.

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual void itk::RegistrationParameterScalesFromShift< TMetric >::EstimateScales ( ScalesType & scales ) [virtual]

Estimate parameter scales

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual FloatType itk::RegistrationParameterScalesFromShift< TMetric >::EstimateStepScale ( const ParametersType & step ) [virtual]

Estimate the scale of a step

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual const char* itk::RegistrationParameterScalesFromShift< TMetric >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual bool itk::RegistrationParameterScalesFromShift< TMetric >::GetUsePhysicalSpaceForShift ( ) const [virtual]

A switch for using physical space for shift computation or continuous index space

template<class TMetric >

static Pointer itk::RegistrationParameterScalesFromShift< TMetric >::New ( ) [static]

New macro for creation of through a Smart Pointer.

Reimplemented from itk::Object.

template<class TMetric >

void itk::RegistrationParameterScalesFromShift< TMetric >::operator= ( const Self & ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual void itk::RegistrationParameterScalesFromShift< TMetric >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual void itk::RegistrationParameterScalesFromShift< TMetric >::SetUsePhysicalSpaceForShift ( bool _arg ) [virtual]

A switch for using physical space for shift computation or continuous index space