General image pair load that uses the itkImageToImageMetrics. More...

#include <itkFEMImageMetricLoad.h>

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

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

Public Types
typedef FEMPArray< Self >	ArrayType
typedef Self	Baseclass
typedef Float	ComputationType
typedef const Self *	ConstPointer
typedef double	CoordinateRepresentationType
typedef MeanSquaresMetricType	DefaultMetricType
typedef TranslationTransform < CoordinateRepresentationType, itkGetStaticConstMacro(ImageDimension) >	DefaultTransformType
typedef std::vector < Element::ConstPointer >	ElementPointersVectorType
typedef FixedType::ConstPointer	FixedConstPointer
typedef FixedNeighborhoodIteratorType::IndexType	FixedNeighborhoodIndexType
typedef NeighborhoodIterator < FixedType >	FixedNeighborhoodIteratorType
typedef FixedType *	FixedPointer
typedef FixedNeighborhoodIteratorType::RadiusType	FixedRadiusType
typedef TFixed	FixedType
typedef LoadElement::Float	Float
typedef GradientRecursiveGaussianImageFilter < ImageType, GradientImageType >	GradientImageFilterType
typedef SmartPointer < GradientImageType >	GradientImagePointer
typedef Image < GradientPixelType, itkGetStaticConstMacro(ImageDimension)>	GradientImageType
typedef CovariantVector < RealType, itkGetStaticConstMacro(ImageDimension)>	GradientPixelType
typedef Image< PixelType, itkGetStaticConstMacro(ImageDimension) >	ImageType
typedef LinearInterpolateImageFunction < MovingType, double >	InterpolatorType
typedef DefaultTransformType::JacobianType	JacobianType
typedef MeanSquaresImageToImageMetric < MovingType, FixedType >	MeanSquaresMetricType
typedef ImageToImageMetric < FixedType, MovingType >	MetricBaseType
typedef MetricBaseType::Pointer	MetricBaseTypePointer
typedef MovingType::ConstPointer	MovingConstPointer
typedef MovingNeighborhoodIteratorType::IndexType	MovingNeighborhoodIndexType
typedef NeighborhoodIterator < MovingType >	MovingNeighborhoodIteratorType
typedef MovingType *	MovingPointer
typedef MovingNeighborhoodIteratorType::RadiusType	MovingRadiusType
typedef TMoving	MovingType
typedef MutualInformationImageToImageMetric < MovingType, FixedType >	MutualInformationMetricType
typedef NormalizedCorrelationImageToImageMetric < MovingType, FixedType >	NormalizedCorrelationMetricType
typedef DefaultTransformType::ParametersType	ParametersType
typedef Float	PixelType
typedef Self *	Pointer
typedef float	RealType
typedef Image< RefPixelType, itkGetStaticConstMacro(ImageDimension) >	RefImageType
typedef MovingType::PixelType	RefPixelType
typedef ImageRegionIteratorWithIndex < MovingType >	RefRegionIteratorType
typedef ImageMetricLoad	Self
typedef LoadElement	Superclass
typedef Image< TarPixelType, itkGetStaticConstMacro(ImageDimension) >	TarImageType
typedef FixedType::PixelType	TarPixelType
typedef ImageRegionIteratorWithIndex < FixedType >	TarRegionIteratorType
typedef Transform < CoordinateRepresentationType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) >	TransformBaseType
typedef vnl_vector< Float >	VectorType

Public Member Functions
	ImageMetricLoad ()
virtual int	ClassID () const
virtual Baseclass::Pointer	Clone () const
Float	EvaluateMetricGivenSolution (Element::ArrayType *el, Float step=1.0)
VectorType	Fe (VectorType, VectorType)
VectorType	Fe1 (VectorType)
double	GetCurrentEnergy ()
FixedPointer	GetFixedImage ()
Float	GetMetric (VectorType InVec)
GradientImageType *	GetMetricGradientImage ()
MovingRadiusType	GetMetricRadius ()
MovingPointer	GetMovingImage ()
unsigned int	GetNumberOfIntegrationPoints ()
VectorType	GetPolynomialFitToMetric (VectorType PositionInElement, VectorType SolutionAtPosition)
Solution::ConstPointer	GetSolution ()
Float	GetSolution (unsigned int i, unsigned int which=0)
void	InitializeMetric (void)
VectorType	MetricFiniteDiff (VectorType PositionInElement, VectorType SolutionAtPosition)
void	PrintCurrentEnergy ()
virtual void	Read (std::istream &f, void *info)
void	SetCurrentEnergy (double e)
void	SetFixedImage (FixedType *T)
void	SetGamma (Float s)
void	SetMetric (MetricBaseTypePointer MP)
void	SetMetricFixedImage (FixedType *T)
void	SetMetricGradientImage (GradientImageType *g)
void	SetMetricMovingImage (MovingType *R)
void	SetMetricRadius (MovingRadiusType T)
void	SetMovingImage (MovingType *R)
void	SetNumberOfIntegrationPoints (unsigned int i)
void	SetSign (Float s)
void	SetSolution (Solution::ConstPointer ptr)
void	SetTemp (Float s)
void	Write (std::ostream &f) const

Static Public Member Functions
static FEMLightObject::Pointer	CreateFromStream (std::istream &f, void *info)
static Self::Pointer	New ()
static Baseclass *	NewImageMetricLoad (void)
static void	SkipWhiteSpace (std::istream &f)

Public Attributes
ElementPointersVectorType	el
int	GN

Static Public Attributes
static const int	CLID
static const unsigned int	ImageDimension = MovingType::ImageDimension
static const std::string	whitespaces = " \t\n\r"

Private Attributes
double	m_Energy
Float	m_Gamma
InterpolatorType::Pointer	m_Interpolator
MetricBaseTypePointer	m_Metric
GradientImageType *	m_MetricGradientImage
MovingRadiusType	m_MetricRadius
unsigned int	m_NumberOfIntegrationPoints
MovingPointer	m_RefImage
MovingType::SizeType	m_RefSize
Float	m_Sign
Solution::ConstPointer	m_Solution
unsigned int	m_SolutionIndex
unsigned int	m_SolutionIndex2
FixedPointer	m_TarImage
FixedType::SizeType	m_TarSize
Float	m_Temp
TransformBaseType::Pointer	m_Transform

Static Private Attributes
static const int	m_DummyCLID = ImageMetricLoad<TMoving,TFixed>::CLID()

Detailed Description

template<class TMoving, class TFixed>
class itk::fem::ImageMetricLoad< TMoving, TFixed >

General image pair load that uses the itkImageToImageMetrics.

LoadImageMetric computes FEM gravity loads by using derivatives provided by itkImageToImageMetrics (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).

Then, we evaluate the derivative at the point p+v(p) with respect to some region of the target (fixed) image by calling the metric with the translation parameters as provided by the vector field at 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 70 of file itkFEMImageMetricLoad.h.

Member Typedef Documentation

typedef FEMPArray<Self> itk::fem::Load::ArrayType

inherited

Array class that holds special pointers to the load objects

Definition at line 42 of file itkFEMLoadBase.h.

typedef Self itk::fem::FEMLightObject::Baseclass

inherited

Store the base class typedef for easy access from derived classes. FEM_CLASS macro also expects this for the FEMOF...

Definition at line 62 of file itkFEMLightObject.h.

template<class TMoving, class TFixed>

typedef Float itk::fem::ImageMetricLoad< TMoving, TFixed >::ComputationType

Definition at line 111 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef const Self* itk::fem::ImageMetricLoad< TMoving, TFixed >::ConstPointer

Const pointer or SmartPointer to an object.

Reimplemented from itk::fem::LoadElement.

Definition at line 72 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef double itk::fem::ImageMetricLoad< TMoving, TFixed >::CoordinateRepresentationType

Definition at line 122 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MeanSquaresMetricType itk::fem::ImageMetricLoad< TMoving, TFixed >::DefaultMetricType

Definition at line 136 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef TranslationTransform<CoordinateRepresentationType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::DefaultTransformType

Definition at line 124 of file itkFEMImageMetricLoad.h.

typedef std::vector<Element::ConstPointer> itk::fem::LoadElement::ElementPointersVectorType

inherited

Type of array of pointers to element objects

Definition at line 53 of file itkFEMLoadElementBase.h.

template<class TMoving, class TFixed>

typedef FixedType::ConstPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedConstPointer

Definition at line 83 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef FixedNeighborhoodIteratorType::IndexType itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedNeighborhoodIndexType

Definition at line 102 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef NeighborhoodIterator<FixedType> itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedNeighborhoodIteratorType

Definition at line 100 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef FixedType* itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedPointer

Definition at line 82 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef FixedNeighborhoodIteratorType::RadiusType itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedRadiusType

Definition at line 104 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef TFixed itk::fem::ImageMetricLoad< TMoving, TFixed >::FixedType

Definition at line 81 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef LoadElement::Float itk::fem::ImageMetricLoad< TMoving, TFixed >::Float

Float type used in Element and derived classes

Reimplemented from itk::fem::LoadElement.

Definition at line 76 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef GradientRecursiveGaussianImageFilter< ImageType, GradientImageType > itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientImageFilterType

Definition at line 155 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef SmartPointer<GradientImageType> itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientImagePointer

Definition at line 152 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef Image<GradientPixelType, itkGetStaticConstMacro(ImageDimension)> itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientImageType

Definition at line 151 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef CovariantVector<RealType, itkGetStaticConstMacro(ImageDimension)> itk::fem::ImageMetricLoad< TMoving, TFixed >::GradientPixelType

Definition at line 149 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef Image< PixelType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::ImageType

Definition at line 114 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef LinearInterpolateImageFunction< MovingType, double > itk::fem::ImageMetricLoad< TMoving, TFixed >::InterpolatorType

Definition at line 144 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef DefaultTransformType::JacobianType itk::fem::ImageMetricLoad< TMoving, TFixed >::JacobianType

Definition at line 138 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MeanSquaresImageToImageMetric< MovingType, FixedType > itk::fem::ImageMetricLoad< TMoving, TFixed >::MeanSquaresMetricType

Definition at line 132 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef ImageToImageMetric<FixedType,MovingType > itk::fem::ImageMetricLoad< TMoving, TFixed >::MetricBaseType

Type of supported metrics.

Definition at line 127 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MetricBaseType::Pointer itk::fem::ImageMetricLoad< TMoving, TFixed >::MetricBaseTypePointer

Definition at line 128 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MovingType::ConstPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingConstPointer

Definition at line 79 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MovingNeighborhoodIteratorType::IndexType itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingNeighborhoodIndexType

Definition at line 96 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef NeighborhoodIterator<MovingType> itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingNeighborhoodIteratorType

Definition at line 94 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MovingType* itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingPointer

Definition at line 80 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MovingNeighborhoodIteratorType::RadiusType itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingRadiusType

Definition at line 98 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef TMoving itk::fem::ImageMetricLoad< TMoving, TFixed >::MovingType

Definition at line 78 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MutualInformationImageToImageMetric< MovingType, FixedType > itk::fem::ImageMetricLoad< TMoving, TFixed >::MutualInformationMetricType

Definition at line 130 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef NormalizedCorrelationImageToImageMetric< MovingType, FixedType > itk::fem::ImageMetricLoad< TMoving, TFixed >::NormalizedCorrelationMetricType

Definition at line 134 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef DefaultTransformType::ParametersType itk::fem::ImageMetricLoad< TMoving, TFixed >::ParametersType

Definition at line 137 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef Float itk::fem::ImageMetricLoad< TMoving, TFixed >::PixelType

Definition at line 110 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef Self* itk::fem::ImageMetricLoad< TMoving, TFixed >::Pointer

Pointer or SmartPointer to an object.

Reimplemented from itk::fem::LoadElement.

Definition at line 72 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef float itk::fem::ImageMetricLoad< TMoving, TFixed >::RealType

Gradient filtering

Definition at line 147 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef Image< RefPixelType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::RefImageType

Definition at line 112 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef MovingType::PixelType itk::fem::ImageMetricLoad< TMoving, TFixed >::RefPixelType

Definition at line 108 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef ImageRegionIteratorWithIndex<MovingType> itk::fem::ImageMetricLoad< TMoving, TFixed >::RefRegionIteratorType

Definition at line 89 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef ImageMetricLoad itk::fem::ImageMetricLoad< TMoving, TFixed >::Self

Standard Self typedef.

Reimplemented from itk::fem::LoadElement.

Definition at line 72 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef LoadElement itk::fem::ImageMetricLoad< TMoving, TFixed >::Superclass

Standard Superclass typedef.

Reimplemented from itk::fem::LoadElement.

Definition at line 72 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef Image< TarPixelType, itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::TarImageType

Definition at line 113 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef FixedType::PixelType itk::fem::ImageMetricLoad< TMoving, TFixed >::TarPixelType

Definition at line 109 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef ImageRegionIteratorWithIndex<FixedType> itk::fem::ImageMetricLoad< TMoving, TFixed >::TarRegionIteratorType

Definition at line 90 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef Transform< CoordinateRepresentationType,itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) > itk::fem::ImageMetricLoad< TMoving, TFixed >::TransformBaseType

Definition at line 123 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

typedef vnl_vector<Float> itk::fem::ImageMetricLoad< TMoving, TFixed >::VectorType

Definition at line 115 of file itkFEMImageMetricLoad.h.

Constructor & Destructor Documentation

template<class TMoving , class TFixed >

itk::fem::ImageMetricLoad< TMoving, TFixed >::ImageMetricLoad ( )

Definition at line 92 of file itkFEMImageMetricLoad.txx.

References NULL.

Referenced by itk::fem::ImageMetricLoad< TMoving, TFixed >::NewImageMetricLoad().

Member Function Documentation

template<class TMoving, class TFixed>

virtual int itk::fem::ImageMetricLoad< TMoving, TFixed >::ClassID ( ) const

inlinevirtual

Virtual function to access the class ID

Reimplemented from itk::fem::LoadElement.

Definition at line 72 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

virtual Baseclass::Pointer itk::fem::ImageMetricLoad< TMoving, TFixed >::Clone ( ) const

virtual

Create a new object from the existing one

Reimplemented from itk::fem::LoadElement.

FEMLightObject::Pointer itk::fem::FEMLightObject::CreateFromStream	(	std::istream &	f,
		void *	info
	)

staticinherited

Read object of any derived type from stream.

This static function creates an object of a class, which is derived from FEMLightObject. The class of object is first determined from the stream, then the object of that class is constructed using the FEMObjectFactory. Finally the data for this object is read from the stream, by calling the Read() member function.

Read and create object of any derived class from stream

 Catch possible exceptions while 
 reading object's data from stream

 Return a pointer to a newly created object if all was OK
 Technically everithing should be fine here (a!=0), but we
 check again, just in case.

 Something went wrong.
 Reset the stream position to where it was before reading the object.

Definition at line 77 of file itkFEMLightObject.cxx.

References itk::fem::FEMObjectFactory< FEMLightObject >::ClassName2ID(), itk::fem::FEMObjectFactory< FEMLightObject >::Create(), itk::fem::FEMLightObject::Read(), itk::fem::FEMLightObject::SkipWhiteSpace(), and itk::fem::FEMLightObject::whitespaces.

Referenced by itk::fem::Solver::Read().

template<class TMoving , class TFixed >

ImageMetricLoad< TMoving, TFixed >::Float itk::fem::ImageMetricLoad< TMoving, TFixed >::EvaluateMetricGivenSolution	(	Element::ArrayType *	el,
		Float	step = `1.0`
	)

Definition at line 111 of file itkFEMImageMetricLoad.txx.

template<class TMoving , class TFixed >

ImageMetricLoad< TMoving, TFixed >::VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::Fe	(	VectorType	Gpos,
		VectorType	Gsol
	)

Definition at line 181 of file itkFEMImageMetricLoad.txx.

References itk::Size< VDimension >::SetSize().

template<class TMoving, class TFixed>

VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::Fe1 ( VectorType )

Compute the image based load - implemented with ITK metric derivatives.

template<class TMoving, class TFixed>

double itk::fem::ImageMetricLoad< TMoving, TFixed >::GetCurrentEnergy ( )

inline

Definition at line 267 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Energy.

template<class TMoving, class TFixed>

FixedPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::GetFixedImage ( void )

inline

Definition at line 192 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_TarImage.

template<class TMoving , class TFixed >

ImageMetricLoad< TMoving, TFixed >::Float itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMetric ( VectorType InVec )

This method returns the total metric evaluated over the image with respect to the current solution.

Definition at line 280 of file itkFEMImageMetricLoad.txx.

References itk::Size< VDimension >::SetSize().

template<class TMoving, class TFixed>

GradientImageType* itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMetricGradientImage ( )

inline

Definition at line 261 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_MetricGradientImage.

template<class TMoving, class TFixed>

MovingRadiusType itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMetricRadius ( )

inline

Get the metric region size.

Definition at line 197 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_MetricRadius.

template<class TMoving, class TFixed>

MovingPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::GetMovingImage ( void )

inline

Definition at line 190 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_RefImage.

template<class TMoving, class TFixed>

unsigned int itk::fem::ImageMetricLoad< TMoving, TFixed >::GetNumberOfIntegrationPoints ( )

inline

Definition at line 205 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_NumberOfIntegrationPoints.

template<class TMoving , class TFixed >

ImageMetricLoad< TMoving, TFixed >::VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::GetPolynomialFitToMetric	(	VectorType	PositionInElement,
		VectorType	SolutionAtPosition
	)

Definition at line 421 of file itkFEMImageMetricLoad.txx.

References itk::Index< VIndexDimension >::SetIndex().

template<class TMoving, class TFixed>

Solution::ConstPointer itk::fem::ImageMetricLoad< TMoving, TFixed >::GetSolution ( )

inlinevirtual

Reimplemented from itk::fem::Load.

Definition at line 224 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Solution.

template<class TMoving, class TFixed>

Float itk::fem::ImageMetricLoad< TMoving, TFixed >::GetSolution	(	unsigned int	i,
		unsigned int	which = `0`
	)

inline

Definition at line 236 of file itkFEMImageMetricLoad.h.

References itk::fem::Solution::GetSolutionValue(), and itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Solution.

template<class TMoving , class TFixed >

void itk::fem::ImageMetricLoad< TMoving, TFixed >::InitializeMetric ( void )

Definition at line 30 of file itkFEMImageMetricLoad.txx.

References itk::ExceptionObject::GetDescription().

template<class TMoving , class TFixed >

ImageMetricLoad< TMoving, TFixed >::VectorType itk::fem::ImageMetricLoad< TMoving, TFixed >::MetricFiniteDiff	(	VectorType	PositionInElement,
		VectorType	SolutionAtPosition
	)

Definition at line 345 of file itkFEMImageMetricLoad.txx.

References itk::Index< VIndexDimension >::SetIndex().

template<class TMoving, class TFixed>

static Self::Pointer itk::fem::ImageMetricLoad< TMoving, TFixed >::New ( void )

inlinestatic

Object creation in an itk compatible way

Reimplemented from itk::fem::LoadElement.

Definition at line 72 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

static Baseclass* itk::fem::ImageMetricLoad< TMoving, TFixed >::NewImageMetricLoad ( void )

inlinestatic

Definition at line 254 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::ImageMetricLoad().

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::PrintCurrentEnergy ( )

inline

Definition at line 265 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Energy.

void itk::fem::LoadElement::Read	(	std::istream &	f,
		void *	info
	)

virtualinherited

pointers to element objects on which the load acts

Read the LoadElement object from input stream

 Convert the info pointer to a usable objects


first call the parent's read function

 read and set pointers to element that we're applying the load to

first we read number of pointers in a list

if this is <= 0, the load applies on all elements in a system

   otherwise we read all the element numbers.
   there should be n of them

Reimplemented from itk::fem::FEMLightObject.

Reimplemented in itk::fem::LoadLandmark, itk::fem::LoadGravConst, itk::fem::LoadTest< TClass >, and itk::fem::LoadEdge.

Definition at line 31 of file itkFEMLoadElementBase.cxx.

References itk::fem::LoadElement::el, itk::fem::FEMPArray< T >::Find(), itk::fem::FEMExceptionObjectNotFound::m_baseClassName, itk::fem::FEMExceptionObjectNotFound::m_GN, itk::fem::FEMLightObject::Read(), and itk::fem::FEMLightObject::SkipWhiteSpace().

Referenced by itk::fem::LoadEdge::Read(), and itk::fem::LoadTest< TClass >::Read().

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetCurrentEnergy ( double e )

inline

Definition at line 269 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Energy.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetFixedImage ( FixedType * T )

inline

Define the target (fixed) image.

Definition at line 179 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_TarImage, and itk::fem::ImageMetricLoad< TMoving, TFixed >::m_TarSize.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetGamma ( Float s )

inline

Scaling of the similarity energy term

Definition at line 219 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Gamma.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetric ( MetricBaseTypePointer MP )

inline

Set/Get the Metric.

Definition at line 162 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Metric.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricFixedImage ( FixedType * T )

inline

Definition at line 184 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Metric, and itk::fem::ImageMetricLoad< TMoving, TFixed >::m_TarSize.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricGradientImage ( GradientImageType * g )

inline

Set/Get the metric gradient image

Definition at line 259 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_MetricGradientImage.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricMovingImage ( MovingType * R )

inline

Definition at line 172 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Metric, and itk::fem::ImageMetricLoad< TMoving, TFixed >::m_RefSize.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMetricRadius ( MovingRadiusType T )

inline

Define the metric region size.

Definition at line 195 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_MetricRadius.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetMovingImage ( MovingType * R )

inline

Define the reference (moving) image.

Definition at line 166 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_RefImage, and itk::fem::ImageMetricLoad< TMoving, TFixed >::m_RefSize.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetNumberOfIntegrationPoints ( unsigned int i )

inline

Set/Get methods for the number of integration points to use in each 1-dimensional line integral when evaluating the load. This value is passed to the load implementation.

Definition at line 203 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_NumberOfIntegrationPoints.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetSign ( Float s )

inline

Set the direction of the gradient (uphill or downhill). E.g. the mean squares metric should be minimized while NCC and PR should be maximized.

Definition at line 211 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Sign.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetSolution ( Solution::ConstPointer )

inlinevirtual

Sets the pointer to solution vector. This function is automatically called by the Solver class on every load object.

Some types of external Loads may need access to previous values of solution vector. If a derived class needs that, it should implement this function, and store the passed pointer accordingly. If the result vector is not required, the functionn should be left unimplemented, so that only the dummy implementation in base class is called.

Parameters:

ptr	Pointer to the object of Solution class.

Reimplemented from itk::fem::Load.

Definition at line 222 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Solution.

template<class TMoving, class TFixed>

void itk::fem::ImageMetricLoad< TMoving, TFixed >::SetTemp ( Float s )

inline

Set the sigma in a gaussian measure.

Definition at line 215 of file itkFEMImageMetricLoad.h.

References itk::fem::ImageMetricLoad< TMoving, TFixed >::m_Temp.

void itk::fem::FEMLightObject::SkipWhiteSpace ( std::istream & f )

staticinherited

Helper function that skips all the whitespace and comments in an input stream.

Definition at line 189 of file itkFEMLightObject.cxx.

Referenced by itk::fem::FEMLightObject::CreateFromStream(), itk::fem::MaterialLinearElasticity::Read(), itk::fem::LoadEdge::Read(), itk::fem::LoadNode::Read(), itk::fem::LoadElement::Read(), itk::fem::LoadBC::Read(), itk::fem::LoadGravConst::Read(), itk::fem::FEMLightObject::Read(), itk::fem::LoadBCMFC::Read(), itk::fem::LoadLandmark::Read(), itk::fem::Element::Node::Read(), and itk::fem::FEMRegistrationFilter< TMovingImage, TFixedImage >::ReadConfigFile().

void itk::fem::LoadElement::Write ( std::ostream & f ) const

virtualinherited

Write the LoadElement to the output stream

first call the parent's write function

Write the list of element global numbers

check for errors

Reimplemented from itk::fem::FEMLightObject.

Reimplemented in itk::fem::LoadLandmark, itk::fem::LoadGravConst, itk::fem::LoadTest< TClass >, and itk::fem::LoadEdge.

Definition at line 92 of file itkFEMLoadElementBase.cxx.

References itk::fem::LoadElement::el, and itk::fem::FEMLightObject::Write().

Referenced by itk::fem::LoadEdge::Write(), itk::fem::LoadTest< TClass >::Write(), and itk::fem::LoadLandmark::Write().

Member Data Documentation

template<class TMoving, class TFixed>

int itk::fem::ImageMetricLoad< TMoving, TFixed >::CLID

static

Class ID for FEM object factory

Reimplemented from itk::fem::LoadElement.

Definition at line 72 of file itkFEMImageMetricLoad.h.

ElementPointersVectorType itk::fem::LoadElement::el

inherited

Definition at line 54 of file itkFEMLoadElementBase.h.

Referenced by itk::fem::LoadLandmark::AssignToElement(), itk::fem::LoadElement::Read(), itk::fem::LoadLandmark::Read(), and itk::fem::LoadElement::Write().

int itk::fem::FEMLightObject::GN

inherited

Global number of an object (ID of an object) In general the ID's are required to be unique only within a specific type of derived classes (Elements, Nodes, ...) If the GN is not required, it can be ignored. (normally you need the GN when writing or reading objects to/from stream.

Definition at line 163 of file itkFEMLightObject.h.

Referenced by itk::fem::FEMLightObject::FEMLightObject(), itk::fem::Generate2DRectilinearMesh(), itk::fem::Generate3DRectilinearMesh(), itk::fem::FEMLightObject::Read(), itk::fem::LoadNode::Write(), itk::fem::LoadBC::Write(), and itk::fem::FEMLightObject::Write().

template<class TMoving, class TFixed>

const unsigned int itk::fem::ImageMetricLoad< TMoving, TFixed >::ImageDimension = MovingType::ImageDimension

static

Dimensionality of input and output data is assumed to be the same.

Definition at line 87 of file itkFEMImageMetricLoad.h.

template<class TMoving, class TFixed>

const int itk::fem::ImageMetricLoad< TMoving, TFixed >::m_DummyCLID = ImageMetricLoad<TMoving,TFixed>::CLID()

staticprivate

Dummy static int that enables automatic registration with FEMObjectFactory.

Definition at line 298 of file itkFEMImageMetricLoad.h.