#include <itkFEMFiniteDifferenceFunctionLoad.h>

Inheritance diagram for itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >:

Collaboration diagram for itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >:

Detailed Description

template<typename TMoving, typename TFixed>
class itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >

General image pair load that uses the itkFiniteDifferenceFunctions.

This load computes FEM gravity loads by using derivatives provided by itkFiniteDifferenceFunctions (e.g. mean squares intensity difference.) The function responsible for this is called Fg, as required by the FEMLoad standards. It takes a vnl_vector as input. We assume the vector input is of size 2*ImageDimension. The 0 to ImageDimension-1 elements contain the position, p, in the reference (moving) image. The next ImageDimension to 2*ImageDimension-1 elements contain the value of the vector field at that point, v(p). The metrics return both a scalar similarity value and vector-valued derivative. The derivative is what gives us the force to drive the FEM registration. These values are computed with respect to some region in the Fixed image. This region size may be set by the user by calling SetMetricRadius. As the metric derivative computation evolves, performance should improve and more functionality will be available (such as scale selection).

Definition at line 67 of file itkFEMFiniteDifferenceFunctionLoad.h.

Public Types
typedef Float	ComputationType

typedef SmartPointer< const Self >	ConstPointer

typedef DemonsRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	DemonsRegistrationFunctionType

typedef Image< VectorType, itkGetStaticConstMacro(ImageDimension)>	DisplacementFieldType

typedef DisplacementFieldType::Pointer	DisplacementFieldTypePointer

typedef VectorContainer < ElementIdentifier, Element::Pointer >	ElementContainerType

typedef unsigned long	ElementIdentifier

typedef vnl_vector< Float >	FEMVectorType

typedef NeighborhoodIterator < DisplacementFieldType >	FieldIteratorType

typedef PDEDeformableRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	FiniteDifferenceFunctionType

typedef FiniteDifferenceFunctionType::Pointer	FiniteDifferenceFunctionTypePointer

typedef FixedImageType::ConstPointer	FixedConstPointer

typedef TFixed	FixedImageType

typedef FixedNeighborhoodIteratorType::IndexType	FixedNeighborhoodIndexType

typedef NeighborhoodIterator < FixedImageType >	FixedNeighborhoodIteratorType

typedef FixedImageType::PixelType	FixedPixelType

typedef FixedImageType *	FixedPointer

typedef FixedNeighborhoodIteratorType::RadiusType	FixedRadiusType

typedef ImageRegionIteratorWithIndex < FixedImageType >	FixedRegionIteratorType

typedef LoadElement::Float	Float

typedef Image< PixelType, itkGetStaticConstMacro(ImageDimension)>	ImageType

typedef MeanSquareRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	MeanSquareRegistrationFunctionType

typedef MIRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	MIRegistrationFunctionType

typedef MovingImageType::ConstPointer	MovingConstPointer

typedef TMoving	MovingImageType

typedef MovingNeighborhoodIteratorType::IndexType	MovingNeighborhoodIndexType

typedef NeighborhoodIterator < MovingImageType >	MovingNeighborhoodIteratorType

typedef MovingImageType::PixelType	MovingPixelType

typedef MovingImageType *	MovingPointer

typedef MovingNeighborhoodIteratorType::RadiusType	MovingRadiusType

typedef ImageRegionIteratorWithIndex < MovingImageType >	MovingRegionIteratorType

typedef NCCRegistrationFunction < FixedImageType, MovingImageType, DisplacementFieldType >	NCCRegistrationFunctionType

typedef Float	PixelType

typedef SmartPointer< Self >	Pointer

typedef MovingNeighborhoodIteratorType::RadiusType	RadiusType

typedef FiniteDifferenceFunctionLoad	Self

typedef LoadElement	Superclass

typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType

typedef itk::Vector< float, itkGetStaticConstMacro(ImageDimension)>	VectorType

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

typedef std::vector< const Element * >	ElementPointersVectorType

typedef Element::Float	Float

typedef SmartPointer< Self >	Pointer

typedef LoadElement	Self

typedef Load	Superclass

Public Types inherited from itk::fem::Load
typedef FEMPArray< Self >	ArrayType

typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Load	Self

typedef FEMLightObject	Superclass

Public Types inherited from itk::fem::FEMLightObject
typedef Self	Baseclass

typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef FEMLightObject	Self

typedef itk::LightObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	ApplyLoad (Element::ConstPointer element, Element::VectorType &Fe) override

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

Float	EvaluateMetricGivenSolution (ElementContainerType *el, Float step=1.0)

FEMVectorType	Fe (FEMVectorType)

double	GetCurrentEnergy ()

DisplacementFieldTypePointer	GetDisplacementField ()

FixedPointer	GetFixedImage ()

MovingRadiusType	GetMetricRadius ()

MovingPointer	GetMovingImage ()

virtual const char *	GetNameOfClass () const

unsigned int	GetNumberOfIntegrationPoints ()

virtual Solution::ConstPointer	GetSolution () override

Float	GetSolution (unsigned int i, unsigned int which=0)

void	InitializeIteration ()

void	InitializeMetric ()

void	PrintCurrentEnergy ()

void	SetCurrentEnergy (double e=0.0)

void	SetDescentDirectionMaximize ()

void	SetDescentDirectionMinimize ()

void	SetDifferenceFunction (FiniteDifferenceFunctionTypePointer drfp)

void	SetDisplacementField (DisplacementFieldTypePointer df)

void	SetGamma (Float s)

void	SetMetric (FiniteDifferenceFunctionTypePointer drfp)

void	SetMetricRadius (MovingRadiusType T)

void	SetNumberOfIntegrationPoints (unsigned int i)

virtual void	SetSolution (Solution::ConstPointer ptr) override


void	SetMovingImage (MovingImageType *R)


void	SetFixedImage (FixedImageType *T)

Public Member Functions inherited from itk::fem::LoadElement
void	AddNextElement (Element::ConstPointer e)

void	AddNextElement (Element::Pointer e)

Element::ConstPointer	GetElement (int i)

ElementPointersVectorType &	GetElementArray ()

const ElementPointersVectorType &	GetElementArray () const

unsigned int	GetNumberOfElements ()

	LoadElement ()

Public Member Functions inherited from itk::fem::Load
const Element *	GetElement () const

void	SetElement (const Element *el)

Public Member Functions inherited from itk::fem::FEMLightObject
int	GetGlobalNumber () const

void	SetGlobalNumber (int)

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

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::fem::LoadElement
static Pointer	New ()

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

static Pointer	New ()

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

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override

Protected Member Functions inherited from itk::fem::LoadElement
void	AddNextElementInternal (const Element *e)

Protected Member Functions inherited from itk::fem::FEMLightObject
	FEMLightObject ()

	FEMLightObject (const FEMLightObject &o)

virtual	~FEMLightObject () 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 Member Functions
	FiniteDifferenceFunctionLoad ()

Private Attributes
FiniteDifferenceFunctionTypePointer	m_DifferenceFunction

DisplacementFieldType::Pointer	m_DisplacementField

FixedPointer	m_FixedImage

FixedImageType::SizeType	m_FixedSize

Float	m_Gamma

float	m_GradSigma

MovingRadiusType	m_MetricRadius

MovingPointer	m_MovingImage

MovingImageType::SizeType	m_MovingSize

unsigned int	m_NumberOfIntegrationPoints

float	m_Sign

Solution::ConstPointer	m_Solution

unsigned int	m_SolutionIndex

unsigned int	m_SolutionIndex2

float	m_WhichMetric

Additional Inherited Members
Protected Attributes inherited from itk::fem::Load
Element::ConstPointer	m_Element

Protected Attributes inherited from itk::fem::FEMLightObject
int	m_GlobalNumber

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount