ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::RegistrationParameterScalesFromShiftBase< TMetric > Class Template Referenceabstract

#include <itkRegistrationParameterScalesFromShiftBase.h>

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

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 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 >
 
using SamplingStrategyType = SamplingStrategyEnum
 
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

void EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales) override
 
void EstimateScales (ScalesType &scales) override
 
FloatType EstimateStepScale (const ParametersType &step) override
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
virtual void SetMetric (MetricType *_arg)
 
virtual void SetTransformForward (bool _arg)
 
virtual bool GetTransformForward () const
 
virtual void SetVirtualDomainPointSet (VirtualPointSetType *_arg)
 
virtual void SetVirtualDomainPointSet (const VirtualPointSetType *_arg)
 
virtual const VirtualPointSetTypeGetVirtualDomainPointSet () const
 
virtual void SetCentralRegionRadius (IndexValueType _arg)
 
FloatType EstimateMaximumStepSize () override
 
virtual void SetScalesSamplingStrategy ()
 
virtual void SetStepScaleSamplingStrategy ()
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
ParametersValueType m_SmallParameterVariation
 
virtual void SetSmallParameterVariation (ParametersValueType _arg)
 
virtual ParametersValueType GetSmallParameterVariation () const
 
 RegistrationParameterScalesFromShiftBase ()
 
 ~RegistrationParameterScalesFromShiftBase () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual FloatType ComputeMaximumVoxelShift (const ParametersType &deltaParameters)
 
virtual void ComputeSampleShifts (const ParametersType &deltaParameters, ScalesType &localShifts)=0
 

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 constexpr SizeValueType FixedDimension = TMetric::FixedDimension
 
static constexpr SizeValueType MovingDimension = TMetric::MovingDimension
 
static constexpr SizeValueType VirtualDimension = TMetric::VirtualDimension
 
- Protected Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
 RegistrationParameterScalesEstimator ()
 
 ~RegistrationParameterScalesEstimator () override=default
 
bool CheckAndSetInputs ()
 
virtual void SetNumberOfRandomSamples (SizeValueType _arg)
 
virtual void SetSamplingStrategy (SamplingStrategyType _arg)
 
bool CheckGeneralAffineTransform ()
 
template<typename TTransform >
bool CheckGeneralAffineTransformTemplated ()
 
template<typename TTargetPointType >
void TransformPoint (const VirtualPointType &point, TTargetPointType &mappedPoint)
 
template<typename TContinuousIndexType >
void TransformPointToContinuousIndex (const VirtualPointType &point, TContinuousIndexType &mappedIndex)
 
void ComputeSquaredJacobianNorms (const VirtualPointType &p, ParametersType &squareNorms)
 
bool TransformHasLocalSupportForScalesEstimation ()
 
bool IsDisplacementFieldTransform ()
 
bool IsBSplineTransform ()
 
SizeValueType GetNumberOfLocalParameters ()
 
void UpdateTransformParameters (const ParametersType &deltaParameters)
 
virtual void SampleVirtualDomain ()
 
void SampleVirtualDomainFully ()
 
void SampleVirtualDomainWithCorners ()
 
void SampleVirtualDomainRandomly ()
 
void SampleVirtualDomainWithCentralRegion ()
 
void SampleVirtualDomainWithRegion (VirtualRegionType region)
 
void SampleVirtualDomainWithPointSet ()
 
VirtualIndexType GetVirtualDomainCentralIndex ()
 
VirtualRegionType GetVirtualDomainCentralRegion ()
 
const TransformBaseTemplate< typename TMetric::MeasureType > * GetTransform ()
 
SizeValueType GetDimension ()
 
virtual SamplingStrategyType GetSamplingStrategy ()
 
- 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 ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
MetricPointer m_Metric
 
SamplePointContainerType m_SamplePoints
 
TimeStamp m_SamplingTime
 
SizeValueType m_NumberOfRandomSamples
 
IndexValueType m_CentralRegionRadius
 
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
 

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.

Member Typedef Documentation

◆ ConstPointer

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

◆ FixedTransformType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::FixedTransformType = typename Superclass::FixedTransformType

◆ FloatType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::FloatType = typename Superclass::FloatType

Type of float

Definition at line 67 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ JacobianType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::JacobianType = typename Superclass::JacobianType

◆ MovingTransformType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::MovingTransformType = typename Superclass::MovingTransformType

◆ ParametersType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::ParametersType = typename Superclass::ParametersType

Type of parameters of the optimizer

Definition at line 63 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ ParametersValueType

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

◆ Pointer

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

◆ ScalesType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::ScalesType = typename Superclass::ScalesType

Type of scales

Definition at line 60 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ Self

Standard class type aliases.

Definition at line 51 of file itkRegistrationParameterScalesFromShiftBase.h.

◆ Superclass

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

◆ VirtualImageConstPointer

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::VirtualImageConstPointer = typename Superclass::VirtualImageConstPointer

◆ VirtualIndexType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::VirtualIndexType = typename Superclass::VirtualIndexType

◆ VirtualPointType

template<typename TMetric >
using itk::RegistrationParameterScalesFromShiftBase< TMetric >::VirtualPointType = typename Superclass::VirtualPointType

Constructor & Destructor Documentation

◆ RegistrationParameterScalesFromShiftBase()

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

Set/get small parameter variation

◆ ~RegistrationParameterScalesFromShiftBase()

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

Set/get small parameter variation

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

◆ 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 scales)
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 >
virtual const char* itk::RegistrationParameterScalesFromShiftBase< TMetric >::GetNameOfClass ( ) const
virtual

◆ 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

Set/get small parameter variation

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

Set/get small parameter variation

Definition at line 112 of file itkRegistrationParameterScalesFromShiftBase.h.


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