ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::WarpHarmonicEnergyCalculator< TInputImage > Class Template Reference

#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://www.insight-journal.org/browse/publication/154

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
 
 itkOverrideGetNameOfClassMacro (WarpHarmonicEnergyCalculator)
 
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 WeightsTypeGetDerivativeWeights () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
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 void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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 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 RadiusTypeGetNeighborhoodRadius () const
 
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 &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 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 {}
 

Member Typedef Documentation

◆ 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.

◆ ConstPointer

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkWarpHarmonicEnergyCalculator.h.

◆ ImageConstPointer

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::ImageConstPointer = typename TInputImage::ConstPointer

Const Pointer type for the image.

Definition at line 69 of file itkWarpHarmonicEnergyCalculator.h.

◆ ImagePointer

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::ImagePointer = typename TInputImage::Pointer

Pointer type for the image.

Definition at line 66 of file itkWarpHarmonicEnergyCalculator.h.

◆ ImageType

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::ImageType = TInputImage

Type definition for the input image.

Definition at line 63 of file itkWarpHarmonicEnergyCalculator.h.

◆ IndexType

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::IndexType = typename TInputImage::IndexType

Type definition for the input image index type.

Definition at line 75 of file itkWarpHarmonicEnergyCalculator.h.

◆ PixelType

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::PixelType = typename TInputImage::PixelType

Type definition for the input image pixel type.

Definition at line 72 of file itkWarpHarmonicEnergyCalculator.h.

◆ Pointer

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkWarpHarmonicEnergyCalculator.h.

◆ RadiusType

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::RadiusType = typename ConstNeighborhoodIteratorType::RadiusType

Definition at line 89 of file itkWarpHarmonicEnergyCalculator.h.

◆ RegionType

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::RegionType = typename TInputImage::RegionType

Type definition for the input image region type.

Definition at line 78 of file itkWarpHarmonicEnergyCalculator.h.

◆ Self

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::Self = WarpHarmonicEnergyCalculator

Standard class type aliases.

Definition at line 51 of file itkWarpHarmonicEnergyCalculator.h.

◆ Superclass

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::Superclass = Object

Definition at line 52 of file itkWarpHarmonicEnergyCalculator.h.

◆ WeightsType

template<typename TInputImage >
using itk::WarpHarmonicEnergyCalculator< TInputImage >::WeightsType = FixedArray<double, ImageDimension>

Definition at line 106 of file itkWarpHarmonicEnergyCalculator.h.

Constructor & Destructor Documentation

◆ WarpHarmonicEnergyCalculator()

template<typename TInputImage >
itk::WarpHarmonicEnergyCalculator< TInputImage >::WarpHarmonicEnergyCalculator ( )
protected

◆ ~WarpHarmonicEnergyCalculator()

template<typename TInputImage >
itk::WarpHarmonicEnergyCalculator< TInputImage >::~WarpHarmonicEnergyCalculator ( )
overrideprotecteddefault

Member Function Documentation

◆ Compute()

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

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

◆ EvaluateAtNeighborhood()

template<typename TInputImage >
double itk::WarpHarmonicEnergyCalculator< TInputImage >::EvaluateAtNeighborhood ( ConstNeighborhoodIteratorType it) const
protected

◆ GetDerivativeWeights()

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

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

◆ GetHarmonicEnergy()

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

Return the smoothness value.

◆ GetNeighborhoodRadius()

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

Get/Set the neighborhood radius used for gradient computation

◆ GetUseImageSpacing()

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

Set/Get whether or not the filter will use the spacing of the input image in its calculations. When set to "On", 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. Setting the value to "Off" resets the derivative weights to ignore image spacing. Use this option if you want to calculate the Jacobian determinant in the image space. Default value is "On".

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage >
itk::WarpHarmonicEnergyCalculator< TInputImage >::itkOverrideGetNameOfClassMacro ( WarpHarmonicEnergyCalculator< TInputImage >  )

Run-time type information (and related methods).

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage >
void itk::WarpHarmonicEnergyCalculator< TInputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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.

◆ SetDerivativeWeights()

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

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

◆ SetImage()

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

Set the input image.

◆ SetNeighborhoodRadius()

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

Get/Set the neighborhood radius used for gradient computation

◆ SetRegion()

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

Set the region over which the values will be computed

◆ SetUseImageSpacing()

template<typename 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. When set to "On", 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. Setting the value to "Off" resets the derivative weights to ignore image spacing. Use this option if you want to calculate the Jacobian determinant in the image space. Default value is "On".

◆ UseImageSpacingOn()

template<typename TInputImage >
virtual void itk::WarpHarmonicEnergyCalculator< TInputImage >::UseImageSpacingOn ( )
virtual

Set/Get whether or not the filter will use the spacing of the input image in its calculations. When set to "On", 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. Setting the value to "Off" resets the derivative weights to ignore image spacing. Use this option if you want to calculate the Jacobian determinant in the image space. Default value is "On".

Member Data Documentation

◆ ImageDimension

template<typename TInputImage >
constexpr unsigned int itk::WarpHarmonicEnergyCalculator< TInputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

The dimensionality of the input image.

Definition at line 81 of file itkWarpHarmonicEnergyCalculator.h.

◆ m_DerivativeWeights

template<typename TInputImage >
WeightsType itk::WarpHarmonicEnergyCalculator< TInputImage >::m_DerivativeWeights {}
private

Definition at line 152 of file itkWarpHarmonicEnergyCalculator.h.

◆ m_HarmonicEnergy

template<typename TInputImage >
double itk::WarpHarmonicEnergyCalculator< TInputImage >::m_HarmonicEnergy { 0.0 }
private

Definition at line 144 of file itkWarpHarmonicEnergyCalculator.h.

◆ m_Image

template<typename TInputImage >
ImageConstPointer itk::WarpHarmonicEnergyCalculator< TInputImage >::m_Image {}
private

Definition at line 145 of file itkWarpHarmonicEnergyCalculator.h.

◆ m_NeighborhoodRadius

template<typename TInputImage >
RadiusType itk::WarpHarmonicEnergyCalculator< TInputImage >::m_NeighborhoodRadius {}
private

Definition at line 154 of file itkWarpHarmonicEnergyCalculator.h.

◆ m_Region

template<typename TInputImage >
RegionType itk::WarpHarmonicEnergyCalculator< TInputImage >::m_Region {}
private

Definition at line 147 of file itkWarpHarmonicEnergyCalculator.h.

◆ m_RegionSetByUser

template<typename TInputImage >
bool itk::WarpHarmonicEnergyCalculator< TInputImage >::m_RegionSetByUser { false }
private

Definition at line 148 of file itkWarpHarmonicEnergyCalculator.h.

◆ m_UseImageSpacing

template<typename TInputImage >
bool itk::WarpHarmonicEnergyCalculator< TInputImage >::m_UseImageSpacing { true }
private

Definition at line 150 of file itkWarpHarmonicEnergyCalculator.h.

◆ VectorDimension

template<typename TInputImage >
constexpr unsigned int itk::WarpHarmonicEnergyCalculator< TInputImage >::VectorDimension = PixelType::Dimension
staticconstexpr

Length of the vector pixel type of the input image.

Definition at line 84 of file itkWarpHarmonicEnergyCalculator.h.


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