itk::RegistrationParameterScalesFromPhysicalShift< TMetric > Class Template Reference

#include <itkRegistrationParameterScalesFromPhysicalShift.h>

Inheritance diagram for itk::RegistrationParameterScalesFromPhysicalShift< TMetric >:

Collaboration diagram for itk::RegistrationParameterScalesFromPhysicalShift< TMetric >:

Detailed Description

template<typename TMetric>
class itk::RegistrationParameterScalesFromPhysicalShift< TMetric >

Registration helper class for estimating scales of transform parameters a step sizes, from the maximum voxel shift in physical space caused by a parameter change.

Examples:

Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, and SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx.

Definition at line 34 of file itkRegistrationParameterScalesFromPhysicalShift.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	FixedTransformType = typename Superclass::FixedTransformType
using	FloatType = typename Superclass::FloatType
using	JacobianType = typename Superclass::JacobianType
using	MovingTransformType = typename Superclass::MovingTransformType
using	ParametersType = typename Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	ScalesType = typename Superclass::ScalesType
using	Self = RegistrationParameterScalesFromPhysicalShift
using	Superclass = RegistrationParameterScalesFromShiftBase< TMetric >
using	VirtualImageConstPointer = typename Superclass::VirtualImageConstPointer
using	VirtualIndexType = typename Superclass::VirtualIndexType
using	VirtualPointType = typename Superclass::VirtualPointType
Public Types inherited from itk::RegistrationParameterScalesFromShiftBase< TMetric >
using	ConstPointer = SmartPointer< const Self >
using	FixedTransformType = typename Superclass::FixedTransformType
using	FloatType = typename Superclass::FloatType
using	JacobianType = typename Superclass::JacobianType
using	MovingTransformType = typename Superclass::MovingTransformType
using	ParametersType = typename Superclass::ParametersType
using	ParametersValueType = typename ParametersType::ValueType
using	Pointer = SmartPointer< Self >
using	ScalesType = typename Superclass::ScalesType
using	Self = RegistrationParameterScalesFromShiftBase
using	Superclass = RegistrationParameterScalesEstimator< TMetric >
using	VirtualImageConstPointer = typename Superclass::VirtualImageConstPointer
using	VirtualIndexType = typename Superclass::VirtualIndexType
using	VirtualPointType = typename Superclass::VirtualPointType
Public Types inherited from itk::RegistrationParameterScalesEstimator< TMetric >
using	ConstPointer = SmartPointer< const Self >
using	FixedTransformConstPointer = typename FixedTransformType::ConstPointer
using	FixedTransformType = typename MetricType::FixedTransformType
using	FloatType = typename Superclass::FloatType
using	JacobianType = typename TMetric::JacobianType
using	MetricConstPointer = typename MetricType::ConstPointer
using	MetricPointer = typename MetricType::Pointer
using	MetricType = TMetric
using	MovingTransformConstPointer = typename MovingTransformType::ConstPointer
using	MovingTransformType = typename MetricType::MovingTransformType
using	ParametersType = typename Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	SamplePointContainerType = std::vector< VirtualPointType >
enum	SamplingStrategyType {   FullDomainSampling = 0,   CornerSampling,   RandomSampling,   CentralRegionSampling,   VirtualDomainPointSetSampling }
using	ScalesType = typename Superclass::ScalesType
using	Self = RegistrationParameterScalesEstimator
using	Superclass = OptimizerParameterScalesEstimatorTemplate< typename TMetric::ParametersValueType >
using	VirtualImageConstPointer = typename TMetric::VirtualImageConstPointer
using	VirtualImagePointer = typename TMetric::VirtualImagePointer
using	VirtualImageType = typename TMetric::VirtualImageType
using	VirtualIndexType = typename TMetric::VirtualIndexType
using	VirtualPointSetPointer = typename TMetric::VirtualPointSetPointer
using	VirtualPointSetType = typename TMetric::VirtualPointSetType
using	VirtualPointType = typename TMetric::VirtualPointType
using	VirtualRegionType = typename TMetric::VirtualRegionType
using	VirtualSizeType = typename TMetric::VirtualSizeType
using	VirtualSpacingType = typename TMetric::VirtualSpacingType
Public Types inherited from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >
using	ConstPointer = SmartPointer< const Self >
using	FloatType = TMetric::ParametersValueType
using	ParametersType = OptimizerParameters< TMetric::ParametersValueType >
using	Pointer = SmartPointer< Self >
using	ScalesType = OptimizerParameters< TMetric::ParametersValueType >
using	Self = OptimizerParameterScalesEstimatorTemplate
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::RegistrationParameterScalesFromShiftBase< TMetric >
void	EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales) override
void	EstimateScales (ScalesType &scales) override
FloatType	EstimateStepScale (const ParametersType &step) override
virtual void	SetSmallParameterVariation (ParametersValueType _arg)
virtual ParametersValueType	GetSmallParameterVariation () const
Public Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
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 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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
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

Static Public Member Functions
static Pointer	New ()
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 ()

Protected Member Functions
void	ComputeSampleShifts (const ParametersType &deltaParameters, ScalesType &localShifts) override
void	PrintSelf (std::ostream &os, Indent indent) const override
	RegistrationParameterScalesFromPhysicalShift ()=default
	~RegistrationParameterScalesFromPhysicalShift () override=default
Protected Member Functions inherited from itk::RegistrationParameterScalesFromShiftBase< TMetric >
virtual FloatType	ComputeMaximumVoxelShift (const ParametersType &deltaParameters)
void	PrintSelf (std::ostream &os, Indent indent) const override
	RegistrationParameterScalesFromShiftBase ()
	~RegistrationParameterScalesFromShiftBase () override=default
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 () override=default
Protected Member Functions inherited from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >
	OptimizerParameterScalesEstimatorTemplate ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~OptimizerParameterScalesEstimatorTemplate () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
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
template<typename TTransform >
void	ComputeSampleShiftsInternal (const ParametersType &deltaParameters, ScalesType &localShifts)

Additional Inherited Members
Static Public Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
static constexpr SizeValueType	FixedDimension = TMetric::FixedDimension
static constexpr SizeValueType	MovingDimension = TMetric::MovingDimension
static constexpr 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
std::atomic< int >	m_ReferenceCount
Static Protected Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
static constexpr SizeValueType	SizeOfSmallDomain = 1000

Member Typedef Documentation

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::ConstPointer = SmartPointer<const Self>

Definition at line 44 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::FixedTransformType = typename Superclass::FixedTransformType

Definition at line 64 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::FloatType = typename Superclass::FloatType

Type of float

Definition at line 59 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::JacobianType = typename Superclass::JacobianType

Definition at line 65 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::MovingTransformType = typename Superclass::MovingTransformType

Definition at line 63 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::ParametersType = typename Superclass::ParametersType

Type of parameters of the optimizer

Definition at line 56 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::Pointer = SmartPointer<Self>

Definition at line 43 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::ScalesType = typename Superclass::ScalesType

Type of scales

Definition at line 53 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::Self = RegistrationParameterScalesFromPhysicalShift

Standard class type aliases.

Definition at line 41 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::Superclass = RegistrationParameterScalesFromShiftBase< TMetric >

Definition at line 42 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::VirtualImageConstPointer = typename Superclass::VirtualImageConstPointer

Definition at line 66 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::VirtualIndexType = typename Superclass::VirtualIndexType

Definition at line 62 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >

using itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::VirtualPointType = typename Superclass::VirtualPointType

Definition at line 61 of file itkRegistrationParameterScalesFromPhysicalShift.h.

Constructor & Destructor Documentation

template<typename TMetric >

itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::RegistrationParameterScalesFromPhysicalShift ( )

protecteddefault

template<typename TMetric >

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

overrideprotecteddefault

Member Function Documentation

template<typename TMetric >

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

overrideprotectedvirtual

Compute the sample shifts.

Implements itk::RegistrationParameterScalesFromShiftBase< TMetric >.

template<typename TMetric >

template<typename TTransform >

void itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::ComputeSampleShiftsInternal ( const ParametersType &  deltaParameters, ScalesType &  localShifts  )

private

template<typename TMetric >

virtual::itk::LightObject::Pointer itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::CreateAnother ( ) 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<typename TMetric >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::RegistrationParameterScalesFromShiftBase< TMetric >.

template<typename TMetric >

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

static

Method for creation through the object factory.

template<typename TMetric >

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

---

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

• itkRegistrationParameterScalesFromPhysicalShift.h