itk::fem::LoadLandmark Class Reference

#include <itkFEMLoadLandmark.h>

Inheritance diagram for itk::fem::LoadLandmark:

[legend]Collaboration diagram for itk::fem::LoadLandmark:

[legend]List of all members.

---

Detailed Description

This load is derived from the motion of a specific landmark.

This load depends on the motion of a point from an undeformed configuration to a deformed configuration.

Definition at line 34 of file itkFEMLoadLandmark.h.

Public Types
typedef FEMPArray< Self >	ArrayType
typedef Self	Baseclass
typedef const Self *	ConstPointer
typedef std::vector< Element::ConstPointer >	ElementPointersVectorType
typedef Element::Float	Float
typedef Self *	Pointer
typedef LoadLandmark	Self
typedef LoadElement	Superclass
Public Member Functions
virtual void	AssignToElement (Element::ArrayType::Pointer elements)
virtual int	ClassID () const
virtual Baseclass::Pointer	Clone () const
Element::VectorType &	GetForce ()
const Element::VectorType &	GetPoint () const
Float	GetSolution (unsigned int i, unsigned int v=0)
Solution::ConstPointer	GetSolution ()
Element::VectorType &	GetSource ()
const Element::VectorType &	GetTarget () const
*Default constructors *	LoadLandmark ()
virtual void	Read (std::istream &f, void *info)
void	ScalePointAndForce (double *spacing, double fwt)
*Set the force vector *void	SetForce (const vnl_vector< Float > &force)
void	SetPoint (const vnl_vector< Float > &pt)
*Methods to access the most recent solution vector *void	SetSolution (Solution::ConstPointer ptr)
*Set the force vector *void	SetSource (const vnl_vector< Float > &source)
*Set the force vector *void	SetTarget (const vnl_vector< Float > &target)
virtual void	Write (std::ostream &f) const
Static Public Member Functions
static FEMLightObject::Pointer	CreateFromStream (std::istream &f, void *info)
static Self::Pointer	New ()
static void	SkipWhiteSpace (std::istream &f)
Public Attributes
double	eta
*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
int	GN
vnl_vector< Float >	m_force
vnl_vector< Float >	m_pt
Solution::ConstPointer	m_Solution
vnl_vector< Float >	m_source
vnl_vector< Float >	m_target
*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 and store the passed pointer accordingly If the result *vector is not	required
*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 and store the passed pointer accordingly If the result *vector is not the functionn should be left	unimplemented
Static Public Attributes
static const int	CLID
static const std::string	whitespaces

---

Member Typedef Documentation

typedef FEMPArray<Self> itk::fem::Load::ArrayType [inherited]

Array class that holds special pointers to the load objects Definition at line 45 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 67 of file itkFEMLightObject.h.

typedef const Self* itk::fem::LoadLandmark::ConstPointer

Const pointer or SmartPointer to an object. Reimplemented from itk::fem::LoadElement. Definition at line 35 of file itkFEMLoadLandmark.h.

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

Type of array of pointers to element objects Definition at line 57 of file itkFEMLoadElementBase.h.

typedef Element::Float itk::fem::LoadElement::Float [inherited]

Float type used in Element and derived classes Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, and itk::fem::FiniteDifferenceFunctionLoad< MovingImageType, FixedImageType >. Definition at line 52 of file itkFEMLoadElementBase.h.

typedef Self* itk::fem::LoadLandmark::Pointer

Pointer or SmartPointer to an object. Reimplemented from itk::fem::LoadElement. Definition at line 35 of file itkFEMLoadLandmark.h.

typedef LoadLandmark itk::fem::LoadLandmark::Self

Standard Self typedef. Reimplemented from itk::fem::LoadElement. Definition at line 35 of file itkFEMLoadLandmark.h.

typedef LoadElement itk::fem::LoadLandmark::Superclass

Standard Superclass typedef. Reimplemented from itk::fem::LoadElement. Definition at line 35 of file itkFEMLoadLandmark.h.

---

Constructor & Destructor Documentation

* Default constructors* itk::fem::LoadLandmark::LoadLandmark (   )  [inline]

Definition at line 180 of file itkFEMLoadLandmark.h.

---

Member Function Documentation

virtual void itk::fem::LoadLandmark::AssignToElement (  Element::ArrayType::Pointer  elements  )  [virtual]

Assign the LoadLandmark to an element

virtual int itk::fem::LoadLandmark::ClassID (   )  const [inline, virtual]

Virtual function to access the class ID Reimplemented from itk::fem::LoadElement. Definition at line 35 of file itkFEMLoadLandmark.h.

virtual Baseclass::Pointer itk::fem::LoadLandmark::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.

Element::VectorType& itk::fem::LoadLandmark::GetForce (  void   )  [inline]

Definition at line 95 of file itkFEMLoadLandmark.h. References m_force.

const Element::VectorType& itk::fem::LoadLandmark::GetPoint (   )  const [inline]

Access the location of the point load Definition at line 80 of file itkFEMLoadLandmark.h. References m_pt.

Float itk::fem::LoadLandmark::GetSolution (  unsigned int  i, unsigned int  v = 0 )  [inline]

Definition at line 74 of file itkFEMLoadLandmark.h. References itk::fem::Solution::GetSolutionValue(), and m_Solution.

Solution::ConstPointer itk::fem::LoadLandmark::GetSolution (   )  [inline, virtual]

Reimplemented from itk::fem::Load. Definition at line 73 of file itkFEMLoadLandmark.h. References m_Solution.

Element::VectorType& itk::fem::LoadLandmark::GetSource (   )  [inline]

Access the location of the point load Definition at line 90 of file itkFEMLoadLandmark.h. References m_source.

const Element::VectorType& itk::fem::LoadLandmark::GetTarget (   )  const [inline]

Access the location of the point load Definition at line 132 of file itkFEMLoadLandmark.h. References m_target.

static Self::Pointer itk::fem::LoadLandmark::New (  void   )  [inline, static]

Object creation in an itk compatible way Reimplemented from itk::fem::LoadElement. Definition at line 35 of file itkFEMLoadLandmark.h.

virtual void itk::fem::LoadLandmark::Read (  std::istream &  f, void *  info )  [virtual]

Read a LoadLandmark object from the input stream Reimplemented from itk::fem::LoadElement.

void itk::fem::LoadLandmark::ScalePointAndForce (  double *  spacing, double  fwt )  [inline]

Definition at line 152 of file itkFEMLoadLandmark.h. References eta, m_source, and m_target.

* Set the force vector* void itk::fem::LoadLandmark::SetForce (  const vnl_vector< Float > &  force  )  [inline]

Definition at line 103 of file itkFEMLoadLandmark.h. References m_force.

void itk::fem::LoadLandmark::SetPoint (  const vnl_vector< Float > &  pt  )  [inline]

Set the force vector Definition at line 85 of file itkFEMLoadLandmark.h. References m_pt.

* Methods to access the most recent solution vector* void itk::fem::LoadLandmark::SetSolution (  Solution::ConstPointer  ptr  )  [inline, virtual]

Reimplemented from itk::fem::Load. Definition at line 72 of file itkFEMLoadLandmark.h.

* Set the force vector* void itk::fem::LoadLandmark::SetSource (  const vnl_vector< Float > &  source  )  [inline]

Definition at line 118 of file itkFEMLoadLandmark.h. References m_source.

* Set the force vector* void itk::fem::LoadLandmark::SetTarget (  const vnl_vector< Float > &  target  )  [inline]

Definition at line 140 of file itkFEMLoadLandmark.h. References m_target.

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

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

virtual void itk::fem::LoadLandmark::Write (  std::ostream &  f  )  const [virtual]

Write a LoadLandmark object to the output stream Reimplemented from itk::fem::LoadElement.

---

Member Data Documentation

const int itk::fem::LoadLandmark::CLID [static]

Class ID for FEM object factory Reimplemented from itk::fem::LoadElement. Definition at line 35 of file itkFEMLoadLandmark.h.

double itk::fem::LoadLandmark::eta

Square root of the variance (eta) Definition at line 41 of file itkFEMLoadLandmark.h. Referenced by ScalePointAndForce().

* 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 itk::fem::Load::function [inherited]

Definition at line 52 of file itkFEMLoadBase.h.

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 168 of file itkFEMLightObject.h. Referenced by itk::fem::FEMLightObject::FEMLightObject().

vnl_vector<Float> itk::fem::LoadLandmark::m_force

Definition at line 55 of file itkFEMLoadLandmark.h. Referenced by GetForce(), and SetForce().

vnl_vector<Float> itk::fem::LoadLandmark::m_pt

Point in __local coordinates__ in the undeformed configuration Definition at line 46 of file itkFEMLoadLandmark.h. Referenced by GetPoint(), and SetPoint().

Solution::ConstPointer itk::fem::LoadLandmark::m_Solution

Pointer to the solution object Definition at line 67 of file itkFEMLoadLandmark.h. Referenced by GetSolution().

vnl_vector<Float> itk::fem::LoadLandmark::m_source

Definition at line 53 of file itkFEMLoadLandmark.h. Referenced by GetSource(), ScalePointAndForce(), and SetSource().

vnl_vector<Float> itk::fem::LoadLandmark::m_target

Point in __global coordinates__ in the deformed configuration Definition at line 51 of file itkFEMLoadLandmark.h. Referenced by GetTarget(), ScalePointAndForce(), and SetTarget().

* 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 and store the passed pointer accordingly If the result* vector is not itk::fem::Load::required [inherited]

Definition at line 52 of file itkFEMLoadBase.h.

* 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 and store the passed pointer accordingly If the result* vector is not the functionn should be left itk::fem::Load::unimplemented [inherited]

Definition at line 52 of file itkFEMLoadBase.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 138 of file itkFEMLightObject.h.

---

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

• itkFEMLoadLandmark.h

---