#include <itkRegistrationParameterScalesFromShiftBase.h>

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 44 of file itkRegistrationParameterScalesFromShiftBase.h.

Inheritance diagram for itk::RegistrationParameterScalesFromShiftBase< TMetric >:

Collaboration diagram for itk::RegistrationParameterScalesFromShiftBase< TMetric >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ParametersValueType = typename ParametersType::ValueType

using	Pointer = SmartPointer< Self >

using	Self = RegistrationParameterScalesFromShiftBase

using	Superclass = RegistrationParameterScalesEstimator< TMetric >

Public Types inherited from itk::RegistrationParameterScalesEstimator< TMetric >
using	ConstPointer = SmartPointer< const Self >

using	FixedTransformConstPointer = typename FixedTransformType::ConstPointer

using	FixedTransformType = typename MetricType::FixedTransformType

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	Pointer = SmartPointer< Self >

using	SamplePointContainerType = std::vector< VirtualPointType >

using	SamplingStrategyType = SamplingStrategyEnum

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
void	EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales) override

void	EstimateScales (ScalesType &parameterScales) override

FloatType	EstimateStepScale (const ParametersType &step) override

const char *	GetNameOfClass () const override


virtual void	SetSmallParameterVariation (ParametersValueType _arg)

virtual ParametersValueType	GetSmallParameterVariation () const

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

virtual void	SetScalesSamplingStrategy ()

virtual void	SetStepScaleSamplingStrategy ()

virtual void	SetMetric (MetricType *_arg)

virtual const MetricType *	GetMetric () const

virtual void	SetTransformForward (bool _arg)

virtual bool	GetTransformForward () const

virtual void	TransformForwardOn ()

virtual void	SetVirtualDomainPointSet (const VirtualPointSetType *_arg)

virtual const VirtualPointSetType *	GetVirtualDomainPointSet () const

virtual void	SetCentralRegionRadius (IndexValueType _arg)

virtual IndexValueType	GetCentralRegionRadius () const

Public Member Functions inherited from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >
const char *	GetNameOfClass () const override

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

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

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

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 &point, 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 &timeStamp)

	~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 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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

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

◆ ConstPointer

template<typename TMetric >

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

Definition at line 54 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ ParametersValueType

template<typename TMetric >

using itk::RegistrationParameterScalesFromShiftBase< TMetric >::ParametersValueType = typename ParametersType::ValueType

Definition at line 64 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ Pointer

template<typename TMetric >

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

Definition at line 53 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ Self

template<typename TMetric >

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

Standard class type aliases.

Definition at line 51 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ Superclass

template<typename TMetric >

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

Definition at line 52 of file itkRegistrationParameterScalesFromShiftBase.h.

Constructor & Destructor Documentation

◆ RegistrationParameterScalesFromShiftBase()

template<typename TMetric >

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

protected

◆ ~RegistrationParameterScalesFromShiftBase()

template<typename TMetric >

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

overrideprotecteddefault

Member Function Documentation

◆ ComputeMaximumVoxelShift()

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.

◆ ComputeSampleShifts()

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

◆ EstimateLocalStepScales()

template<typename TMetric >

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

overridevirtual

Estimate the scales of local steps

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

◆ EstimateScales()

template<typename TMetric >

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

overridevirtual

Estimate parameter scales

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

◆ EstimateStepScale()

template<typename TMetric >

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

overridevirtual

Estimate the scale of a step

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

◆ GetNameOfClass()

template<typename TMetric >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::RegistrationParameterScalesEstimator< TMetric >.

◆ GetSmallParameterVariation()

template<typename TMetric >

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

virtual

Set/get small parameter variation

◆ PrintSelf()

template<typename TMetric >

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

◆ SetSmallParameterVariation()

template<typename TMetric >

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

virtual

Set/get small parameter variation

Member Data Documentation

◆ m_SmallParameterVariation

template<typename TMetric >

ParametersValueType itk::RegistrationParameterScalesFromShiftBase< TMetric >::m_SmallParameterVariation {}

private

Definition at line 112 of file itkRegistrationParameterScalesFromShiftBase.h.

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

itkRegistrationParameterScalesFromShiftBase.h

Detailed Description

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ParametersValueType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ RegistrationParameterScalesFromShiftBase()

◆ ~RegistrationParameterScalesFromShiftBase()

Member Function Documentation

◆ ComputeMaximumVoxelShift()

◆ ComputeSampleShifts()

◆ EstimateLocalStepScales()

◆ EstimateScales()

◆ EstimateStepScale()

◆ GetNameOfClass()

◆ GetSmallParameterVariation()

◆ PrintSelf()

◆ SetSmallParameterVariation()

Member Data Documentation

◆ m_SmallParameterVariation

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