PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
vtkPlusPhantomLandmarkRegistrationAlgo Class Reference

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

#include <src/PlusCalibration/vtkPhantomLandmarkRegistrationAlgo/vtkPlusPhantomLandmarkRegistrationAlgo.h>

Inheritance diagram for vtkPlusPhantomLandmarkRegistrationAlgo:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusPhantomLandmarkRegistrationAlgo:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
void GetDefinedLandmark_Reference (int index, double cameraPosition_Reference[4])
 
std::string GetDefinedLandmarkName (int aIndex)
 
virtual vtkPoints * GetDefinedLandmarks_Phantom ()
 
void GetDefinedLandmarksCentroid_Phantom (double landmarksCentroid_Phantom[4])
 
void GetDefinedLandmarksCentroid_Reference (double landmarksAverage_Reference[4])
 
void GetLandmarkCameraPosition_Reference (int index, double cameraPosition_Reference[4])
 
double GetMinimunDistanceBetweenTwoLandmarksMm ()
 
virtual char * GetPhantomCoordinateFrame ()
 
virtual vtkMatrix4x4 * GetPhantomToReferenceTransformMatrix ()
 
virtual vtkPoints * GetRecordedLandmarks_Reference ()
 
virtual char * GetReferenceCoordinateFrame ()
 
virtual double GetRegistrationErrorMm ()
 
virtual char * GetStylusTipCoordinateFrame ()
 
virtual int IsA (const char *type)
 
PlusStatus LandmarkRegister (vtkIGSIOTransformRepository *aTransformRepository=NULL)
 
void PrintRecordedLandmarks_Phantom ()
 
PlusStatus ReadConfiguration (vtkXMLDataElement *aConfig)
 
virtual void SetPhantomToReferenceTransformMatrix (vtkMatrix4x4 *)
 

Static Public Member Functions

static std::string GetConfigurationElementName ()
 
static int IsTypeOf (const char *type)
 
static vtkPlusPhantomLandmarkRegistrationAlgoNew ()
 
static vtkPlusPhantomLandmarkRegistrationAlgoSafeDownCast (vtkObject *o)
 

Protected Member Functions

PlusStatus ComputeError ()
 
virtual void SetDefinedLandmarks_Phantom (vtkPoints *)
 
virtual void SetPhantomCoordinateFrame (const char *)
 
virtual void SetRecordedLandmarks_Reference (vtkPoints *)
 
virtual void SetReferenceCoordinateFrame (const char *)
 
virtual void SetStylusTipCoordinateFrame (const char *)
 
 vtkPlusPhantomLandmarkRegistrationAlgo ()
 
virtual ~vtkPlusPhantomLandmarkRegistrationAlgo ()
 

Protected Attributes

std::vector< std::string > DefinedLandmarkNames
 
vtkPoints * DefinedLandmarks_Phantom
 
double minimumDistanceBetweenTwoLandmarksMm
 
char * PhantomCoordinateFrame
 
vtkMatrix4x4 * PhantomToReferenceTransformMatrix
 
vtkPoints * RecordedLandmarks_Reference
 
char * ReferenceCoordinateFrame
 
double RegistrationErrorMm
 
char * StylusTipCoordinateFrame
 

Static Protected Attributes

static std::string ConfigurationElementName = "vtkPlusPhantomLandmarkRegistrationAlgo"
 

Detailed Description

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

Definition at line 28 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

Member Typedef Documentation

◆ Superclass

Definition at line 31 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

Constructor & Destructor Documentation

◆ vtkPlusPhantomLandmarkRegistrationAlgo()

vtkPlusPhantomLandmarkRegistrationAlgo::vtkPlusPhantomLandmarkRegistrationAlgo ( )
protected

Definition at line 27 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ ~vtkPlusPhantomLandmarkRegistrationAlgo()

vtkPlusPhantomLandmarkRegistrationAlgo::~vtkPlusPhantomLandmarkRegistrationAlgo ( )
protectedvirtual

Definition at line 49 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

Member Function Documentation

◆ ComputeError()

PlusStatus vtkPlusPhantomLandmarkRegistrationAlgo::ComputeError ( )
protected

Compute the registration error

Definition at line 226 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ GetClassName()

virtual const char* vtkPlusPhantomLandmarkRegistrationAlgo::GetClassName ( )
virtual

◆ GetConfigurationElementName()

static std::string vtkPlusPhantomLandmarkRegistrationAlgo::GetConfigurationElementName ( )
inlinestatic

Get configuration element name

Definition at line 55 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ GetDefinedLandmark_Reference()

void vtkPlusPhantomLandmarkRegistrationAlgo::GetDefinedLandmark_Reference ( int  index,
double  cameraPosition_Reference[4] 
)

Get the defined landmark at index in the reference coordinates system

Definition at line 332 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ GetDefinedLandmarkName()

std::string vtkPlusPhantomLandmarkRegistrationAlgo::GetDefinedLandmarkName ( int  aIndex)
inline

Gets defined landmark name

Parameters
aIndexIndex of the landmark
Returns
Name string

Definition at line 52 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ GetDefinedLandmarks_Phantom()

virtual vtkPoints* vtkPlusPhantomLandmarkRegistrationAlgo::GetDefinedLandmarks_Phantom ( )
virtual

◆ GetDefinedLandmarksCentroid_Phantom()

void vtkPlusPhantomLandmarkRegistrationAlgo::GetDefinedLandmarksCentroid_Phantom ( double  landmarksCentroid_Phantom[4])

Get the defined landmarks "centroid" (it is actually just the average of the landmarks position, pretty close to phantom centroid) in phantom coordinates system

Definition at line 288 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ GetDefinedLandmarksCentroid_Reference()

void vtkPlusPhantomLandmarkRegistrationAlgo::GetDefinedLandmarksCentroid_Reference ( double  landmarksAverage_Reference[4])

Get the defined landmarks "centroid" (it is actually just the average of the landmarks position, pretty close to phantom centroid) in reference coordinates system

Definition at line 275 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ GetLandmarkCameraPosition_Reference()

void vtkPlusPhantomLandmarkRegistrationAlgo::GetLandmarkCameraPosition_Reference ( int  index,
double  cameraPosition_Reference[4] 
)

Get the camera position (in reference coordinates system) of the next landmark to be added. The position is 500 mm away from the next landmark along the "centroid"-next landmark direction

Definition at line 307 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ GetMinimunDistanceBetweenTwoLandmarksMm()

double vtkPlusPhantomLandmarkRegistrationAlgo::GetMinimunDistanceBetweenTwoLandmarksMm ( )

Get minimum distance between any two landmarks [mm]

Definition at line 250 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ GetPhantomCoordinateFrame()

virtual char* vtkPlusPhantomLandmarkRegistrationAlgo::GetPhantomCoordinateFrame ( )
virtual

◆ GetPhantomToReferenceTransformMatrix()

virtual vtkMatrix4x4* vtkPlusPhantomLandmarkRegistrationAlgo::GetPhantomToReferenceTransformMatrix ( )
virtual

◆ GetRecordedLandmarks_Reference()

virtual vtkPoints* vtkPlusPhantomLandmarkRegistrationAlgo::GetRecordedLandmarks_Reference ( )
virtual

◆ GetReferenceCoordinateFrame()

virtual char* vtkPlusPhantomLandmarkRegistrationAlgo::GetReferenceCoordinateFrame ( )
virtual

◆ GetRegistrationErrorMm()

virtual double vtkPlusPhantomLandmarkRegistrationAlgo::GetRegistrationErrorMm ( )
virtual

◆ GetStylusTipCoordinateFrame()

virtual char* vtkPlusPhantomLandmarkRegistrationAlgo::GetStylusTipCoordinateFrame ( )
virtual

◆ IsA()

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

◆ IsTypeOf()

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

◆ LandmarkRegister()

PlusStatus vtkPlusPhantomLandmarkRegistrationAlgo::LandmarkRegister ( vtkIGSIOTransformRepository *  aTransformRepository = NULL)

Performs landmark registration to determine transformation from phantom reference to phantom

Parameters
aTransformRepositoryTransform repository to save the results into

Definition at line 61 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ New()

static vtkPlusPhantomLandmarkRegistrationAlgo* vtkPlusPhantomLandmarkRegistrationAlgo::New ( )
static

◆ PrintRecordedLandmarks_Phantom()

void vtkPlusPhantomLandmarkRegistrationAlgo::PrintRecordedLandmarks_Phantom ( )

Print recorded landmarks in Phantom coordinates system

Definition at line 344 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusPhantomLandmarkRegistrationAlgo::ReadConfiguration ( vtkXMLDataElement *  aConfig)

Read phantom definition (landmarks)

Parameters
aConfigRoot XML data element containing the tool calibration

Definition at line 149 of file vtkPlusPhantomLandmarkRegistrationAlgo.cxx.

◆ SafeDownCast()

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

◆ SetDefinedLandmarks_Phantom()

virtual void vtkPlusPhantomLandmarkRegistrationAlgo::SetDefinedLandmarks_Phantom ( vtkPoints *  )
protectedvirtual

Sets the known landmark points positions (defined in the Phantom coordinate system)

◆ SetPhantomCoordinateFrame()

virtual void vtkPlusPhantomLandmarkRegistrationAlgo::SetPhantomCoordinateFrame ( const char *  )
protectedvirtual

◆ SetPhantomToReferenceTransformMatrix()

virtual void vtkPlusPhantomLandmarkRegistrationAlgo::SetPhantomToReferenceTransformMatrix ( vtkMatrix4x4 *  )
virtual

◆ SetRecordedLandmarks_Reference()

virtual void vtkPlusPhantomLandmarkRegistrationAlgo::SetRecordedLandmarks_Reference ( vtkPoints *  )
protectedvirtual

Sets the landmark points that were recorded by a stylus (defined in the Reference coordinate system)

◆ SetReferenceCoordinateFrame()

virtual void vtkPlusPhantomLandmarkRegistrationAlgo::SetReferenceCoordinateFrame ( const char *  )
protectedvirtual

◆ SetStylusTipCoordinateFrame()

virtual void vtkPlusPhantomLandmarkRegistrationAlgo::SetStylusTipCoordinateFrame ( const char *  )
protectedvirtual

Member Data Documentation

◆ ConfigurationElementName

std::string vtkPlusPhantomLandmarkRegistrationAlgo::ConfigurationElementName = "vtkPlusPhantomLandmarkRegistrationAlgo"
staticprotected

Name of the phantom registration configuration element

Definition at line 140 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ DefinedLandmarkNames

std::vector<std::string> vtkPlusPhantomLandmarkRegistrationAlgo::DefinedLandmarkNames
protected

Names of the defined phantom landmarks from the configuration file

Definition at line 119 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ DefinedLandmarks_Phantom

vtkPoints* vtkPlusPhantomLandmarkRegistrationAlgo::DefinedLandmarks_Phantom
protected

Point array holding the defined landmarks from the configuration file

Definition at line 116 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ minimumDistanceBetweenTwoLandmarksMm

double vtkPlusPhantomLandmarkRegistrationAlgo::minimumDistanceBetweenTwoLandmarksMm
protected

Minimum distance between any two landmarks [mm]

Definition at line 113 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ PhantomCoordinateFrame

char* vtkPlusPhantomLandmarkRegistrationAlgo::PhantomCoordinateFrame
protected

Name of the phantom coordinate frame (eg. Phantom)

Definition at line 131 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ PhantomToReferenceTransformMatrix

vtkMatrix4x4* vtkPlusPhantomLandmarkRegistrationAlgo::PhantomToReferenceTransformMatrix
protected

Phantom to reference transform matrix - the result of the registration

Definition at line 125 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ RecordedLandmarks_Reference

vtkPoints* vtkPlusPhantomLandmarkRegistrationAlgo::RecordedLandmarks_Reference
protected

Point array holding the recorded landmarks

Definition at line 122 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ ReferenceCoordinateFrame

char* vtkPlusPhantomLandmarkRegistrationAlgo::ReferenceCoordinateFrame
protected

Name of the reference coordinate frame (eg. Reference)

Definition at line 134 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ RegistrationErrorMm

double vtkPlusPhantomLandmarkRegistrationAlgo::RegistrationErrorMm
protected

The mean error of the landmark registration in mm

Definition at line 128 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.

◆ StylusTipCoordinateFrame

char* vtkPlusPhantomLandmarkRegistrationAlgo::StylusTipCoordinateFrame
protected

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

Definition at line 137 of file vtkPlusPhantomLandmarkRegistrationAlgo.h.


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