ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | 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 >:

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 43 of file itkRegistrationParameterScalesFromShiftBase.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 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 void EstimateLocalStepScales (const ParametersType &step, ScalesType &localStepScales)
 
virtual void EstimateScales (ScalesType &scales)
 
virtual FloatType EstimateStepScale (const ParametersType &step)
 
virtual const char * GetNameOfClass () const
 
virtual void SetSmallParameterVariation (ParametersValueType _arg)
 
virtual ParametersValueType GetSmallParameterVariation () const
 
- Public Member Functions inherited from itk::RegistrationParameterScalesEstimator< TMetric >
virtual FloatType EstimateMaximumStepSize ()
 
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 LightObject::Pointer CreateAnother () const ITK_OVERRIDE
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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 ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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
 

Protected Member Functions

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

void operator= (const Self &)
 
 RegistrationParameterScalesFromShiftBase (const Self &)
 

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- 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 Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- 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
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 
- Static Protected Attributes inherited from itk::RegistrationParameterScalesEstimator< TMetric >
static const SizeValueType SizeOfSmallDomain = 1000
 

Member Typedef Documentation

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

Type of float

Definition at line 64 of file itkRegistrationParameterScalesFromShiftBase.h.

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

Type of parameters of the optimizer

Definition at line 60 of file itkRegistrationParameterScalesFromShiftBase.h.

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

Type of scales

Definition at line 54 of file itkRegistrationParameterScalesFromShiftBase.h.

Standard class typedefs.

Definition at line 48 of file itkRegistrationParameterScalesFromShiftBase.h.

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

Constructor & Destructor Documentation

template<typename TMetric >
itk::RegistrationParameterScalesFromShiftBase< TMetric >::RegistrationParameterScalesFromShiftBase ( )
protected
template<typename TMetric >
itk::RegistrationParameterScalesFromShiftBase< TMetric >::~RegistrationParameterScalesFromShiftBase ( )
inlineprotected
template<typename TMetric >
itk::RegistrationParameterScalesFromShiftBase< TMetric >::RegistrationParameterScalesFromShiftBase ( const Self )
private

Member Function Documentation

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.

template<typename TMetric >
virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::ComputeSampleShifts ( const ParametersType deltaParameters,
ScalesType localShifts 
)
protectedpure virtual
template<typename TMetric >
virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::EstimateLocalStepScales ( const ParametersType step,
ScalesType localStepScales 
)
virtual

Estimate the scales of local steps

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<typename TMetric >
virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::EstimateScales ( ScalesType scales)
virtual

Estimate parameter scales

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<typename TMetric >
virtual FloatType itk::RegistrationParameterScalesFromShiftBase< TMetric >::EstimateStepScale ( const ParametersType step)
virtual

Estimate the scale of a step

Implements itk::RegistrationParameterScalesEstimator< TMetric >.

template<typename TMetric >
virtual const char* itk::RegistrationParameterScalesFromShiftBase< TMetric >::GetNameOfClass ( ) const
virtual
template<typename TMetric >
virtual ParametersValueType itk::RegistrationParameterScalesFromShiftBase< TMetric >::GetSmallParameterVariation ( ) const
virtual

Set/get small parameter variation

template<typename TMetric >
void itk::RegistrationParameterScalesFromShiftBase< TMetric >::operator= ( const Self )
private
template<typename TMetric >
virtual void itk::RegistrationParameterScalesFromShiftBase< TMetric >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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

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

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

Set/get small parameter variation

Member Data Documentation

template<typename TMetric >
ParametersValueType itk::RegistrationParameterScalesFromShiftBase< TMetric >::m_SmallParameterVariation
private

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