#include <itkWarpHarmonicEnergyCalculator.h>

Detailed Description

template<typename 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: https://doi.org/10.54294/ux2obj

Definition at line 45 of file itkWarpHarmonicEnergyCalculator.h.

Inheritance diagram for itk::WarpHarmonicEnergyCalculator< TInputImage >:

Collaboration diagram for itk::WarpHarmonicEnergyCalculator< TInputImage >:

Public Types
using	ConstNeighborhoodIteratorType = ConstNeighborhoodIterator< ImageType >

using	ConstPointer = SmartPointer< const Self >

using	ImageConstPointer = typename TInputImage::ConstPointer

using	ImagePointer = typename TInputImage::Pointer

using	ImageType = TInputImage

using	IndexType = typename TInputImage::IndexType

using	PixelType = typename TInputImage::PixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename ConstNeighborhoodIteratorType::RadiusType

using	RegionType = typename TInputImage::RegionType

using	Self = WarpHarmonicEnergyCalculator

using	Superclass = Object

using	WeightsType = FixedArray< double, ImageDimension >

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
void	Compute ()

virtual double	GetHarmonicEnergy () const

const char *	GetNameOfClass () const override

virtual void	SetImage (const ImageType *_arg)

void	SetRegion (const RegionType &region)


void	SetUseImageSpacing (bool)

virtual bool	GetUseImageSpacing () const

virtual void	UseImageSpacingOn ()


virtual void	SetDerivativeWeights (WeightsType _arg)

virtual const WeightsType &	GetDerivativeWeights () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

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

static constexpr unsigned int	VectorDimension = PixelType::Dimension

Protected Member Functions
double	EvaluateAtNeighborhood (ConstNeighborhoodIteratorType &it) const

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

	WarpHarmonicEnergyCalculator ()

	~WarpHarmonicEnergyCalculator () override=default


virtual const RadiusType &	GetNeighborhoodRadius () const

virtual void	SetNeighborhoodRadius (RadiusType _arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

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

virtual	~LightObject ()

Private Attributes
WeightsType	m_DerivativeWeights {}

double	m_HarmonicEnergy { 0.0 }

ImageConstPointer	m_Image {}

RadiusType	m_NeighborhoodRadius {}

RegionType	m_Region {}

bool	m_RegionSetByUser { false }

bool	m_UseImageSpacing { true }

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}