go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
itk::ComputeDisplacementDistribution< TFixedImage, TTransform > Class Template Reference

#include <itkComputeDisplacementDistribution.h>

Detailed Description

template<class TFixedImage, class TTransform>
class itk::ComputeDisplacementDistribution< TFixedImage, TTransform >

This is a helper class for the automatic parameter estimation of the ASGD optimizer.

More specifically this class computes the Jacobian terms related to the automatic parameter estimation for the adaptive stochastic gradient descent optimizer. Details can be found in the SPIE paper

[1] Y.Qiao, B.P.F. Lelieveldt, M.Staring "Fast automatic estimation of the optimization step size for nonrigid image registration," SPIE Medical Imaging: Image Processing,February, 2014. http://elastix.isi.uu.nl/marius/publications/2014_c_SPIEMI.php

Definition at line 44 of file itkComputeDisplacementDistribution.h.

Inheritance diagram for itk::ComputeDisplacementDistribution< TFixedImage, TTransform >:
Inheritance graph
[legend]

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DerivativeType DerivativeType
 
typedef FixedImageMaskType::ConstPointer FixedImageMaskConstPointer
 
typedef FixedImageMaskType::Pointer FixedImageMaskPointer
 
typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension) > FixedImageMaskType
 
typedef FixedImageType::RegionType FixedImageRegionType
 
typedef TFixedImage FixedImageType
 
typedef TransformType::NonZeroJacobianIndicesType NonZeroJacobianIndicesType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalesType ScalesType
 
typedef ComputeDisplacementDistribution Self
 
typedef ScaledSingleValuedNonLinearOptimizer Superclass
 
typedef TransformType::Pointer TransformPointer
 
typedef TTransform TransformType
 
- Public Types inherited from itk::ScaledSingleValuedNonLinearOptimizer
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::CostFunctionType CostFunctionType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef Superclass::MeasureType MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef ScaledCostFunctionType::Pointer ScaledCostFunctionPointer
 
typedef ScaledSingleValuedCostFunction ScaledCostFunctionType
 
typedef NonLinearOptimizer::ScalesType ScalesType
 
typedef ScaledSingleValuedNonLinearOptimizer Self
 
typedef SingleValuedNonLinearOptimizer Superclass
 

Public Member Functions

virtual void ComputeDistributionTerms (const ParametersType &mu, double &jacg, double &maxJJ, std::string method)
 
virtual const char * GetClassName () const
 
virtual const FixedImageMaskTypeGetFixedImageMask ()
 
virtual const FixedImageRegionTypeGetFixedImageRegion ()
 
 itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
 
virtual void SetFixedImage (const FixedImageType *_arg)
 
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
 
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
 
void SetFixedImageRegion (const FixedImageRegionType &region)
 
virtual void SetNumberOfJacobianMeasurements (SizeValueType _arg)
 
virtual void SetTransform (TransformType *_arg)
 
- Public Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
virtual const ParametersTypeGetCurrentPosition (void) const
 
virtual bool GetMaximize () const
 
virtual const ScaledCostFunctionTypeGetScaledCostFunction ()
 
virtual const ParametersTypeGetScaledCurrentPosition ()
 
bool GetUseScales (void) const
 
virtual void InitializeScales (void)
 
virtual void MaximizeOff ()
 
virtual void MaximizeOn ()
 
virtual void SetCostFunction (CostFunctionType *costFunction)
 
virtual void SetMaximize (bool _arg)
 
virtual void SetUseScales (bool arg)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
static Pointer New ()
 

Protected Types

typedef TransformType::ScalarType CoordinateRepresentationType
 
typedef FixedImageType::IndexType FixedImageIndexType
 
typedef FixedImageType::PointType FixedImagePointType
 
typedef ImageGridSamplerType::Pointer ImageGridSamplerPointer
 
typedef ImageGridSampler< FixedImageTypeImageGridSamplerType
 
typedef ImageRandomSamplerBaseType::Pointer ImageRandomSamplerBasePointer
 
typedef ImageRandomSamplerBase< FixedImageTypeImageRandomSamplerBaseType
 
typedef ImageSampleContainerType::Pointer ImageSampleContainerPointer
 
typedef ImageGridSamplerType::ImageSampleContainerType ImageSampleContainerType
 
typedef ImageSamplerBaseType::Pointer ImageSamplerBasePointer
 
typedef ImageSamplerBase< FixedImageTypeImageSamplerBaseType
 
typedef TransformType::JacobianType JacobianType
 
typedef JacobianType::ValueType JacobianValueType
 
typedef TransformType::NumberOfParametersType NumberOfParametersType
 
typedef JacobianType TransformJacobianType
 

Protected Member Functions

 ComputeDisplacementDistribution ()
 
virtual void SampleFixedImageForJacobianTerms (ImageSampleContainerPointer &sampleContainer)
 
virtual ~ComputeDisplacementDistribution ()
 
- Protected Member Functions inherited from itk::ScaledSingleValuedNonLinearOptimizer
virtual void GetScaledDerivative (const ParametersType &parameters, DerivativeType &derivative) const
 
virtual MeasureType GetScaledValue (const ParametersType &parameters) const
 
virtual void GetScaledValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 ScaledSingleValuedNonLinearOptimizer ()
 
virtual void SetCurrentPosition (const ParametersType &param)
 
virtual void SetScaledCurrentPosition (const ParametersType &parameters)
 
virtual ~ScaledSingleValuedNonLinearOptimizer ()
 

Protected Attributes

ScaledSingleValuedCostFunction::Pointer m_CostFunction
 
FixedImageType::ConstPointer m_FixedImage
 
FixedImageMaskConstPointer m_FixedImageMask
 
FixedImageRegionType m_FixedImageRegion
 
SizeValueType m_NumberOfJacobianMeasurements
 
TransformPointer m_Transform
 
- Protected Attributes inherited from itk::ScaledSingleValuedNonLinearOptimizer
ScaledCostFunctionPointer m_ScaledCostFunction
 
ParametersType m_ScaledCurrentPosition
 

Private Member Functions

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

Member Typedef Documentation

template<class TFixedImage , class TTransform >
typedef SmartPointer< const Self > itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ConstPointer

Definition at line 53 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef TransformType::ScalarType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::CoordinateRepresentationType
protected

Definition at line 143 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef Superclass::DerivativeType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::DerivativeType

Definition at line 68 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef FixedImageType::IndexType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::FixedImageIndexType
protected

Definition at line 124 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef FixedImageMaskType::ConstPointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::FixedImageMaskConstPointer

Definition at line 78 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef FixedImageMaskType::Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::FixedImageMaskPointer

Definition at line 77 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef SpatialObject< itkGetStaticConstMacro( FixedImageDimension ) > itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::FixedImageMaskType

Definition at line 76 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef FixedImageType::PointType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::FixedImagePointType
protected

Definition at line 125 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef FixedImageType::RegionType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::FixedImageRegionType

Definition at line 66 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef TFixedImage itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::FixedImageType

typedef

Definition at line 60 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageGridSamplerType::Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageGridSamplerPointer
protected

Definition at line 136 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageGridSampler< FixedImageType > itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageGridSamplerType
protected

Definition at line 135 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageRandomSamplerBaseType::Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageRandomSamplerBasePointer
protected

Definition at line 133 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageRandomSamplerBase< FixedImageType > itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageRandomSamplerBaseType
protected

Definition at line 132 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageSampleContainerType::Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageSampleContainerPointer
protected

Definition at line 139 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageGridSamplerType ::ImageSampleContainerType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageSampleContainerType
protected

Definition at line 138 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageSamplerBaseType::Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageSamplerBasePointer
protected

Definition at line 131 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ImageSamplerBase< FixedImageType > itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ImageSamplerBaseType
protected

Samplers.

Definition at line 130 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef TransformType::JacobianType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::JacobianType
protected

Definition at line 126 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef JacobianType::ValueType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::JacobianValueType
protected

Definition at line 127 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef TransformType::NonZeroJacobianIndicesType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::NonZeroJacobianIndicesType

Definition at line 79 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef TransformType::NumberOfParametersType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::NumberOfParametersType
protected

Definition at line 144 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef Superclass::ParametersType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ParametersType

Definition at line 67 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef SmartPointer< Self > itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::Pointer

Definition at line 52 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef Superclass::ScalesType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ScalesType

Definition at line 69 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ComputeDisplacementDistribution itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::Self

Standard ITK.

Definition at line 50 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef ScaledSingleValuedNonLinearOptimizer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::Superclass

Definition at line 51 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef JacobianType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::TransformJacobianType
protected

Typedefs for support of sparse Jacobians and AdvancedTransforms.

Definition at line 142 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef TransformType::Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::TransformPointer

Definition at line 65 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
typedef TTransform itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::TransformType

Definition at line 64 of file itkComputeDisplacementDistribution.h.

Constructor & Destructor Documentation

template<class TFixedImage , class TTransform >
itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ComputeDisplacementDistribution ( )
protected
template<class TFixedImage , class TTransform >
virtual itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::~ComputeDisplacementDistribution ( )
inlineprotectedvirtual

Definition at line 115 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ComputeDisplacementDistribution ( const Self )
private

Member Function Documentation

template<class TFixedImage , class TTransform >
virtual void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::ComputeDistributionTerms ( const ParametersType mu,
double jacg,
double maxJJ,
std::string  method 
)
virtual

The main functions that performs the computation.

template<class TFixedImage , class TTransform >
virtual const char* itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::GetClassName ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ScaledSingleValuedNonLinearOptimizer.

template<class TFixedImage , class TTransform >
virtual const FixedImageMaskType* itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::GetFixedImageMask ( )
virtual
template<class TFixedImage , class TTransform >
virtual const FixedImageRegionType& itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::GetFixedImageRegion ( )
virtual

Get the region over which the metric will be computed.

template<class TFixedImage , class TTransform >
itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned  int,
TFixedImage::ImageDimension   
)

Type for the mask of the fixed image. Only pixels that are "inside" this mask will be considered for the computation of the Jacobian terms.

template<class TFixedImage , class TTransform >
static Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::New ( )
static

Method for creation through the object factory.

template<class TFixedImage , class TTransform >
void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::operator= ( const Self )
private
template<class TFixedImage , class TTransform >
virtual void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::SampleFixedImageForJacobianTerms ( ImageSampleContainerPointer sampleContainer)
protectedvirtual

Sample the fixed image to compute the Jacobian terms.

template<class TFixedImage , class TTransform >
virtual void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::SetFixedImage ( const FixedImageType _arg)
virtual

Set the fixed image.

template<class TFixedImage , class TTransform >
virtual void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::SetFixedImageMask ( FixedImageMaskType _arg)
virtual

Set/Get the fixed image mask.

template<class TFixedImage , class TTransform >
virtual void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::SetFixedImageMask ( const FixedImageMaskType _arg)
virtual
template<class TFixedImage , class TTransform >
void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::SetFixedImageRegion ( const FixedImageRegionType region)
inline

Set the region over which the metric will be computed.

Definition at line 96 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
virtual void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::SetNumberOfJacobianMeasurements ( SizeValueType  _arg)
virtual

Set some parameters.

template<class TFixedImage , class TTransform >
virtual void itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::SetTransform ( TransformType _arg)
virtual

Set the transform.

Field Documentation

template<class TFixedImage , class TTransform >
ScaledSingleValuedCostFunction::Pointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::m_CostFunction
protected

Definition at line 121 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
FixedImageType::ConstPointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::m_FixedImage
protected

Definition at line 117 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
FixedImageMaskConstPointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::m_FixedImageMask
protected

Definition at line 119 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
FixedImageRegionType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::m_FixedImageRegion
protected

Definition at line 118 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
SizeValueType itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::m_NumberOfJacobianMeasurements
protected

Definition at line 122 of file itkComputeDisplacementDistribution.h.

template<class TFixedImage , class TTransform >
TransformPointer itk::ComputeDisplacementDistribution< TFixedImage, TTransform >::m_Transform
protected

Definition at line 120 of file itkComputeDisplacementDistribution.h.



Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo