ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
itk::RegistrationParameterScalesEstimator< TMetric > Class Template Referenceabstract
Group Numerics » Module ITKOptimizersv4

#include <itkRegistrationParameterScalesEstimator.h>

Detailed Description

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

Implements a registration helper class for estimating scales of transform parameters and step sizes.

Its input is a metric, from which the fixed/moving images and transform objects are obtained.

This class implements some common methods as building blocks called by subclasses with various estimation strategies. One of these methods is SampleVirtualDomain, which provides various choices of sampling the image domain.

Note
When used with a PointSetToPointSet type metric, a VirtualDomainPointSet must be defined, for use in shift estimation. See SetVirtualDomainPointSet(). The virtual domain point set can be retrieved from a metric using the GetVirtualTransformedPointSet() method within the metric.

Definition at line 80 of file itkRegistrationParameterScalesEstimator.h.

+ Inheritance diagram for itk::RegistrationParameterScalesEstimator< TMetric >:
+ Collaboration diagram for itk::RegistrationParameterScalesEstimator< TMetric >:

Public Types

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=0
 
FloatType EstimateMaximumStepSize () override
 
void EstimateScales (ScalesType &scales) override=0
 
FloatType EstimateStepScale (const ParametersType &step) override=0
 
const char * GetNameOfClass () const 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 >
virtual void EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)=0
 
virtual FloatType EstimateMaximumStepSize ()=0
 
virtual void EstimateScales (ScalesType &scales)=0
 
virtual FloatType EstimateStepScale (const ParametersType &step)=0
 
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
 
const char * GetNameOfClass () const override
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Attributes

static constexpr SizeValueType FixedDimension = TMetric::FixedDimension
 
static constexpr SizeValueType MovingDimension = TMetric::MovingDimension
 
static constexpr SizeValueType VirtualDimension = TMetric::VirtualDimension
 

Protected Member Functions

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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

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

static constexpr SizeValueType SizeOfSmallDomain = 1000
 

Private Attributes

SamplingStrategyType m_SamplingStrategy {}
 
bool m_TransformForward {}
 

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

Member Typedef Documentation

◆ ConstPointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::ConstPointer = SmartPointer<const Self>

Definition at line 90 of file itkRegistrationParameterScalesEstimator.h.

◆ FixedTransformConstPointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::FixedTransformConstPointer = typename FixedTransformType::ConstPointer

Definition at line 110 of file itkRegistrationParameterScalesEstimator.h.

◆ FixedTransformType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::FixedTransformType = typename MetricType::FixedTransformType

Type of the transform to initialize

Definition at line 109 of file itkRegistrationParameterScalesEstimator.h.

◆ JacobianType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::JacobianType = typename TMetric::JacobianType

Type of Jacobian of transform.

Definition at line 148 of file itkRegistrationParameterScalesEstimator.h.

◆ MetricConstPointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::MetricConstPointer = typename MetricType::ConstPointer

Definition at line 106 of file itkRegistrationParameterScalesEstimator.h.

◆ MetricPointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::MetricPointer = typename MetricType::Pointer

Definition at line 105 of file itkRegistrationParameterScalesEstimator.h.

◆ MetricType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::MetricType = TMetric

Definition at line 104 of file itkRegistrationParameterScalesEstimator.h.

◆ MovingTransformConstPointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::MovingTransformConstPointer = typename MovingTransformType::ConstPointer

Definition at line 113 of file itkRegistrationParameterScalesEstimator.h.

◆ MovingTransformType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::MovingTransformType = typename MetricType::MovingTransformType

Definition at line 112 of file itkRegistrationParameterScalesEstimator.h.

◆ Pointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::Pointer = SmartPointer<Self>

Definition at line 89 of file itkRegistrationParameterScalesEstimator.h.

◆ SamplePointContainerType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::SamplePointContainerType = std::vector<VirtualPointType>

Definition at line 145 of file itkRegistrationParameterScalesEstimator.h.

◆ SamplingStrategyType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::SamplingStrategyType = SamplingStrategyEnum

Enables backwards compatibility for enum values

Definition at line 133 of file itkRegistrationParameterScalesEstimator.h.

◆ Self

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::Self = RegistrationParameterScalesEstimator

Standard class type aliases.

Definition at line 87 of file itkRegistrationParameterScalesEstimator.h.

◆ Superclass

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::Superclass = OptimizerParameterScalesEstimatorTemplate<typename TMetric::ParametersValueType>

Definition at line 88 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualImageConstPointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImageConstPointer = typename TMetric::VirtualImageConstPointer

Definition at line 121 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualImagePointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImagePointer = typename TMetric::VirtualImagePointer

Definition at line 122 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualImageType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualImageType = typename TMetric::VirtualImageType

Definition at line 120 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualIndexType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualIndexType = typename TMetric::VirtualIndexType

Definition at line 127 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualPointSetPointer

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointSetPointer = typename TMetric::VirtualPointSetPointer

Definition at line 130 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualPointSetType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointSetType = typename TMetric::VirtualPointSetType

Definition at line 129 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualPointType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualPointType = typename TMetric::VirtualPointType

Definition at line 126 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualRegionType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualRegionType = typename TMetric::VirtualRegionType

Definition at line 124 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualSizeType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualSizeType = typename TMetric::VirtualSizeType

Definition at line 125 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualSpacingType

template<typename TMetric >
using itk::RegistrationParameterScalesEstimator< TMetric >::VirtualSpacingType = typename TMetric::VirtualSpacingType

Definition at line 123 of file itkRegistrationParameterScalesEstimator.h.

Constructor & Destructor Documentation

◆ RegistrationParameterScalesEstimator()

template<typename TMetric >
itk::RegistrationParameterScalesEstimator< TMetric >::RegistrationParameterScalesEstimator ( )
protected

◆ ~RegistrationParameterScalesEstimator()

template<typename TMetric >
itk::RegistrationParameterScalesEstimator< TMetric >::~RegistrationParameterScalesEstimator ( )
overrideprotecteddefault

Member Function Documentation

◆ CheckAndSetInputs()

template<typename TMetric >
bool itk::RegistrationParameterScalesEstimator< TMetric >::CheckAndSetInputs ( )
protected

Validate the metric and the transforms and set them.

◆ CheckGeneralAffineTransform()

template<typename TMetric >
bool itk::RegistrationParameterScalesEstimator< TMetric >::CheckGeneralAffineTransform ( )
protected

Check if the transform is a general affine transform that maps a line segment to a line segment.

◆ CheckGeneralAffineTransformTemplated()

template<typename TMetric >
template<typename TTransform >
bool itk::RegistrationParameterScalesEstimator< TMetric >::CheckGeneralAffineTransformTemplated ( )
protected

The templated version of CheckGeneralAffineTransform to check if the transform is a general affine transform that maps a line segment to a line segment.

Examples are subclasses of MatrixOffsetTransformBaseType, TranslationTransform, Rigid3DPerspectiveTransform, IdentityTransform, etc.

◆ ComputeSquaredJacobianNorms()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::ComputeSquaredJacobianNorms ( const VirtualPointType &  point,
ParametersType &  squareNorms 
)
protected

Compute the squared norms of the transform Jacobians w.r.t parameters at a physical point.

◆ EstimateLocalStepScales()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::EstimateLocalStepScales ( const ParametersType &  step,
ScalesType &  localStepScales 
)
overridepure virtual

Estimate the scales of local steps.

Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.

Implemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.

◆ EstimateMaximumStepSize()

template<typename TMetric >
FloatType itk::RegistrationParameterScalesEstimator< TMetric >::EstimateMaximumStepSize ( )
overridevirtual

Estimate the trusted scale for steps. It returns the voxel spacing.

Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.

◆ EstimateScales()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::EstimateScales ( ScalesType &  scales)
overridepure virtual

Estimate parameter scales

Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.

Implemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.

◆ EstimateStepScale()

template<typename TMetric >
FloatType itk::RegistrationParameterScalesEstimator< TMetric >::EstimateStepScale ( const ParametersType &  step)
overridepure virtual

Estimate the step scale, the impact of a step on deformation.

Implements itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >.

Implemented in itk::RegistrationParameterScalesFromJacobian< TMetric >, and itk::RegistrationParameterScalesFromShiftBase< TMetric >.

◆ GetCentralRegionRadius()

template<typename TMetric >
virtual IndexValueType itk::RegistrationParameterScalesEstimator< TMetric >::GetCentralRegionRadius ( ) const
virtual

the radius of the central region for sampling.

◆ GetDimension()

template<typename TMetric >
SizeValueType itk::RegistrationParameterScalesEstimator< TMetric >::GetDimension ( )
protected

Get the dimension of the target transformed to.

◆ GetMetric()

template<typename TMetric >
virtual const MetricType * itk::RegistrationParameterScalesEstimator< TMetric >::GetMetric ( ) const
virtual

SetMetric sets the metric used in the estimation process. The transforms from the metric will be used for estimation, along with the images when appropriate.

◆ GetNameOfClass()

template<typename TMetric >
const char * itk::RegistrationParameterScalesEstimator< TMetric >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

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

◆ GetNumberOfLocalParameters()

template<typename TMetric >
SizeValueType itk::RegistrationParameterScalesEstimator< TMetric >::GetNumberOfLocalParameters ( )
protected

Get the number of local parameters.

◆ GetSamplingStrategy()

template<typename TMetric >
virtual SamplingStrategyType itk::RegistrationParameterScalesEstimator< TMetric >::GetSamplingStrategy ( )
protectedvirtual

Get the current sampling strategy. Note that this is changed internally as the class is used for scale or step estimation.

◆ GetTransform()

template<typename TMetric >
const TransformBaseTemplate< typename TMetric::MeasureType > * itk::RegistrationParameterScalesEstimator< TMetric >::GetTransform ( )
protected

Get the transform in use.

◆ GetTransformForward()

template<typename TMetric >
virtual bool itk::RegistrationParameterScalesEstimator< TMetric >::GetTransformForward ( ) const
virtual

m_TransformForward specifies which transform scales to be estimated. m_TransformForward = true (default) for the moving transform parameters. m_TransformForward = false for the fixed transform parameters.

◆ GetVirtualDomainCentralIndex()

template<typename TMetric >
VirtualIndexType itk::RegistrationParameterScalesEstimator< TMetric >::GetVirtualDomainCentralIndex ( )
protected

Get the central index of the virtual domain.

Gets the region around the virtual image center.

◆ GetVirtualDomainCentralRegion()

template<typename TMetric >
VirtualRegionType itk::RegistrationParameterScalesEstimator< TMetric >::GetVirtualDomainCentralRegion ( )
protected

Get the central region of the virtual domain.

◆ GetVirtualDomainPointSet()

template<typename TMetric >
virtual const VirtualPointSetType * itk::RegistrationParameterScalesEstimator< TMetric >::GetVirtualDomainPointSet ( ) const
virtual

Get/Set a point set for virtual domain sampling.

◆ IsBSplineTransform()

template<typename TMetric >
bool itk::RegistrationParameterScalesEstimator< TMetric >::IsBSplineTransform ( )
protected

Check if the transform being optimized is a B-spline transform.

◆ IsDisplacementFieldTransform()

template<typename TMetric >
bool itk::RegistrationParameterScalesEstimator< TMetric >::IsDisplacementFieldTransform ( )
protected

Check if the transform being optimized is a displacement field transform.

◆ PrintSelf()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< 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::Object.

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

◆ SampleVirtualDomain()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SampleVirtualDomain ( )
protectedvirtual

Sample the virtual domain with physical points and store the results in m_SamplePoints.

◆ SampleVirtualDomainFully()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::SampleVirtualDomainFully ( )
protected

Sample the virtual domain with all pixels.

◆ SampleVirtualDomainRandomly()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::SampleVirtualDomainRandomly ( )
protected

Sample the virtual domain randomly in a uniform distribution.

◆ SampleVirtualDomainWithCentralRegion()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::SampleVirtualDomainWithCentralRegion ( )
protected

Sample the virtual domain with the voxel in the central region.

Samples the virtual domain with the voxels around the center.

◆ SampleVirtualDomainWithCorners()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::SampleVirtualDomainWithCorners ( )
protected

Sample the virtual domain with corners.

Sample the virtual domain with the points at image corners, and store the results in m_SamplePoints.

◆ SampleVirtualDomainWithPointSet()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::SampleVirtualDomainWithPointSet ( )
protected

Sample the virtual domain with a point set

◆ SampleVirtualDomainWithRegion()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::SampleVirtualDomainWithRegion ( VirtualRegionType  region)
protected

Sample the virtual domain with all voxels inside a region.

◆ SetCentralRegionRadius()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetCentralRegionRadius ( IndexValueType  _arg)
virtual

the radius of the central region for sampling.

◆ SetMetric()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetMetric ( MetricType *  _arg)
virtual

SetMetric sets the metric used in the estimation process. The transforms from the metric will be used for estimation, along with the images when appropriate.

◆ SetNumberOfRandomSamples()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetNumberOfRandomSamples ( SizeValueType  _arg)
protectedvirtual

Set and get the number of samples.

◆ SetSamplingStrategy()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetSamplingStrategy ( SamplingStrategyType  _arg)
protectedvirtual

Set the sampling strategy. This is called from SetScalesSamplingStrategy() and SetStepScaleSamplingStrategy().

◆ SetScalesSamplingStrategy()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetScalesSamplingStrategy ( )
virtual

Set the sampling strategy automatically for scales estimation.

◆ SetStepScaleSamplingStrategy()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetStepScaleSamplingStrategy ( )
virtual

Set the sampling strategy automatically for step scale estimation.

◆ SetTransformForward()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetTransformForward ( bool  _arg)
virtual

m_TransformForward specifies which transform scales to be estimated. m_TransformForward = true (default) for the moving transform parameters. m_TransformForward = false for the fixed transform parameters.

◆ SetVirtualDomainPointSet()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::SetVirtualDomainPointSet ( const VirtualPointSetType *  _arg)
virtual

Get/Set a point set for virtual domain sampling.

◆ TransformForwardOn()

template<typename TMetric >
virtual void itk::RegistrationParameterScalesEstimator< TMetric >::TransformForwardOn ( )
virtual

m_TransformForward specifies which transform scales to be estimated. m_TransformForward = true (default) for the moving transform parameters. m_TransformForward = false for the fixed transform parameters.

◆ TransformHasLocalSupportForScalesEstimation()

template<typename TMetric >
bool itk::RegistrationParameterScalesEstimator< TMetric >::TransformHasLocalSupportForScalesEstimation ( )
protected

Check if the transform being optimized has local support.

◆ TransformPoint()

template<typename TMetric >
template<typename TTargetPointType >
void itk::RegistrationParameterScalesEstimator< TMetric >::TransformPoint ( const VirtualPointType &  point,
TTargetPointType &  mappedPoint 
)
protected

Transform a physical point to a new physical point.

We want to compute shift in physical space so that the scales is not sensitive to spacings and directions of voxel sampling.

◆ TransformPointToContinuousIndex()

template<typename TMetric >
template<typename TContinuousIndexType >
void itk::RegistrationParameterScalesEstimator< TMetric >::TransformPointToContinuousIndex ( const VirtualPointType &  point,
TContinuousIndexType &  mappedIndex 
)
protected

Transform a point to its continuous index.

◆ UpdateTransformParameters()

template<typename TMetric >
void itk::RegistrationParameterScalesEstimator< TMetric >::UpdateTransformParameters ( const ParametersType &  deltaParameters)
protected

Update the transform with a change in parameters.

Member Data Documentation

◆ FixedDimension

template<typename TMetric >
constexpr SizeValueType itk::RegistrationParameterScalesEstimator< TMetric >::FixedDimension = TMetric::FixedDimension
staticconstexpr

dimension accessors

Definition at line 116 of file itkRegistrationParameterScalesEstimator.h.

◆ m_CentralRegionRadius

template<typename TMetric >
IndexValueType itk::RegistrationParameterScalesEstimator< TMetric >::m_CentralRegionRadius {}
protected

the radius of the central region for sampling

Definition at line 355 of file itkRegistrationParameterScalesEstimator.h.

◆ m_Metric

template<typename TMetric >
MetricPointer itk::RegistrationParameterScalesEstimator< TMetric >::m_Metric {}
protected

the metric object

Definition at line 343 of file itkRegistrationParameterScalesEstimator.h.

◆ m_NumberOfRandomSamples

template<typename TMetric >
SizeValueType itk::RegistrationParameterScalesEstimator< TMetric >::m_NumberOfRandomSamples {}
protected

the number of samples in the virtual domain

Definition at line 352 of file itkRegistrationParameterScalesEstimator.h.

◆ m_SamplePoints

template<typename TMetric >
SamplePointContainerType itk::RegistrationParameterScalesEstimator< TMetric >::m_SamplePoints {}
protected

the samples in the virtual domain

Definition at line 346 of file itkRegistrationParameterScalesEstimator.h.

◆ m_SamplingStrategy

template<typename TMetric >
SamplingStrategyType itk::RegistrationParameterScalesEstimator< TMetric >::m_SamplingStrategy {}
private

Definition at line 370 of file itkRegistrationParameterScalesEstimator.h.

◆ m_SamplingTime

template<typename TMetric >
TimeStamp itk::RegistrationParameterScalesEstimator< TMetric >::m_SamplingTime {}
mutableprotected

Keep track of the last sampling time.

Definition at line 349 of file itkRegistrationParameterScalesEstimator.h.

◆ m_TransformForward

template<typename TMetric >
bool itk::RegistrationParameterScalesEstimator< TMetric >::m_TransformForward {}
private

m_TransformForward specifies which transform scales to be estimated. m_TransformForward = true (default) for the moving transform parameters. m_TransformForward = false for the fixed transform parameters.

Definition at line 367 of file itkRegistrationParameterScalesEstimator.h.

◆ m_VirtualDomainPointSet

template<typename TMetric >
VirtualPointSetType::ConstPointer itk::RegistrationParameterScalesEstimator< TMetric >::m_VirtualDomainPointSet {}
protected

Definition at line 357 of file itkRegistrationParameterScalesEstimator.h.

◆ MovingDimension

template<typename TMetric >
constexpr SizeValueType itk::RegistrationParameterScalesEstimator< TMetric >::MovingDimension = TMetric::MovingDimension
staticconstexpr

Definition at line 117 of file itkRegistrationParameterScalesEstimator.h.

◆ SizeOfSmallDomain

template<typename TMetric >
constexpr SizeValueType itk::RegistrationParameterScalesEstimator< TMetric >::SizeOfSmallDomain = 1000
staticconstexprprotected

Definition at line 360 of file itkRegistrationParameterScalesEstimator.h.

◆ VirtualDimension

template<typename TMetric >
constexpr SizeValueType itk::RegistrationParameterScalesEstimator< TMetric >::VirtualDimension = TMetric::VirtualDimension
staticconstexpr

Definition at line 118 of file itkRegistrationParameterScalesEstimator.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3