#include <itkRegistrationParameterScalesFromJacobian.h>

Inheritance diagram for itk::RegistrationParameterScalesFromJacobian< TMetric >:

Collaboration diagram for itk::RegistrationParameterScalesFromJacobian< 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 RegistrationParameterScalesFromJacobian	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 ::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
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 ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	ComputeSampleStepScales (const ParametersType &step, ScalesType &sampleScales)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	RegistrationParameterScalesFromJacobian ()
	~RegistrationParameterScalesFromJacobian ()
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 &)
	RegistrationParameterScalesFromJacobian (const Self &)

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::RegistrationParameterScalesFromJacobian< TMetric >

Implements a registration helper class for estimating scales of transform parameters from Jacobian norms.

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 averaged squared norm of the Jacobian w.r.t the parameter. The averaging is done over a sampling of the image domain. The sampling by default is a uniform random distribution.

Definition at line 41 of file itkRegistrationParameterScalesFromJacobian.h.

Member Typedef Documentation

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 49 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Type of the transform to initialize

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 69 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Type of float

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 64 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Type of Jacobian of transform.

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 70 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 68 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Type of parameters of the optimizer

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 61 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 48 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Type of scales

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 55 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

typedef RegistrationParameterScalesFromJacobian itk::RegistrationParameterScalesFromJacobian< TMetric >::Self

Standard class typedefs.

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 46 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 47 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 71 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 67 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

Definition at line 66 of file itkRegistrationParameterScalesFromJacobian.h.

Constructor & Destructor Documentation

template<class TMetric >

itk::RegistrationParameterScalesFromJacobian< TMetric >::RegistrationParameterScalesFromJacobian ( )

protected

template<class TMetric >

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

inlineprotected

Definition at line 101 of file itkRegistrationParameterScalesFromJacobian.h.

template<class TMetric >

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

private

Member Function Documentation

template<class TMetric >

void itk::RegistrationParameterScalesFromJacobian< TMetric >::ComputeSampleStepScales	(	const ParametersType &	step,
		ScalesType &	sampleScales
	)

protected

Compute the step scales for samples, i.e. the impacts on each sampled voxel from a change on the transform.

template<class TMetric >

virtual::itk::LightObject::Pointer itk::RegistrationParameterScalesFromJacobian< 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::RegistrationParameterScalesFromJacobian< TMetric >::EstimateLocalStepScales	(	const ParametersType &	step,
		ScalesType &	localStepScales
	)

virtual

Estimate the scales of local steps.

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

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

virtual

Estimate parameter scales.

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

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

virtual

Estimate the scale for $\Delta p$ , the step of change on parameters. The step scale describes the impact of $\Delta p$ on the transform.

Let us denote the transform by

$T(x, p) = T(x, p_0 + t * \Delta p)$

where $x$ is the coordinates of a voxel, $p = p_0+t*\Delta p$ is the transform parameters, and $t$ is the step factor.

At a specific voxel at $x$ , the step scale w.r.t. $\Delta p$ is defined here as

$|\frac{dT}{dt}| = |\frac{\partial T}{\partial p} * \Delta p |.$

For multiple voxels, we average the above formula to get the overall step scale.

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

template<class TMetric >

static Pointer itk::RegistrationParameterScalesFromJacobian< TMetric >::New ( )

static

New macro for creation of through a Smart Pointer.

Reimplemented from itk::Object.

template<class TMetric >

void itk::RegistrationParameterScalesFromJacobian< 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::RegistrationParameterScalesFromJacobian< 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 >.

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

itkRegistrationParameterScalesFromJacobian.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<class TMetric> class itk::RegistrationParameterScalesFromJacobian< TMetric >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class TMetric>
class itk::RegistrationParameterScalesFromJacobian< TMetric >