vtkPlusPhantomLinearObjectRegistrationAlgo Class Reference

Landmark registration to determine the Phantom pose relative to the attached marker (PhantomReference). More...

#include <src/PlusCalibration/vtkPhantomLinearObjectRegistrationAlgo/vtkPlusPhantomLinearObjectRegistrationAlgo.h>

Inheritance diagram for vtkPlusPhantomLinearObjectRegistrationAlgo:

Collaboration diagram for vtkPlusPhantomLinearObjectRegistrationAlgo:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
std::string	GetDefinedPlaneName (int aIndex)
Planes *	GetDefinedPlanesFromXML ()
virtual char *	GetPhantomCoordinateFrame ()
virtual vtkMatrix4x4 *	GetPhantomToReferenceTransformMatrix ()
virtual vtkPoints *	GetRecordedPoints ()
virtual char *	GetReferenceCoordinateFrame ()
virtual double	GetRegistrationError ()
virtual char *	GetStylusTipCoordinateFrame ()
Planes *	GetUserRecordedPlanes ()
PlusStatus	Initialize ()
PlusStatus	InsertNextCalibrationPoint (vtkMatrix4x4 *aMarkerToReferenceTransformMatrix)
virtual int	IsA (const char *type)
PlusStatus	LinearObjectRegister (vtkIGSIOTransformRepository *aTransformRepository=NULL)
PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
virtual void	SetPhantomToReferenceTransformMatrix (vtkMatrix4x4 *)

Static Public Member Functions
static std::string	GetConfigurationElementName ()
static int	IsTypeOf (const char *type)
static vtkPlusPhantomLinearObjectRegistrationAlgo *	New ()
static vtkPlusPhantomLinearObjectRegistrationAlgo *	SafeDownCast (vtkObject *o)

Protected Member Functions
PlusStatus	ComputeError ()
void	SetDefinedPlanesFromXML (Planes *planes)
virtual void	SetMarkerToReferenceTransformMatrixArray (vtkDoubleArray *)
virtual void	SetPhantomCoordinateFrame (const char *)
void	SetRecordedPlanes (Planes *planes)
virtual void	SetRecordedPoints (vtkPoints *)
virtual void	SetReferenceCoordinateFrame (const char *)
virtual void	SetStylusTipCoordinateFrame (const char *)
	vtkPlusPhantomLinearObjectRegistrationAlgo ()
virtual	~vtkPlusPhantomLinearObjectRegistrationAlgo ()

Protected Attributes
std::vector< std::string >	DefinedPlaneNames
Planes	DefinedPlanes
std::vector< std::string >	DefinedReferenceNames
References	DefinedReferences
vtkDoubleArray *	MarkerToReferenceTransformMatrixArray
char *	PhantomCoordinateFrame
vtkMatrix4x4 *	PhantomToReferenceTransformMatrix
Planes	RecordedPlanes
vtkPoints *	RecordedPoints
References	RecordedReferences
char *	ReferenceCoordinateFrame
double	RegistrationError
char *	StylusTipCoordinateFrame

Static Protected Attributes
static std::string	ConfigurationElementName = "vtkPlusPhantomLinearObjectRegistrationAlgo"

Detailed Description

Landmark registration to determine the Phantom pose relative to the attached marker (PhantomReference).

Definition at line 32 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPlusPhantomLinearObjectRegistrationAlgo::Superclass

Definition at line 35 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

Constructor & Destructor Documentation

vtkPlusPhantomLinearObjectRegistrationAlgo()

vtkPlusPhantomLinearObjectRegistrationAlgo::vtkPlusPhantomLinearObjectRegistrationAlgo ( )

protected

Definition at line 29 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

~vtkPlusPhantomLinearObjectRegistrationAlgo()

vtkPlusPhantomLinearObjectRegistrationAlgo::~vtkPlusPhantomLinearObjectRegistrationAlgo ( )

protectedvirtual

Definition at line 50 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

Member Function Documentation

ComputeError()

PlusStatus vtkPlusPhantomLinearObjectRegistrationAlgo::ComputeError ( )

protected

Compute the registration error

Definition at line 331 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

GetClassName()

virtual const char* vtkPlusPhantomLinearObjectRegistrationAlgo::GetClassName ( )

virtual

GetConfigurationElementName()

static std::string vtkPlusPhantomLinearObjectRegistrationAlgo::GetConfigurationElementName ( )

inlinestatic

Get configuration element name

Definition at line 67 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

GetDefinedPlaneName()

std::string vtkPlusPhantomLinearObjectRegistrationAlgo::GetDefinedPlaneName ( int  aIndex )

inline

Gets defined landmark name

Parameters

aIndex

Index of the landmark

Returns

Name string

Definition at line 56 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

GetDefinedPlanesFromXML()

Planes* vtkPlusPhantomLinearObjectRegistrationAlgo::GetDefinedPlanesFromXML

(

)

GetPhantomCoordinateFrame()

virtual char* vtkPlusPhantomLinearObjectRegistrationAlgo::GetPhantomCoordinateFrame ( )

virtual

GetPhantomToReferenceTransformMatrix()

virtual vtkMatrix4x4* vtkPlusPhantomLinearObjectRegistrationAlgo::GetPhantomToReferenceTransformMatrix ( )

virtual

GetRecordedPoints()

virtual vtkPoints* vtkPlusPhantomLinearObjectRegistrationAlgo::GetRecordedPoints ( )

virtual

GetReferenceCoordinateFrame()

virtual char* vtkPlusPhantomLinearObjectRegistrationAlgo::GetReferenceCoordinateFrame ( )

virtual

GetRegistrationError()

virtual double vtkPlusPhantomLinearObjectRegistrationAlgo::GetRegistrationError ( )

virtual

GetStylusTipCoordinateFrame()

virtual char* vtkPlusPhantomLinearObjectRegistrationAlgo::GetStylusTipCoordinateFrame ( )

virtual

GetUserRecordedPlanes()

Planes* vtkPlusPhantomLinearObjectRegistrationAlgo::GetUserRecordedPlanes

(

)

Initialize()

PlusStatus vtkPlusPhantomLinearObjectRegistrationAlgo::Initialize

(

)

Definition at line 371 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

InsertNextCalibrationPoint()

PlusStatus vtkPlusPhantomLinearObjectRegistrationAlgo::InsertNextCalibrationPoint

(

vtkMatrix4x4 *

aMarkerToReferenceTransformMatrix

)

Definition at line 363 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

IsA()

virtual int vtkPlusPhantomLinearObjectRegistrationAlgo::IsA ( const char *  type )

virtual

IsTypeOf()

static int vtkPlusPhantomLinearObjectRegistrationAlgo::IsTypeOf ( const char *  type )

static

LinearObjectRegister()

PlusStatus vtkPlusPhantomLinearObjectRegistrationAlgo::LinearObjectRegister

(

vtkIGSIOTransformRepository *

aTransformRepository = NULL

)

Performs landmark registration to determine transformation from phantom reference to phantom

Parameters

aTransformRepository

Transform repository to save the results into

Definition at line 60 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

New()

static vtkPlusPhantomLinearObjectRegistrationAlgo* vtkPlusPhantomLinearObjectRegistrationAlgo::New ( )

static

ReadConfiguration()

PlusStatus vtkPlusPhantomLinearObjectRegistrationAlgo::ReadConfiguration

(

vtkXMLDataElement *

aConfig

)

Read phantom definition (landmarks)

Parameters

aConfig

Root XML data element containing the tool calibration

Definition at line 156 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

SafeDownCast()

static vtkPlusPhantomLinearObjectRegistrationAlgo* vtkPlusPhantomLinearObjectRegistrationAlgo::SafeDownCast ( vtkObject *  o )

static

SetDefinedPlanesFromXML()

void vtkPlusPhantomLinearObjectRegistrationAlgo::SetDefinedPlanesFromXML ( Planes *  planes )

protected

Definition at line 393 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

SetMarkerToReferenceTransformMatrixArray()

virtual void vtkPlusPhantomLinearObjectRegistrationAlgo::SetMarkerToReferenceTransformMatrixArray ( vtkDoubleArray *  )

protectedvirtual

SetPhantomCoordinateFrame()

virtual void vtkPlusPhantomLinearObjectRegistrationAlgo::SetPhantomCoordinateFrame ( const char *  )

protectedvirtual

SetPhantomToReferenceTransformMatrix()

virtual void vtkPlusPhantomLinearObjectRegistrationAlgo::SetPhantomToReferenceTransformMatrix ( vtkMatrix4x4 *  )

virtual

SetRecordedPlanes()

void vtkPlusPhantomLinearObjectRegistrationAlgo::SetRecordedPlanes ( Planes *  planes )

protected

Sets the planes that were recorded by a stylus

Definition at line 381 of file vtkPlusPhantomLinearObjectRegistrationAlgo.cxx.

SetRecordedPoints()

virtual void vtkPlusPhantomLinearObjectRegistrationAlgo::SetRecordedPoints ( vtkPoints *  )

protectedvirtual

Sets the points that were recorded by a stylus

SetReferenceCoordinateFrame()

virtual void vtkPlusPhantomLinearObjectRegistrationAlgo::SetReferenceCoordinateFrame ( const char *  )

protectedvirtual

SetStylusTipCoordinateFrame()

virtual void vtkPlusPhantomLinearObjectRegistrationAlgo::SetStylusTipCoordinateFrame ( const char *  )

protectedvirtual

Member Data Documentation

ConfigurationElementName

std::string vtkPlusPhantomLinearObjectRegistrationAlgo::ConfigurationElementName = "vtkPlusPhantomLinearObjectRegistrationAlgo"

staticprotected

Name of the phantom registration configuration element

Definition at line 144 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

DefinedPlaneNames

std::vector<std::string> vtkPlusPhantomLinearObjectRegistrationAlgo::DefinedPlaneNames

protected

Definition at line 108 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

DefinedPlanes

Planes vtkPlusPhantomLinearObjectRegistrationAlgo::DefinedPlanes

protected

Planes array holding the predefined planes from the configuration file

Definition at line 111 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

DefinedReferenceNames

std::vector<std::string> vtkPlusPhantomLinearObjectRegistrationAlgo::DefinedReferenceNames

protected

Definition at line 117 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

DefinedReferences

References vtkPlusPhantomLinearObjectRegistrationAlgo::DefinedReferences

protected

References array holding the predefined references from the configuration file

Definition at line 120 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

MarkerToReferenceTransformMatrixArray

vtkDoubleArray* vtkPlusPhantomLinearObjectRegistrationAlgo::MarkerToReferenceTransformMatrixArray

protected

Array of the input points

Definition at line 147 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

PhantomCoordinateFrame

char* vtkPlusPhantomLinearObjectRegistrationAlgo::PhantomCoordinateFrame

protected

Name of the phantom coordinate frame (eg. Phantom)

Definition at line 135 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

PhantomToReferenceTransformMatrix

vtkMatrix4x4* vtkPlusPhantomLinearObjectRegistrationAlgo::PhantomToReferenceTransformMatrix

protected

Phantom to reference transform matrix - the result of the registration

Definition at line 129 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

RecordedPlanes

Planes vtkPlusPhantomLinearObjectRegistrationAlgo::RecordedPlanes

protected

Plane array holding the recorded planes

Definition at line 114 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

RecordedPoints

vtkPoints* vtkPlusPhantomLinearObjectRegistrationAlgo::RecordedPoints

protected

Point array holding the recorded points

Definition at line 126 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

RecordedReferences

References vtkPlusPhantomLinearObjectRegistrationAlgo::RecordedReferences

protected

Reference array holding the recorded references

Definition at line 123 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

ReferenceCoordinateFrame

char* vtkPlusPhantomLinearObjectRegistrationAlgo::ReferenceCoordinateFrame

protected

Name of the reference coordinate frame (eg. Reference)

Definition at line 138 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

RegistrationError

double vtkPlusPhantomLinearObjectRegistrationAlgo::RegistrationError

protected

The mean error of the landmark registration in mm

Definition at line 132 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

StylusTipCoordinateFrame

char* vtkPlusPhantomLinearObjectRegistrationAlgo::StylusTipCoordinateFrame

protected

Name of the stylus tip coordinate frame (eg. StylusTip)

Definition at line 141 of file vtkPlusPhantomLinearObjectRegistrationAlgo.h.

---

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

• src/PlusCalibration/vtkPhantomLinearObjectRegistrationAlgo/vtkPlusPhantomLinearObjectRegistrationAlgo.h
• src/PlusCalibration/vtkPhantomLinearObjectRegistrationAlgo/vtkPlusPhantomLinearObjectRegistrationAlgo.cxx