itk::fem::LoadLandmark Class Reference

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

#include <itkFEMLoadLandmark.h>

Inheritance diagram for itk::fem::LoadLandmark:

[legend]

Collaboration diagram for itk::fem::LoadLandmark:

[legend]

List of all members.

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
Element::VectorType &	GetSource ()
const Element::VectorType &	GetTarget () const
	LoadLandmark ()
virtual void	Read (std::istream &f, void *info)
void	ScalePointAndForce (double *spacing, double fwt)
void	SetPoint (const vnl_vector< Float > &pt)
virtual void	Write (std::ostream &f) const


Float	GetSolution (unsigned int i, unsigned int v=0)
Solution::ConstPointer	GetSolution ()
void	SetForce (const vnl_vector< Float > &force)
void	SetSolution (Solution::ConstPointer ptr)
void	SetSource (const vnl_vector< Float > &source)
void	SetTarget (const vnl_vector< Float > &target)
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
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
Static Public Attributes
static const int	CLID
static const std::string	whitespaces

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.

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 64 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 54 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 >, and itk::fem::ImageMetricLoad< TMoving, TFixed >.

Definition at line 49 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

itk::fem::LoadLandmark::LoadLandmark ( ) [inline]

Default constructors

Definition at line 185 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]`

Set the force vector

Definition at line 74 of file itkFEMLoadLandmark.h.

References itk::fem::Solution::GetSolutionValue(), and m_Solution.

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

Set the force vector

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 136 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 157 of file itkFEMLoadLandmark.h.

References eta, m_source, and m_target.

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

Set the force vector

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.

void itk::fem::LoadLandmark::SetSolution ( Solution::ConstPointer ptr ) [inline, virtual]

Methods to access the most recent solution vector

Reimplemented from itk::fem::Load.

Definition at line 72 of file itkFEMLoadLandmark.h.

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

Set the force vector

Definition at line 120 of file itkFEMLoadLandmark.h.

References m_source.

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

Set the force vector

Definition at line 144 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().

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 165 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 element which contains the undeformed configuration of the landmark Pointer to the solution object

Definition at line 67 of file itkFEMLoadLandmark.h.