go home Home | Main Page | Topics | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::ComputeJacobianTerms< TFixedImage, TTransform > Class Template Reference

#include <itkComputeJacobianTerms.h>

Detailed Description

template<typename TFixedImage, typename TTransform>
class itk::ComputeJacobianTerms< 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 paper.

Definition at line 37 of file itkComputeJacobianTerms.h.

Inheritance diagram for itk::ComputeJacobianTerms< TFixedImage, TTransform >:

Classes

struct  Terms

Public Types

using ConstPointer = SmartPointer<const Self>
using FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer
using FixedImageMaskPointer = typename FixedImageMaskType::Pointer
using FixedImageMaskType = ImageMaskSpatialObject<Self::FixedImageDimension>
using FixedImageRegionType = typename TFixedImage::RegionType
using Pointer = SmartPointer<Self>
using ScalesType = ScaledSingleValuedNonLinearOptimizer::ScalesType
using Self = ComputeJacobianTerms
using Superclass = Object
using TransformPointer = typename TTransform::Pointer

Public Member Functions

Terms Compute () const
virtual const FixedImageMaskType * GetFixedImageMask ()
virtual const FixedImageRegionType & GetFixedImageRegion ()
 ITK_DISALLOW_COPY_AND_MOVE (ComputeJacobianTerms)
 itkOverrideGetNameOfClassMacro (ComputeJacobianTerms)
 itkStaticConstMacro (FixedImageDimension, unsigned int, TFixedImage::ImageDimension)
virtual void SetFixedImage (const TFixedImage *_arg)
virtual void SetFixedImageMask (const FixedImageMaskType *_arg)
virtual void SetFixedImageMask (FixedImageMaskType *_arg)
void SetFixedImageRegion (const FixedImageRegionType &region)
virtual void SetMaxBandCovSize (unsigned int _arg)
virtual void SetNumberOfBandStructureSamples (unsigned int _arg)
virtual void SetNumberOfJacobianMeasurements (SizeValueType _arg)
virtual void SetScales (ScalesType _arg)
virtual void SetTransform (TTransform *_arg)
virtual void SetUseScales (bool _arg)

Static Public Member Functions

static Pointer New ()

Protected Types

using ImageSampleType = ImageSample<TFixedImage>

Protected Member Functions

 ComputeJacobianTerms ()=default
std::vector< ImageSampleType > SampleFixedImageForJacobianTerms () const
 ~ComputeJacobianTerms () override=default

Private Attributes

TFixedImage::ConstPointer m_FixedImage { nullptr }
FixedImageMaskConstPointer m_FixedImageMask { nullptr }
FixedImageRegionType m_FixedImageRegion {}
unsigned int m_MaxBandCovSize { 0 }
unsigned int m_NumberOfBandStructureSamples { 0 }
SizeValueType m_NumberOfJacobianMeasurements { 0 }
ScalesType m_Scales {}
TransformPointer m_Transform { nullptr }
bool m_UseScales { false }

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::ConstPointer = SmartPointer<const Self>

Definition at line 46 of file itkComputeJacobianTerms.h.

◆ FixedImageMaskConstPointer

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer

Definition at line 64 of file itkComputeJacobianTerms.h.

◆ FixedImageMaskPointer

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::FixedImageMaskPointer = typename FixedImageMaskType::Pointer

Definition at line 63 of file itkComputeJacobianTerms.h.

◆ FixedImageMaskType

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::FixedImageMaskType = ImageMaskSpatialObject<Self::FixedImageDimension>

Definition at line 62 of file itkComputeJacobianTerms.h.

◆ FixedImageRegionType

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::FixedImageRegionType = typename TFixedImage::RegionType

Definition at line 56 of file itkComputeJacobianTerms.h.

◆ ImageSampleType

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::ImageSampleType = ImageSample<TFixedImage>
protected

Definition at line 114 of file itkComputeJacobianTerms.h.

◆ Pointer

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::Pointer = SmartPointer<Self>

Definition at line 45 of file itkComputeJacobianTerms.h.

◆ ScalesType

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::ScalesType = ScaledSingleValuedNonLinearOptimizer::ScalesType

Definition at line 66 of file itkComputeJacobianTerms.h.

◆ Self

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::Self = ComputeJacobianTerms

Standard ITK.

Definition at line 43 of file itkComputeJacobianTerms.h.

◆ Superclass

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::Superclass = Object

Definition at line 44 of file itkComputeJacobianTerms.h.

◆ TransformPointer

template<typename TFixedImage, typename TTransform>
using itk::ComputeJacobianTerms< TFixedImage, TTransform >::TransformPointer = typename TTransform::Pointer

typedef

Definition at line 55 of file itkComputeJacobianTerms.h.

Constructor & Destructor Documentation

◆ ComputeJacobianTerms()

template<typename TFixedImage, typename TTransform>
itk::ComputeJacobianTerms< TFixedImage, TTransform >::ComputeJacobianTerms ( )
protecteddefault

◆ ~ComputeJacobianTerms()

template<typename TFixedImage, typename TTransform>
itk::ComputeJacobianTerms< TFixedImage, TTransform >::~ComputeJacobianTerms ( )
overrideprotecteddefault

Member Function Documentation

◆ Compute()

template<typename TFixedImage, typename TTransform>
Terms itk::ComputeJacobianTerms< TFixedImage, TTransform >::Compute ( ) const

The main functions that performs the computation.

◆ GetFixedImageMask()

template<typename TFixedImage, typename TTransform>
virtual const FixedImageMaskType * itk::ComputeJacobianTerms< TFixedImage, TTransform >::GetFixedImageMask ( )
virtual

◆ GetFixedImageRegion()

template<typename TFixedImage, typename TTransform>
virtual const FixedImageRegionType & itk::ComputeJacobianTerms< TFixedImage, TTransform >::GetFixedImageRegion ( )
virtual

Get the region over which the metric will be computed.

◆ ITK_DISALLOW_COPY_AND_MOVE()

template<typename TFixedImage, typename TTransform>
itk::ComputeJacobianTerms< TFixedImage, TTransform >::ITK_DISALLOW_COPY_AND_MOVE ( ComputeJacobianTerms< TFixedImage, TTransform > )

◆ itkOverrideGetNameOfClassMacro()

template<typename TFixedImage, typename TTransform>
itk::ComputeJacobianTerms< TFixedImage, TTransform >::itkOverrideGetNameOfClassMacro ( ComputeJacobianTerms< TFixedImage, TTransform > )

Run-time type information (and related methods).

◆ itkStaticConstMacro()

template<typename TFixedImage, typename TTransform>
itk::ComputeJacobianTerms< 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.

◆ New()

template<typename TFixedImage, typename TTransform>
Pointer itk::ComputeJacobianTerms< TFixedImage, TTransform >::New ( )
static

Method for creation through the object factory.

◆ SampleFixedImageForJacobianTerms()

template<typename TFixedImage, typename TTransform>
std::vector< ImageSampleType > itk::ComputeJacobianTerms< TFixedImage, TTransform >::SampleFixedImageForJacobianTerms ( ) const
protected

Sample the fixed image to compute the Jacobian terms.

◆ SetFixedImage()

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetFixedImage ( const TFixedImage * _arg)
virtual

Set the fixed image.

◆ SetFixedImageMask() [1/2]

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetFixedImageMask ( const FixedImageMaskType * _arg)
virtual

◆ SetFixedImageMask() [2/2]

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetFixedImageMask ( FixedImageMaskType * _arg)
virtual

Set/Get the fixed image mask.

◆ SetFixedImageRegion()

template<typename TFixedImage, typename TTransform>
void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetFixedImageRegion ( const FixedImageRegionType & region)
inline

Set the region over which the metric will be computed.

Definition at line 88 of file itkComputeJacobianTerms.h.

◆ SetMaxBandCovSize()

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetMaxBandCovSize ( unsigned int _arg)
virtual

◆ SetNumberOfBandStructureSamples()

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetNumberOfBandStructureSamples ( unsigned int _arg)
virtual

◆ SetNumberOfJacobianMeasurements()

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetNumberOfJacobianMeasurements ( SizeValueType _arg)
virtual

◆ SetScales()

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetScales ( ScalesType _arg)
virtual

Set some parameters.

◆ SetTransform()

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetTransform ( TTransform * _arg)
virtual

Set the transform.

◆ SetUseScales()

template<typename TFixedImage, typename TTransform>
virtual void itk::ComputeJacobianTerms< TFixedImage, TTransform >::SetUseScales ( bool _arg)
virtual

Member Data Documentation

◆ m_FixedImage

template<typename TFixedImage, typename TTransform>
TFixedImage::ConstPointer itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_FixedImage { nullptr }
private

Definition at line 123 of file itkComputeJacobianTerms.h.

◆ m_FixedImageMask

template<typename TFixedImage, typename TTransform>
FixedImageMaskConstPointer itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_FixedImageMask { nullptr }
private

Definition at line 125 of file itkComputeJacobianTerms.h.

◆ m_FixedImageRegion

template<typename TFixedImage, typename TTransform>
FixedImageRegionType itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_FixedImageRegion {}
private

Definition at line 124 of file itkComputeJacobianTerms.h.

◆ m_MaxBandCovSize

template<typename TFixedImage, typename TTransform>
unsigned int itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_MaxBandCovSize { 0 }
private

Definition at line 130 of file itkComputeJacobianTerms.h.

◆ m_NumberOfBandStructureSamples

template<typename TFixedImage, typename TTransform>
unsigned int itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_NumberOfBandStructureSamples { 0 }
private

Definition at line 131 of file itkComputeJacobianTerms.h.

◆ m_NumberOfJacobianMeasurements

template<typename TFixedImage, typename TTransform>
SizeValueType itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_NumberOfJacobianMeasurements { 0 }
private

Definition at line 132 of file itkComputeJacobianTerms.h.

◆ m_Scales

template<typename TFixedImage, typename TTransform>
ScalesType itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_Scales {}
private

Definition at line 127 of file itkComputeJacobianTerms.h.

◆ m_Transform

template<typename TFixedImage, typename TTransform>
TransformPointer itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_Transform { nullptr }
private

Definition at line 126 of file itkComputeJacobianTerms.h.

◆ m_UseScales

template<typename TFixedImage, typename TTransform>
bool itk::ComputeJacobianTerms< TFixedImage, TTransform >::m_UseScales { false }
private

Definition at line 128 of file itkComputeJacobianTerms.h.


Generated on 1774142652 for elastix by doxygen 1.15.0 elastix logo