Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes

itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed > Class Template Reference

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

#include <itkFEMFiniteDifferenceFunctionLoad.h>

Inheritance diagram for itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >:
Inheritance graph
[legend]
Collaboration diagram for itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef FEMPArray< SelfArrayType
typedef Self Baseclass
typedef Float ComputationType
typedef const SelfConstPointer
typedef Image< VectorType,
itkGetStaticConstMacro(ImageDimension) > 
DeformationFieldType
typedef
DeformationFieldType::Pointer 
DeformationFieldTypePointer
typedef
DemonsRegistrationFunction
< FixedImageType,
MovingImageType,
DeformationFieldType
DemonsRegistrationFunctionType
typedef std::vector
< Element::ConstPointer
ElementPointersVectorType
typedef vnl_vector< FloatFEMVectorType
typedef NeighborhoodIterator
< DeformationFieldType
FieldIteratorType
typedef
PDEDeformableRegistrationFunction
< FixedImageType,
MovingImageType,
DeformationFieldType
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 FixedImageTypeFixedPointer
typedef
FixedNeighborhoodIteratorType::RadiusType 
FixedRadiusType
typedef
ImageRegionIteratorWithIndex
< FixedImageType
FixedRegionIteratorType
typedef LoadElement::Float Float
typedef Image< PixelType,
itkGetStaticConstMacro(ImageDimension) > 
ImageType
typedef
MeanSquareRegistrationFunction
< FixedImageType,
MovingImageType,
DeformationFieldType
MeanSquareRegistrationFunctionType
typedef MIRegistrationFunction
< FixedImageType,
MovingImageType,
DeformationFieldType
MIRegistrationFunctionType
typedef
MovingImageType::ConstPointer 
MovingConstPointer
typedef TMoving MovingImageType
typedef
MovingNeighborhoodIteratorType::IndexType 
MovingNeighborhoodIndexType
typedef NeighborhoodIterator
< MovingImageType
MovingNeighborhoodIteratorType
typedef MovingImageType::PixelType MovingPixelType
typedef MovingImageTypeMovingPointer
typedef
MovingNeighborhoodIteratorType::RadiusType 
MovingRadiusType
typedef
ImageRegionIteratorWithIndex
< MovingImageType
MovingRegionIteratorType
typedef
NCCRegistrationFunction
< FixedImageType,
MovingImageType,
DeformationFieldType
NCCRegistrationFunctionType
typedef Float PixelType
typedef SelfPointer
typedef
MovingNeighborhoodIteratorType::RadiusType 
RadiusType
typedef
FiniteDifferenceFunctionLoad 
Self
typedef LoadElement Superclass
typedef
FiniteDifferenceFunctionType::TimeStepType 
TimeStepType
typedef itk::Vector< float,
itkGetStaticConstMacro(ImageDimension)> 
VectorType

Public Member Functions

virtual int ClassID () const
virtual Baseclass::Pointer Clone () const
Float EvaluateMetricGivenSolution (Element::ArrayType *el, Float step=1.0)
 FiniteDifferenceFunctionLoad ()
double GetCurrentEnergy ()
FixedPointer GetFixedImage ()
MovingRadiusType GetMetricRadius ()
MovingPointer GetMovingImage ()
Solution::ConstPointer GetSolution ()
Float GetSolution (unsigned int i, unsigned int which=0)
void PrintCurrentEnergy ()
virtual void Read (std::istream &f, void *info)
void SetCurrentEnergy (double e=0.0)
void SetDeformationField (DeformationFieldTypePointer df)
void SetDifferenceFunction (FiniteDifferenceFunctionTypePointer drfp)
void SetGamma (Float s)
void SetMetric (FiniteDifferenceFunctionTypePointer drfp)
void SetMetricRadius (MovingRadiusType T)
void SetSign (Float s)
void SetSolution (Solution::ConstPointer ptr)
void SetTemp (Float s)
void Write (std::ostream &f) const

void SetMovingImage (MovingImageType *R)

void SetFixedImage (FixedImageType *T)

void SetNumberOfIntegrationPoints (unsigned int i)
unsigned int GetNumberOfIntegrationPoints ()

VectorType Fe1 (VectorType)
FEMVectorType Fe (FEMVectorType, FEMVectorType)

DeformationFieldTypePointer GetDeformationField ()
void InitializeIteration ()
void InitializeMetric ()

Static Public Member Functions

static FEMLightObject::Pointer CreateFromStream (std::istream &f, void *info)
static Self::Pointer New ()
static BaseclassNewFiniteDifferenceFunctionLoad (void)
static void SkipWhiteSpace (std::istream &f)

Public Attributes

int GN

Static Public Attributes

static const int CLID
static const unsigned int ImageDimension = MovingImageType::ImageDimension
static const std::string whitespaces

Detailed Description

template<class TMoving, class 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 64 of file itkFEMFiniteDifferenceFunctionLoad.h.


Member Typedef Documentation

Array class that holds special pointers to the load objects

Definition at line 42 of file itkFEMLoadBase.h.

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

Definition at line 64 of file itkFEMLightObject.h.

template<class TMoving , class TFixed >
typedef Float itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::ComputationType

Definition at line 107 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef const Self* itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::ConstPointer

Const pointer or SmartPointer to an object.

Reimplemented from itk::fem::LoadElement.

Definition at line 66 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef Image< VectorType, itkGetStaticConstMacro(ImageDimension) > itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::DeformationFieldType

Definition at line 114 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef DeformationFieldType::Pointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::DeformationFieldTypePointer

Definition at line 115 of file itkFEMFiniteDifferenceFunctionLoad.h.

Definition at line 135 of file itkFEMFiniteDifferenceFunctionLoad.h.

Type of array of pointers to element objects

Definition at line 54 of file itkFEMLoadElementBase.h.

template<class TMoving , class TFixed >
typedef vnl_vector<Float> itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FEMVectorType

Definition at line 112 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef NeighborhoodIterator<DeformationFieldType> itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FieldIteratorType

Definition at line 119 of file itkFEMFiniteDifferenceFunctionLoad.h.

PDEDeformableRegistrationFilterFunction type.

Definition at line 125 of file itkFEMFiniteDifferenceFunctionLoad.h.

Definition at line 126 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef FixedImageType::ConstPointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedConstPointer

Definition at line 77 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef TFixed itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedImageType

Definition at line 75 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef FixedNeighborhoodIteratorType::IndexType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedNeighborhoodIndexType

Definition at line 98 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef NeighborhoodIterator<FixedImageType> itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedNeighborhoodIteratorType

Definition at line 96 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef FixedImageType::PixelType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedPixelType

Definition at line 105 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef FixedImageType* itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedPointer

Definition at line 76 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef FixedNeighborhoodIteratorType::RadiusType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedRadiusType

Definition at line 100 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef ImageRegionIteratorWithIndex<FixedImageType> itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FixedRegionIteratorType

Definition at line 84 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef LoadElement::Float itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::Float

Float type used in Element and derived classes

Reimplemented from itk::fem::LoadElement.

Definition at line 70 of file itkFEMFiniteDifferenceFunctionLoad.h.

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

Definition at line 109 of file itkFEMFiniteDifferenceFunctionLoad.h.

Definition at line 132 of file itkFEMFiniteDifferenceFunctionLoad.h.

Definition at line 141 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef MovingImageType::ConstPointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingConstPointer

Definition at line 73 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef TMoving itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingImageType

Definition at line 72 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef MovingNeighborhoodIteratorType::IndexType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingNeighborhoodIndexType

Definition at line 90 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef NeighborhoodIterator<MovingImageType> itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingNeighborhoodIteratorType

Definition at line 88 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef MovingImageType::PixelType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingPixelType

Definition at line 104 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef MovingImageType* itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingPointer

Definition at line 74 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef MovingNeighborhoodIteratorType::RadiusType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingRadiusType

Definition at line 92 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef ImageRegionIteratorWithIndex<MovingImageType> itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::MovingRegionIteratorType

Definition at line 83 of file itkFEMFiniteDifferenceFunctionLoad.h.

Definition at line 138 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef Float itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::PixelType

Definition at line 106 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef Self* itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::Pointer

Pointer or SmartPointer to an object.

Reimplemented from itk::fem::LoadElement.

Definition at line 66 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef MovingNeighborhoodIteratorType::RadiusType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::RadiusType

Definition at line 94 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef FiniteDifferenceFunctionLoad itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::Self

Standard Self typedef.

Reimplemented from itk::fem::LoadElement.

Definition at line 66 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef LoadElement itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::Superclass

Standard Superclass typedef.

Reimplemented from itk::fem::LoadElement.

Definition at line 66 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef FiniteDifferenceFunctionType::TimeStepType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::TimeStepType

Definition at line 129 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
typedef itk::Vector<float,itkGetStaticConstMacro(ImageDimension)> itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::VectorType

Definition at line 111 of file itkFEMFiniteDifferenceFunctionLoad.h.


Constructor & Destructor Documentation

template<class TMoving , class TFixed >
itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::FiniteDifferenceFunctionLoad (  ) 

Member Function Documentation

template<class TMoving , class TFixed >
virtual int itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::ClassID (  )  const [inline, virtual]

Virtual function to access the class ID

Reimplemented from itk::fem::LoadElement.

Definition at line 66 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
virtual Baseclass::Pointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::Clone (  )  const [virtual]

Create a new object from the existing one

Reimplemented from itk::fem::LoadElement.

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

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.

template<class TMoving , class TFixed >
Float itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::EvaluateMetricGivenSolution ( Element::ArrayType el,
Float  step = 1.0 
)
template<class TMoving , class TFixed >
FEMVectorType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::Fe ( FEMVectorType  ,
FEMVectorType   
)

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

template<class TMoving , class TFixed >
VectorType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::Fe1 ( VectorType   ) 

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

template<class TMoving , class TFixed >
double itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetCurrentEnergy (  ) 
template<class TMoving , class TFixed >
DeformationFieldTypePointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetDeformationField (  )  [inline]

Get the

Definition at line 279 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
FixedPointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetFixedImage (  )  [inline]

Definition at line 193 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
MovingRadiusType itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetMetricRadius (  )  [inline]

Get the metric region size.

Definition at line 205 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
MovingPointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetMovingImage (  )  [inline]

Definition at line 188 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
unsigned int itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetNumberOfIntegrationPoints (  )  [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 218 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
Solution::ConstPointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetSolution (  )  [inline, virtual]

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 249 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
Float itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::GetSolution ( unsigned int  i,
unsigned int  which = 0 
) [inline]
template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::InitializeIteration (  ) 

Get the

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::InitializeMetric (  ) 

Get the

template<class TMoving , class TFixed >
static Self::Pointer itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::New ( void   )  [inline, static]

Object creation in an itk compatible way

Reimplemented from itk::fem::LoadElement.

Definition at line 66 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
static Baseclass* itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::NewFiniteDifferenceFunctionLoad ( void   )  [inline, static]

Definition at line 270 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::PrintCurrentEnergy (  ) 
virtual void itk::fem::LoadElement::Read ( std::istream &  f,
void *  info 
) [virtual, inherited]

pointers to element objects on which the load acts

Reimplemented from itk::fem::FEMLightObject.

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

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

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetCurrentEnergy ( double  e = 0.0  ) 
template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetDeformationField ( DeformationFieldTypePointer  df  )  [inline]

Set the

Definition at line 275 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetDifferenceFunction ( FiniteDifferenceFunctionTypePointer  drfp  )  [inline]

Definition at line 148 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetFixedImage ( FixedImageType T  )  [inline]

Define the target (fixed) image.

Definition at line 177 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetGamma ( Float  s  )  [inline]

Scaling of the similarity energy term

Definition at line 240 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetMetric ( FiniteDifferenceFunctionTypePointer  drfp  )  [inline]
template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetMetricRadius ( MovingRadiusType  T  )  [inline]

Define the metric region size.

Definition at line 199 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetMovingImage ( MovingImageType R  )  [inline]

Define the reference (moving) image.

Definition at line 167 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< 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 214 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< 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 227 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetSolution ( Solution::ConstPointer   )  [inline, virtual]

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 245 of file itkFEMFiniteDifferenceFunctionLoad.h.

template<class TMoving , class TFixed >
void itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::SetTemp ( Float  s  )  [inline]

Set the sigma in a gaussian measure.

Definition at line 233 of file itkFEMFiniteDifferenceFunctionLoad.h.

static void itk::fem::FEMLightObject::SkipWhiteSpace ( std::istream &  f  )  [static, inherited]

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

void itk::fem::LoadElement::Write ( std::ostream &  f  )  const [virtual, inherited]

Write an object to the output stream. Call this member to write the data members in the current object to the output stream. Here we also need to know which derived class we actually are, so that we can write the class name. The class name is obtained by calling the virtual ClassID() member function and passing the result to the FEMObjectFactory.

Implementations of Write member funtion in derived classes should first call the parent's implementation of Write and finaly write whatever they need.

Reimplemented from itk::fem::FEMLightObject.

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

Referenced by itk::fem::LoadTest< TClass >::Write().


Member Data Documentation

template<class TMoving , class TFixed >
const int itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::CLID [static]

Class ID for FEM object factory

Reimplemented from itk::fem::LoadElement.

Definition at line 66 of file itkFEMFiniteDifferenceFunctionLoad.h.

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 165 of file itkFEMLightObject.h.

Referenced by itk::fem::FEMLightObject::FEMLightObject().

template<class TMoving , class TFixed >
const unsigned int itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >::ImageDimension = MovingImageType::ImageDimension [static]

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

Definition at line 81 of file itkFEMFiniteDifferenceFunctionLoad.h.

const std::string itk::fem::FEMLightObject::whitespaces [static, inherited]

Const string of all whitespace characters. This string is used by SkipWhiteSpace function.

Definition at line 135 of file itkFEMLightObject.h.


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

Generated at Tue Jul 13 2010 03:50:04 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000