#include <itkWarpHarmonicEnergyCalculator.h>

Inheritance diagram for itk::WarpHarmonicEnergyCalculator< TInputImage >:

Collaboration diagram for itk::WarpHarmonicEnergyCalculator< TInputImage >:

Detailed Description

template<class TInputImage>
class itk::WarpHarmonicEnergyCalculator< TInputImage >

Compute the harmonic energy of a deformation field.

This class computes the harmonic energy of a deformation field which is a measure inversely related to the smoothness of the deformation field

Author: Tom Vercauteren, INRIA & Mauna Kea Technologies

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/510

Definition at line 45 of file itkWarpHarmonicEnergyCalculator.h.

Public Types
typedef ConstNeighborhoodIterator < ImageType >	ConstNeighborhoodIteratorType

typedef SmartPointer< const Self >	ConstPointer

typedef TInputImage::ConstPointer	ImageConstPointer

typedef TInputImage::Pointer	ImagePointer

typedef TInputImage	ImageType

typedef TInputImage::IndexType	IndexType

typedef TInputImage::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef ConstNeighborhoodIteratorType::RadiusType	RadiusType

typedef TInputImage::RegionType	RegionType

typedef WarpHarmonicEnergyCalculator	Self

typedef Object	Superclass

typedef FixedArray< double, ImageDimension >	WeightsType

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
void	Compute (void)

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual double	GetHarmonicEnergy () const

virtual const char *	GetNameOfClass () const

virtual bool	GetUseImageSpacing () const

virtual void	SetImage (const ImageType *_arg)

void	SetRegion (const RegionType &region)

void	SetUseImageSpacing (bool)

void	SetUseImageSpacingOff ()

void	SetUseImageSpacingOn ()


virtual void	SetDerivativeWeights (WeightsType _arg)

virtual const WeightsType &	GetDerivativeWeights ()

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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () 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 ()

Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension

static const unsigned int	VectorDimension = PixelType::Dimension

Protected Member Functions
double	EvaluateAtNeighborhood (ConstNeighborhoodIteratorType &it) const

void	PrintSelf (std::ostream &os, Indent indent) const

	WarpHarmonicEnergyCalculator ()

virtual	~WarpHarmonicEnergyCalculator ()


virtual const RadiusType &	GetNeighborhoodRadius ()

virtual void	SetNeighborhoodRadius (RadiusType _arg)

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 &)

	WarpHarmonicEnergyCalculator (const Self &)

Private Attributes
WeightsType	m_DerivativeWeights

double	m_HarmonicEnergy

ImageConstPointer	m_Image

RadiusType	m_NeighborhoodRadius

RegionType	m_Region

bool	m_RegionSetByUser

bool	m_UseImageSpacing

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<class TInputImage >

typedef ConstNeighborhoodIterator< ImageType > itk::WarpHarmonicEnergyCalculator< TInputImage >::ConstNeighborhoodIteratorType

Type of the iterator that will be used to move through the image. Also the type which will be passed to the evaluate function

Definition at line 88 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef SmartPointer< const Self > itk::WarpHarmonicEnergyCalculator< TInputImage >::ConstPointer

Definition at line 52 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef TInputImage::ConstPointer itk::WarpHarmonicEnergyCalculator< TInputImage >::ImageConstPointer

Const Pointer type for the image.

Definition at line 67 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef TInputImage::Pointer itk::WarpHarmonicEnergyCalculator< TInputImage >::ImagePointer

Pointer type for the image.

Definition at line 64 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef TInputImage itk::WarpHarmonicEnergyCalculator< TInputImage >::ImageType

Type definition for the input image.

Definition at line 58 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef TInputImage::IndexType itk::WarpHarmonicEnergyCalculator< TInputImage >::IndexType

Type definition for the input image index type.

Definition at line 73 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef TInputImage::PixelType itk::WarpHarmonicEnergyCalculator< TInputImage >::PixelType

Type definition for the input image pixel type.

Definition at line 70 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef SmartPointer< Self > itk::WarpHarmonicEnergyCalculator< TInputImage >::Pointer

Definition at line 51 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef ConstNeighborhoodIteratorType::RadiusType itk::WarpHarmonicEnergyCalculator< TInputImage >::RadiusType

Definition at line 89 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef TInputImage::RegionType itk::WarpHarmonicEnergyCalculator< TInputImage >::RegionType

Type definition for the input image region type.

Definition at line 76 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef WarpHarmonicEnergyCalculator itk::WarpHarmonicEnergyCalculator< TInputImage >::Self

Standard class typedefs.

Definition at line 49 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef Object itk::WarpHarmonicEnergyCalculator< TInputImage >::Superclass

Definition at line 50 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

typedef FixedArray< double, ImageDimension > itk::WarpHarmonicEnergyCalculator< TInputImage >::WeightsType

Definition at line 111 of file itkWarpHarmonicEnergyCalculator.h.

Constructor & Destructor Documentation

template<class TInputImage >

itk::WarpHarmonicEnergyCalculator< TInputImage >::WarpHarmonicEnergyCalculator ( )

protected

template<class TInputImage >

virtual itk::WarpHarmonicEnergyCalculator< TInputImage >::~WarpHarmonicEnergyCalculator ( )

inlineprotectedvirtual

Definition at line 135 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

itk::WarpHarmonicEnergyCalculator< TInputImage >::WarpHarmonicEnergyCalculator ( const Self & )

private

Member Function Documentation

template<class TInputImage >

void itk::WarpHarmonicEnergyCalculator< TInputImage >::Compute ( void )

Compute the minimum and maximum values of intensity of the input image.

template<class TInputImage >

virtual::itk::LightObject::Pointer itk::WarpHarmonicEnergyCalculator< TInputImage >::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 >

double itk::WarpHarmonicEnergyCalculator< TInputImage >::EvaluateAtNeighborhood ( ConstNeighborhoodIteratorType & it ) const

protected

template<class TInputImage >

virtual const WeightsType& itk::WarpHarmonicEnergyCalculator< TInputImage >::GetDerivativeWeights ( )

virtual

Directly Set/Get the array of weights used in the gradient calculations. Note that calling UseImageSpacingOn will clobber these values.

template<class TInputImage >

virtual double itk::WarpHarmonicEnergyCalculator< TInputImage >::GetHarmonicEnergy ( ) const

virtual

Return the smoothness value.

template<class TInputImage >

virtual const char* itk::WarpHarmonicEnergyCalculator< TInputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<class TInputImage >

virtual const RadiusType& itk::WarpHarmonicEnergyCalculator< TInputImage >::GetNeighborhoodRadius ( )

protectedvirtual

Get/Set the neighborhood radius used for gradient computation

template<class TInputImage >

virtual bool itk::WarpHarmonicEnergyCalculator< TInputImage >::GetUseImageSpacing ( ) const

virtual

template<class TInputImage >

static Pointer itk::WarpHarmonicEnergyCalculator< TInputImage >::New ( )

static

Method for creation through the object factory.

template<class TInputImage >

void itk::WarpHarmonicEnergyCalculator< TInputImage >::operator= ( const Self & )

private

template<class TInputImage >

void itk::WarpHarmonicEnergyCalculator< TInputImage >::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::Object.

template<class TInputImage >

virtual void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetDerivativeWeights ( WeightsType _arg )

virtual

Directly Set/Get the array of weights used in the gradient calculations. Note that calling UseImageSpacingOn will clobber these values.

template<class TInputImage >

virtual void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetImage ( const ImageType * _arg )

virtual

Set the input image.

template<class TInputImage >

virtual void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetNeighborhoodRadius ( RadiusType _arg )

protectedvirtual

Get/Set the neighborhood radius used for gradient computation

template<class TInputImage >

void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetRegion ( const RegionType & region )

Set the region over which the values will be computed

template<class TInputImage >

void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetUseImageSpacing ( bool )

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<class TInputImage >

void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetUseImageSpacingOff ( )

inline

Reset the derivative weights to ignore image spacing. Use this option if you want to calculate the Jacobian determinant in the image space. Default is ImageSpacingOn.

Definition at line 102 of file itkWarpHarmonicEnergyCalculator.h.

template<class TInputImage >

void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetUseImageSpacingOn ( )

inline

Set the derivative weights according to the spacing of the input image (1/spacing). Use this option if you want to calculate the Jacobian determinant in the space in which the data was acquired.

Definition at line 94 of file itkWarpHarmonicEnergyCalculator.h.