#include <itkRegistrationParameterScalesFromShiftBase.h>

Inheritance diagram for itk::RegistrationParameterScalesFromShiftBase< TMetric >:

Collaboration diagram for itk::RegistrationParameterScalesFromShiftBase< TMetric >:

Detailed Description

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

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 ParametersType::ValueType	ParametersValueType

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 SmartPointer< const Self >	ConstPointer

typedef FixedTransformType::ConstPointer	FixedTransformConstPointer

typedef MetricType::FixedTransformType	FixedTransformType

typedef Superclass::FloatType	FloatType

typedef TMetric::JacobianType	JacobianType

typedef MetricType::ConstPointer	MetricConstPointer

typedef MetricType::Pointer	MetricPointer

typedef TMetric	MetricType

typedef MovingTransformType::ConstPointer	MovingTransformConstPointer

typedef MetricType::MovingTransformType	MovingTransformType

typedef Superclass::ParametersType	ParametersType

typedef SmartPointer< Self >	Pointer

typedef std::vector< VirtualPointType >	SamplePointContainerType

enum	SamplingStrategyType { FullDomainSampling = 0, CornerSampling, RandomSampling, CentralRegionSampling, VirtualDomainPointSetSampling }

typedef Superclass::ScalesType	ScalesType

typedef RegistrationParameterScalesEstimator	Self

typedef OptimizerParameterScalesEstimatorTemplate< typename TMetric::ParametersValueType >	Superclass

typedef TMetric::VirtualImageConstPointer	VirtualImageConstPointer

typedef TMetric::VirtualImagePointer	VirtualImagePointer

typedef TMetric::VirtualImageType	VirtualImageType

typedef TMetric::VirtualIndexType	VirtualIndexType

typedef TMetric::VirtualPointSetPointer	VirtualPointSetPointer

typedef TMetric::VirtualPointSetType	VirtualPointSetType

typedef TMetric::VirtualPointType	VirtualPointType

typedef TMetric::VirtualRegionType	VirtualRegionType

typedef TMetric::VirtualSizeType	VirtualSizeType

typedef TMetric::VirtualSpacingType	VirtualSpacingType

Public Types inherited from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >
typedef SmartPointer< const Self >	ConstPointer

typedef TMetric::ParametersValueType	FloatType

typedef OptimizerParameters< TMetric::ParametersValueType >	ParametersType

typedef SmartPointer< Self >	Pointer

typedef OptimizerParameters< TMetric::ParametersValueType >	ScalesType

typedef OptimizerParameterScalesEstimatorTemplate	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales) override

virtual void	EstimateScales (ScalesType &scales) override

virtual FloatType	EstimateStepScale (const ParametersType &step) override

virtual const char *	GetNameOfClass () const


virtual void	SetSmallParameterVariation (ParametersValueType _arg)

virtual ParametersValueType	GetSmallParameterVariation () const

Public Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
virtual FloatType	EstimateMaximumStepSize () override

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 () const

Public Member Functions inherited from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >
virtual void	EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)=0

virtual void	EstimateScales (ScalesType &scales)=0

virtual FloatType	EstimateStepScale (const ParametersType &step)=0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual LightObject::Pointer	CreateAnother () const override

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexcept override

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

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 override

	RegistrationParameterScalesFromShiftBase ()

	~RegistrationParameterScalesFromShiftBase ()

Protected Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
bool	CheckAndSetInputs ()

bool	CheckGeneralAffineTransform ()

template<typename TTransform >
bool	CheckGeneralAffineTransformTemplated ()

void	ComputeSquaredJacobianNorms (const VirtualPointType &p, ParametersType &squareNorms)

SizeValueType	GetDimension ()

SizeValueType	GetNumberOfLocalParameters ()

virtual SamplingStrategyType	GetSamplingStrategy ()

const TransformBaseTemplate< typename TMetric::MeasureType > *	GetTransform ()

VirtualIndexType	GetVirtualDomainCentralIndex ()

VirtualRegionType	GetVirtualDomainCentralRegion ()

bool	IsBSplineTransform ()

bool	IsDisplacementFieldTransform ()

	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)

bool	TransformHasLocalSupportForScalesEstimation ()

template<typename TTargetPointType >
void	TransformPoint (const VirtualPointType &point, TTargetPointType &mappedPoint)

template<typename TContinuousIndexType >
void	TransformPointToContinuousIndex (const VirtualPointType &point, TContinuousIndexType &mappedIndex)

void	UpdateTransformParameters (const ParametersType &deltaParameters)

	~RegistrationParameterScalesEstimator ()

Protected Member Functions inherited from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >
	OptimizerParameterScalesEstimatorTemplate ()

	~OptimizerParameterScalesEstimatorTemplate ()

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 &) ITK_DELETE_FUNCTION

	RegistrationParameterScalesFromShiftBase (const Self &) ITK_DELETE_FUNCTION

Private Attributes
ParametersValueType	m_SmallParameterVariation

Additional Inherited Members
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 ()

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

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Static Protected Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
static ITK_CONSTEXPR SizeValueType	SizeOfSmallDomain = 1000

Member Typedef Documentation

template<typename TMetric >

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

Definition at line 51 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 69 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Type of float

Definition at line 64 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 70 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 68 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Type of parameters of the optimizer

Definition at line 60 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

typedef ParametersType::ValueType itk::RegistrationParameterScalesFromShiftBase< TMetric >::ParametersValueType

Definition at line 61 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 50 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Type of scales

Definition at line 54 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Standard class typedefs.

Definition at line 48 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 49 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 71 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 67 of file itkRegistrationParameterScalesFromShiftBase.h.

template<typename TMetric >

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

Definition at line 66 of file itkRegistrationParameterScalesFromShiftBase.h.

Constructor & Destructor Documentation

template<typename TMetric >

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

protected

Referenced by itk::RegistrationParameterScalesFromShiftBase< TMetric >::~RegistrationParameterScalesFromShiftBase().

template<typename TMetric >

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

inlineprotected

Definition at line 90 of file itkRegistrationParameterScalesFromShiftBase.h.

References itk::RegistrationParameterScalesFromShiftBase< TMetric >::ComputeMaximumVoxelShift(), itk::RegistrationParameterScalesFromShiftBase< TMetric >::ComputeSampleShifts(), itk::RegistrationParameterScalesFromShiftBase< TMetric >::operator=(), itk::RegistrationParameterScalesFromShiftBase< TMetric >::PrintSelf(), and itk::RegistrationParameterScalesFromShiftBase< TMetric >::RegistrationParameterScalesFromShiftBase().

template<typename TMetric >

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

private

Member Function Documentation

template<typename TMetric >

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

protectedvirtual

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

Referenced by itk::RegistrationParameterScalesFromShiftBase< TMetric >::~RegistrationParameterScalesFromShiftBase().

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

Referenced by itk::RegistrationParameterScalesFromShiftBase< TMetric >::~RegistrationParameterScalesFromShiftBase().

template<typename TMetric >

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

overridevirtual

Estimate the scales of local steps

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<typename TMetric >

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

overridevirtual

Estimate parameter scales

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<typename TMetric >

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

overridevirtual

Estimate the scale of a step

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<typename 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<typename TMetric >

virtual ParametersValueType itk::RegistrationParameterScalesFromShiftBase< TMetric >::GetSmallParameterVariation ( ) const

virtual

Set/get small parameter variation

template<typename TMetric >

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

private

Referenced by itk::RegistrationParameterScalesFromShiftBase< TMetric >::~RegistrationParameterScalesFromShiftBase().

template<typename TMetric >

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

overrideprotectedvirtual

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

Referenced by itk::RegistrationParameterScalesFromShiftBase< TMetric >::~RegistrationParameterScalesFromShiftBase().

template<typename TMetric >

virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::SetSmallParameterVariation ( ParametersValueType _arg )

virtual

Set/get small parameter variation