ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
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

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

Public Member Functions

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

virtual void ComputeSampleShifts (const ParametersType &deltaParameters, ScalesType &localShifts) override
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 RegistrationParameterScalesFromPhysicalShift ()
 
 ~RegistrationParameterScalesFromPhysicalShift () override
 
- Protected Member Functions inherited from itk::RegistrationParameterScalesFromShiftBase< TMetric >
virtual FloatType ComputeMaximumVoxelShift (const ParametersType &deltaParameters)
 
 RegistrationParameterScalesFromShiftBase ()
 
 ~RegistrationParameterScalesFromShiftBase () override
 
- 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
 
- Protected Member Functions inherited from itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >
 OptimizerParameterScalesEstimatorTemplate ()
 
 ~OptimizerParameterScalesEstimatorTemplate () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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 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
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 
- Static Protected Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
static ITK_CONSTEXPR_VAR
SizeValueType 
SizeOfSmallDomain = 1000
 

Member Typedef Documentation

template<typename TMetric >
typedef SmartPointer<const Self> itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::ConstPointer
template<typename TMetric >
typedef Superclass::FixedTransformType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::FixedTransformType
template<typename TMetric >
typedef Superclass::FloatType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::FloatType

Type of float

Definition at line 57 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >
typedef Superclass::JacobianType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::JacobianType
template<typename TMetric >
typedef Superclass::MovingTransformType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::MovingTransformType
template<typename TMetric >
typedef Superclass::ParametersType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::ParametersType

Type of parameters of the optimizer

Definition at line 54 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >
typedef SmartPointer<Self> itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::Pointer
template<typename TMetric >
typedef Superclass::ScalesType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::ScalesType

Type of scales

Definition at line 48 of file itkRegistrationParameterScalesFromPhysicalShift.h.

Standard class typedefs.

Definition at line 39 of file itkRegistrationParameterScalesFromPhysicalShift.h.

template<typename TMetric >
typedef Superclass::VirtualImageConstPointer itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::VirtualImageConstPointer
template<typename TMetric >
typedef Superclass::VirtualIndexType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::VirtualIndexType
template<typename TMetric >
typedef Superclass::VirtualPointType itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::VirtualPointType

Constructor & Destructor Documentation

template<typename TMetric >
itk::RegistrationParameterScalesFromPhysicalShift< TMetric >::~RegistrationParameterScalesFromPhysicalShift ( )
inlineoverrideprotected

Member Function Documentation

template<typename TMetric >
virtual 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 >
virtual 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::RegistrationParameterScalesFromShiftBase< TMetric >.


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