itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkInvertDisplacementFieldImageFilter.h>

Inheritance diagram for itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef OutputFieldType::DirectionType	DirectionType
typedef InputFieldType	DisplacementFieldType
typedef OutputFieldType::IndexType	IndexType
typedef TInputImage	InputFieldType
typedef VectorInterpolateImageFunction < InputFieldType, RealType >	InterpolatorType
typedef OutputFieldType	InverseDisplacementFieldType
typedef OutputFieldType::PointType	OriginType
typedef TOutputImage	OutputFieldType
typedef OutputFieldType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef OutputFieldType::PointType	PointType
typedef Image< RealType, ImageDimension >	RealImageType
typedef VectorType::ComponentType	RealType
typedef OutputFieldType::RegionType	RegionType
typedef InvertDisplacementFieldImageFilter	Self
typedef OutputFieldType::SizeType	SizeType
typedef OutputFieldType::SpacingType	SpacingType
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
typedef OutputFieldType::PixelType	VectorType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const InputFieldType *	GetDisplacementField () const
virtual bool	GetEnforceBoundaryCondition ()
virtual InterpolatorType *	GetInterpolator ()
virtual RealType	GetMaxErrorNorm () const
virtual RealType	GetMaxErrorToleranceThreshold () const
virtual unsigned int	GetMaximumNumberOfIterations () const
virtual RealType	GetMeanErrorNorm () const
virtual RealType	GetMeanErrorToleranceThreshold () const
virtual void	SetEnforceBoundaryCondition (bool _arg)
virtual void	SetInterpolator (InterpolatorType *interpolator)
virtual void	SetMaxErrorToleranceThreshold (RealType _arg)
virtual void	SetMaximumNumberOfIterations (unsigned int _arg)
virtual void	SetMeanErrorToleranceThreshold (RealType _arg)
void	SetDisplacementField (const InputFieldType *field)
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Protected Member Functions
void	GenerateData ()
	InvertDisplacementFieldImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const RegionType &, ThreadIdType)
virtual	~InvertDisplacementFieldImageFilter ()
Private Member Functions
	InvertDisplacementFieldImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
DisplacementFieldType::Pointer	m_ComposedField
SpacingType	m_DisplacementFieldSpacing
bool	m_DoThreadedEstimateInverse
bool	m_EnforceBoundaryCondition
RealType	m_Epsilon
InterpolatorType::Pointer	m_Interpolator
RealType	m_MaxErrorNorm
RealType	m_MaxErrorToleranceThreshold
unsigned int	m_MaximumNumberOfIterations
RealType	m_MeanErrorNorm
RealType	m_MeanErrorToleranceThreshold
RealImageType::Pointer	m_ScaledNormImage

---

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >

Iteratively estimate the inverse field of a displacement field.

Author:

Nick Tustison

Brian Avants

Definition at line 39 of file itkInvertDisplacementFieldImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage = TInputImage>

typedef SmartPointer<const Self> itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 46 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::DirectionType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::DirectionType

Definition at line 70 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef InputFieldType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::DisplacementFieldType

Definition at line 57 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::IndexType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 64 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef TInputImage itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::InputFieldType

Definition at line 54 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef VectorInterpolateImageFunction<InputFieldType, RealType> itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::InterpolatorType

Definition at line 75 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::InverseDisplacementFieldType

Definition at line 58 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::PointType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::OriginType

Definition at line 68 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef TOutputImage itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::OutputFieldType

Definition at line 55 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::PixelType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::PixelType

Image typedef support.

Definition at line 61 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef SmartPointer<Self> itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 45 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::PointType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::PointType

Definition at line 66 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef Image<RealType, ImageDimension> itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::RealImageType

Definition at line 74 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef VectorType::ComponentType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::RealType

Other typedef

Definition at line 73 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::RegionType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 63 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef InvertDisplacementFieldImageFilter itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 43 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::SizeType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 69 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::SpacingType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SpacingType

Definition at line 67 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef ImageToImageFilter<TInputImage, TOutputImage> itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 44 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

typedef OutputFieldType::PixelType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::VectorType

Definition at line 62 of file itkInvertDisplacementFieldImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = TInputImage>

itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::InvertDisplacementFieldImageFilter

(

)

[protected]

Constructor

template<class TInputImage , class TOutputImage = TInputImage>

virtual itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::~InvertDisplacementFieldImageFilter

(

)

[protected, virtual]

Deconstructor

template<class TInputImage , class TOutputImage = TInputImage>

itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::InvertDisplacementFieldImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage = TInputImage>

virtual::itk::LightObject::Pointer itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

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<class TInputImage , class TOutputImage = TInputImage>

void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GenerateData

(

)

[protected, virtual]

preprocessing function

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage = TInputImage>

const InputFieldType* itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetDisplacementField

(

void

)

const [inline]

Get the deformation field.

Definition at line 99 of file itkInvertDisplacementFieldImageFilter.h.

References itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput().

template<class TInputImage , class TOutputImage = TInputImage>

virtual bool itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetEnforceBoundaryCondition

(

)

[virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual InterpolatorType* itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetInterpolator

(

)

[virtual]

Get the interpolator.

template<class TInputImage , class TOutputImage = TInputImage>

virtual RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMaxErrorNorm

(

)

const [virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMaxErrorToleranceThreshold

(

)

const [virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual unsigned int itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMaximumNumberOfIterations

(

)

const [virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMeanErrorNorm

(

)

const [virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMeanErrorToleranceThreshold

(

)

const [virtual]

template<class TInputImage , class TOutputImage = TInputImage>

static Pointer itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage = TInputImage>

void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::operator=

(

const Self &

)

[private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = TInputImage>

void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Standard print self function

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = TInputImage>

void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetDisplacementField

(

const InputFieldType *

field

)

[inline]

Set the deformation field

Definition at line 81 of file itkInvertDisplacementFieldImageFilter.h.

References itk::ImageToImageFilter< TInputImage, TOutputImage >::GetInput(), itk::SmartPointer< TObjectType >::IsNull(), itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_Interpolator, itk::Object::Modified(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::SetInput().

template<class TInputImage , class TOutputImage = TInputImage>

virtual void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetEnforceBoundaryCondition

(

bool

_arg

)

[virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetInterpolator

(

InterpolatorType *

interpolator

)

[virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetMaxErrorToleranceThreshold

(

RealType

_arg

)

[virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetMaximumNumberOfIterations

(

unsigned int

_arg

)

[virtual]

template<class TInputImage , class TOutputImage = TInputImage>

virtual void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetMeanErrorToleranceThreshold

(

RealType

_arg

)

[virtual]

template<class TInputImage , class TOutputImage = TInputImage>

void itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const RegionType &	,
		ThreadIdType
	)		[protected]

Multithreaded function which generates the output field.

---

Member Data Documentation

template<class TInputImage , class TOutputImage = TInputImage>

const unsigned int itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension [static]

Extract dimension from input image.

Definition at line 52 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

DisplacementFieldType::Pointer itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_ComposedField [private]

Definition at line 160 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

SpacingType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_DisplacementFieldSpacing [private]

Definition at line 166 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

bool itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_DoThreadedEstimateInverse [private]

Definition at line 167 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

bool itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_EnforceBoundaryCondition [private]

Definition at line 168 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_Epsilon [private]

Definition at line 165 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

InterpolatorType::Pointer itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_Interpolator [private]

The interpolator.

Definition at line 151 of file itkInvertDisplacementFieldImageFilter.h.

Referenced by itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetDisplacementField().

template<class TInputImage , class TOutputImage = TInputImage>

RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_MaxErrorNorm [private]

Definition at line 163 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_MaxErrorToleranceThreshold [private]

Definition at line 155 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

unsigned int itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_MaximumNumberOfIterations [private]

Definition at line 153 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_MeanErrorNorm [private]

Definition at line 164 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

RealType itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_MeanErrorToleranceThreshold [private]

Definition at line 156 of file itkInvertDisplacementFieldImageFilter.h.

template<class TInputImage , class TOutputImage = TInputImage>

RealImageType::Pointer itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::m_ScaledNormImage [private]

Definition at line 161 of file itkInvertDisplacementFieldImageFilter.h.

---

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

• itkInvertDisplacementFieldImageFilter.h