#include <itkRegistrationParameterScalesFromShiftBase.h>

Inheritance diagram for itk::RegistrationParameterScalesFromShiftBase< TMetric >:

Collaboration diagram for itk::RegistrationParameterScalesFromShiftBase< 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 RegistrationParameterScalesFromShiftBase	Self
typedef RegistrationParameterScalesEstimator < TMetric >	Superclass
typedef Superclass::VirtualImageConstPointer	VirtualImageConstPointer
typedef Superclass::VirtualIndexType	VirtualIndexType
typedef Superclass::VirtualPointType	VirtualPointType
Public Types inherited from itk::RegistrationParameterScalesEstimator< TMetric >
typedef FixedTransformType::ConstPointer	FixedTransformConstPointer
typedef MetricType::ConstPointer	MetricConstPointer
typedef MetricType::Pointer	MetricPointer
typedef TMetric	MetricType
typedef MovingTransformType::ConstPointer	MovingTransformConstPointer
typedef std::vector < VirtualPointType >	SamplePointContainerType
enum	SamplingStrategyType { FullDomainSampling = 0, CornerSampling, RandomSampling, CentralRegionSampling, VirtualDomainPointSetSampling }
typedef TMetric::VirtualImagePointer	VirtualImagePointer
typedef TMetric::VirtualImageType	VirtualImageType
typedef TMetric::VirtualPointSetPointer	VirtualPointSetPointer
typedef TMetric::VirtualPointSetType	VirtualPointSetType
typedef TMetric::VirtualRegionType	VirtualRegionType
typedef TMetric::VirtualSizeType	VirtualSizeType
typedef TMetric::VirtualSpacingType	VirtualSpacingType
Public Types inherited from itk::OptimizerParameterScalesEstimator
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual void	EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)
virtual void	EstimateScales (ScalesType &scales)
virtual FloatType	EstimateStepScale (const ParametersType &step)
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
virtual FloatType	EstimateMaximumStepSize ()
virtual void	SetCentralRegionRadius (IndexValueType _arg)
virtual void	SetMetric (MetricType *_arg)
virtual void	SetScalesSamplingStrategy ()
virtual void	SetStepScaleSamplingStrategy ()
virtual void	SetTransformForward (bool _arg)
virtual bool	GetTransformForward () const
virtual void	SetVirtualDomainPointSet (VirtualPointSetType *_arg)
virtual void	SetVirtualDomainPointSet (const VirtualPointSetType *_arg)
virtual const VirtualPointSetType *	GetVirtualDomainPointSet ()

Protected Member Functions
virtual FloatType	ComputeMaximumVoxelShift (const ParametersType &deltaParameters)
virtual void	ComputeSampleShifts (const ParametersType &deltaParameters, ScalesType &localShifts)=0
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	RegistrationParameterScalesFromShiftBase ()
	~RegistrationParameterScalesFromShiftBase ()
Protected Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
bool	CheckAndSetInputs ()
bool	CheckGeneralAffineTransform ()
template<class TTransform >
bool	CheckGeneralAffineTransformTemplated ()
void	ComputeSquaredJacobianNorms (const VirtualPointType &p, ParametersType &squareNorms)
SizeValueType	GetDimension ()
SizeValueType	GetNumberOfLocalParameters ()
virtual SamplingStrategyType	GetSamplingStrategy ()
const TransformBase *	GetTransform ()
VirtualIndexType	GetVirtualDomainCentralIndex ()
VirtualRegionType	GetVirtualDomainCentralRegion ()
bool	HasLocalSupport ()
	RegistrationParameterScalesEstimator ()
virtual void	SampleVirtualDomain ()
void	SampleVirtualDomainFully ()
void	SampleVirtualDomainRandomly ()
void	SampleVirtualDomainWithCentralRegion ()
void	SampleVirtualDomainWithCorners ()
void	SampleVirtualDomainWithPointSet ()
void	SampleVirtualDomainWithRegion (VirtualRegionType region)
virtual void	SetNumberOfRandomSamples (SizeValueType _arg)
virtual void	SetSamplingStrategy (SamplingStrategyType _arg)
template<class TTargetPointType >
void	TransformPoint (const VirtualPointType &point, TTargetPointType &mappedPoint)
template<class TContinuousIndexType >
void	TransformPointToContinuousIndex (const VirtualPointType &point, TContinuousIndexType &mappedIndex)
void	UpdateTransformParameters (const ParametersType &deltaParameters)
	~RegistrationParameterScalesEstimator ()
Protected Member Functions inherited from itk::OptimizerParameterScalesEstimator
	OptimizerParameterScalesEstimator ()
	~OptimizerParameterScalesEstimator ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 Member Functions
void	operator= (const Self &)
	RegistrationParameterScalesFromShiftBase (const Self &)

Private Attributes
ParametersType::ValueType	m_SmallParameterVariation

Additional Inherited Members
Static Public Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
static const SizeValueType	FixedDimension = TMetric::FixedDimension
static const SizeValueType	MovingDimension = TMetric::MovingDimension
static const SizeValueType	VirtualDimension = TMetric::VirtualDimension
Protected Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
IndexValueType	m_CentralRegionRadius
MetricPointer	m_Metric
SizeValueType	m_NumberOfRandomSamples
SamplePointContainerType	m_SamplePoints
TimeStamp	m_SamplingTime
VirtualPointSetType::ConstPointer	m_VirtualDomainPointSet
Static Protected Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
static const SizeValueType	SizeOfSmallDomain = 1000

Detailed Description

template<class TMetric>
class itk::RegistrationParameterScalesFromShiftBase< TMetric >

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

Derived classes provide estimation using physical or index space.

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 sample points within the metric's virtual domain. Sample points are generated differently depending on the type of metric transform or metric type. See RegistrationParameterScalesEstimator documentation.

See also:: RegistrationParameterScalesEstimator

Definition at line 43 of file itkRegistrationParameterScalesFromShiftBase.h.

Member Typedef Documentation

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 51 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Type of the transform to initialize

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 68 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Type of float

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 63 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Type of Jacobian of transform.

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 69 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 67 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Type of parameters of the optimizer

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 60 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 50 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Type of scales

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 54 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

typedef RegistrationParameterScalesFromShiftBase itk::RegistrationParameterScalesFromShiftBase< TMetric >::Self

Standard class typedefs.

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 48 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 49 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 70 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 66 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

Definition at line 65 of file itkRegistrationParameterScalesFromShiftBase.h.

Constructor & Destructor Documentation

template<class TMetric >

itk::RegistrationParameterScalesFromShiftBase< TMetric >::RegistrationParameterScalesFromShiftBase ( )

protected

template<class TMetric >

itk::RegistrationParameterScalesFromShiftBase< TMetric >::~RegistrationParameterScalesFromShiftBase ( )

inlineprotected

Definition at line 84 of file itkRegistrationParameterScalesFromShiftBase.h.

template<class TMetric >

itk::RegistrationParameterScalesFromShiftBase< TMetric >::RegistrationParameterScalesFromShiftBase ( const Self & )

private

Member Function Documentation

template<class TMetric >

virtual FloatType itk::RegistrationParameterScalesFromShiftBase< TMetric >::ComputeMaximumVoxelShift ( const ParametersType & deltaParameters )

protectedvirtual

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

template<class TMetric >

virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::ComputeSampleShifts	(	const ParametersType &	deltaParameters,
		ScalesType &	localShifts
	)

protectedpure virtual

Compute the sample shifts.

Implemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

template<class TMetric >

virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::EstimateLocalStepScales	(	const ParametersType &	step,
		ScalesType &	localStepScales
	)

virtual

Estimate the scales of local steps.

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::EstimateScales ( ScalesType & scales )

virtual

Estimate parameter scales

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual FloatType itk::RegistrationParameterScalesFromShiftBase< TMetric >::EstimateStepScale ( const ParametersType & step )

virtual

Estimate the scale of a step

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

virtual const char* itk::RegistrationParameterScalesFromShiftBase< TMetric >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

template<class TMetric >

void itk::RegistrationParameterScalesFromShiftBase< TMetric >::operator= ( const Self & )

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.

template<class TMetric >

virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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 >.

Reimplemented in itk::RegistrationParameterScalesFromIndexShift< TMetric >, and itk::RegistrationParameterScalesFromPhysicalShift< TMetric >.