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

#include <itkWarpHarmonicEnergyCalculator.h>

+ Inheritance diagram for itk::WarpHarmonicEnergyCalculator< TInputImage >:
+ Collaboration diagram for itk::WarpHarmonicEnergyCalculator< TInputImage >:

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: http://hdl.handle.net/1926/510

Definition at line 45 of file itkWarpHarmonicEnergyCalculator.h.

Public Types

typedef
ConstNeighborhoodIterator
< ImageType
ConstNeighborhoodIteratorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef TInputImage::ConstPointer ImageConstPointer
 
typedef TInputImage::Pointer ImagePointer
 
typedef TInputImage ImageType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
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 SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void Compute ()
 
virtual ::itk::LightObject::Pointer CreateAnother () 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 WeightsTypeGetDerivativeWeights () const
 
- 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
 
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
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 WarpHarmonicEnergyCalculator ()
 
virtual ~WarpHarmonicEnergyCalculator ()
 
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 &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 Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename 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<typename TInputImage >
typedef SmartPointer< const Self > itk::WarpHarmonicEnergyCalculator< TInputImage >::ConstPointer

Definition at line 52 of file itkWarpHarmonicEnergyCalculator.h.

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

Const Pointer type for the image.

Definition at line 67 of file itkWarpHarmonicEnergyCalculator.h.

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

Pointer type for the image.

Definition at line 64 of file itkWarpHarmonicEnergyCalculator.h.

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

Type definition for the input image.

Definition at line 58 of file itkWarpHarmonicEnergyCalculator.h.

template<typename 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<typename 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<typename TInputImage >
typedef SmartPointer< Self > itk::WarpHarmonicEnergyCalculator< TInputImage >::Pointer

Definition at line 51 of file itkWarpHarmonicEnergyCalculator.h.

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

Definition at line 89 of file itkWarpHarmonicEnergyCalculator.h.

template<typename 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<typename TInputImage >
typedef WarpHarmonicEnergyCalculator itk::WarpHarmonicEnergyCalculator< TInputImage >::Self

Standard class typedefs.

Definition at line 49 of file itkWarpHarmonicEnergyCalculator.h.

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

Definition at line 50 of file itkWarpHarmonicEnergyCalculator.h.

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

Definition at line 111 of file itkWarpHarmonicEnergyCalculator.h.

Constructor & Destructor Documentation

template<typename TInputImage >
itk::WarpHarmonicEnergyCalculator< TInputImage >::WarpHarmonicEnergyCalculator ( )
protected
template<typename TInputImage >
virtual itk::WarpHarmonicEnergyCalculator< TInputImage >::~WarpHarmonicEnergyCalculator ( )
inlineprotectedvirtual

Definition at line 135 of file itkWarpHarmonicEnergyCalculator.h.

template<typename TInputImage >
itk::WarpHarmonicEnergyCalculator< TInputImage >::WarpHarmonicEnergyCalculator ( const Self )
private

Member Function Documentation

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

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

template<typename TInputImage >
virtual::itk::LightObject::Pointer itk::WarpHarmonicEnergyCalculator< TInputImage >::CreateAnother ( ) 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<typename TInputImage >
double itk::WarpHarmonicEnergyCalculator< TInputImage >::EvaluateAtNeighborhood ( ConstNeighborhoodIteratorType it) const
protected
template<typename TInputImage >
virtual const WeightsType& itk::WarpHarmonicEnergyCalculator< TInputImage >::GetDerivativeWeights ( ) const
virtual

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

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

Return the smoothness value.

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

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

Get/Set the neighborhood radius used for gradient computation

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

Method for creation through the object factory.

template<typename TInputImage >
void itk::WarpHarmonicEnergyCalculator< TInputImage >::operator= ( const Self )
private
template<typename TInputImage >
virtual 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.

template<typename 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<typename TInputImage >
virtual void itk::WarpHarmonicEnergyCalculator< TInputImage >::SetImage ( const ImageType _arg)
virtual

Set the input image.

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

Get/Set the neighborhood radius used for gradient computation

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

Set the region over which the values will be computed

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

Referenced by itk::WarpHarmonicEnergyCalculator< TInputImage >::SetUseImageSpacingOff(), and itk::WarpHarmonicEnergyCalculator< TInputImage >::SetUseImageSpacingOn().

template<typename 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.

References itk::WarpHarmonicEnergyCalculator< TInputImage >::SetUseImageSpacing().

template<typename 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.

References itk::WarpHarmonicEnergyCalculator< TInputImage >::SetUseImageSpacing().

Member Data Documentation

template<typename TInputImage >
const unsigned int itk::WarpHarmonicEnergyCalculator< TInputImage >::ImageDimension = TInputImage::ImageDimension
static

The dimensionality of the input image.

Definition at line 80 of file itkWarpHarmonicEnergyCalculator.h.

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

The weights used to scale partial derivatives during processing

Definition at line 158 of file itkWarpHarmonicEnergyCalculator.h.

template<typename TInputImage >
double itk::WarpHarmonicEnergyCalculator< TInputImage >::m_HarmonicEnergy
private

Definition at line 149 of file itkWarpHarmonicEnergyCalculator.h.

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

Definition at line 150 of file itkWarpHarmonicEnergyCalculator.h.

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

Definition at line 160 of file itkWarpHarmonicEnergyCalculator.h.

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

Definition at line 152 of file itkWarpHarmonicEnergyCalculator.h.

template<typename TInputImage >
bool itk::WarpHarmonicEnergyCalculator< TInputImage >::m_RegionSetByUser
private

Definition at line 153 of file itkWarpHarmonicEnergyCalculator.h.

template<typename TInputImage >
bool itk::WarpHarmonicEnergyCalculator< TInputImage >::m_UseImageSpacing
private

Definition at line 155 of file itkWarpHarmonicEnergyCalculator.h.

template<typename TInputImage >
const unsigned int itk::WarpHarmonicEnergyCalculator< TInputImage >::VectorDimension = PixelType::Dimension
static

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: