vtkPlusReadTrackedSignals Class Reference

Extract the motion component along the the principal axis of the motion. Used for computing a position metric from a periodically moving tool. More...

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

Inheritance diagram for vtkPlusReadTrackedSignals:

Collaboration diagram for vtkPlusReadTrackedSignals:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual char *	GetObjectMarkerCoordinateFrame ()
virtual char *	GetObjectPivotPointCoordinateFrame ()
virtual char *	GetReferenceCoordinateFrame ()
void	GetSignalStylusRef (std::deque< double > &signalComponent)
void	GetSignalStylusTipRef (std::deque< double > &signalComponent)
void	GetSignalStylusTipSpeed (std::deque< double > &signalComponent)
void	GetSignalZ (std::deque< double > &signalComponent)
void	GetTimestamps (std::deque< double > &timestamps)
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
PlusStatus	ReadConfiguration (vtkXMLDataElement *aConfig)
void	SetProbeToReferenceTransformName (const std::string &probeToReferenceTransformName)
void	SetSignalTimeRange (double rangeMin, double rangeMax)
void	SetTrackerFrames (vtkIGSIOTrackedFrameList *trackerFrames)
PlusStatus	Update ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkPlusReadTrackedSignals *	New ()
static vtkPlusReadTrackedSignals *	SafeDownCast (vtkObject *o)

Protected Member Functions
PlusStatus	ComputeTrackerPositionMetric ()
virtual void	SetObjectMarkerCoordinateFrame (const char *)
virtual void	SetObjectPivotPointCoordinateFrame (const char *)
virtual void	SetReferenceCoordinateFrame (const char *)
PlusStatus	VerifyInputFrames ()
	vtkPlusReadTrackedSignals ()
virtual	~vtkPlusReadTrackedSignals ()

Protected Attributes
std::deque< double >	m_SignalStylusRef
std::deque< double >	m_SignalStylusTipRef
std::deque< double >	m_SignalStylusTipSpeed
double	m_SignalTimeRangeMax
double	m_SignalTimeRangeMin
std::deque< double >	m_SignalTimestamps
vtkIGSIOTrackedFrameList *	m_TrackerFrames
char *	ObjectMarkerCoordinateFrame
char *	ObjectPivotPointCoordinateFrame
char *	ReferenceCoordinateFrame
vtkSmartPointer< vtkMatrix4x4 >	StylusTipToStylusTransform

Detailed Description

Extract the motion component along the the principal axis of the motion. Used for computing a position metric from a periodically moving tool.

=Plus=header=begin====================================================== Program: Plus Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved. See License.txt for details. =========================================================Plus=header=end

Definition at line 22 of file vtkPlusReadTrackedSignals.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPlusReadTrackedSignals::Superclass

Definition at line 26 of file vtkPlusReadTrackedSignals.h.

Constructor & Destructor Documentation

vtkPlusReadTrackedSignals()

vtkPlusReadTrackedSignals::vtkPlusReadTrackedSignals ( )

protected

Definition at line 27 of file vtkPlusReadTrackedSignals.cxx.

~vtkPlusReadTrackedSignals()

vtkPlusReadTrackedSignals::~vtkPlusReadTrackedSignals ( )

protectedvirtual

Definition at line 38 of file vtkPlusReadTrackedSignals.cxx.

Member Function Documentation

ComputeTrackerPositionMetric()

PlusStatus vtkPlusReadTrackedSignals::ComputeTrackerPositionMetric ( )

protected

Definition at line 80 of file vtkPlusReadTrackedSignals.cxx.

GetClassName()

virtual const char* vtkPlusReadTrackedSignals::GetClassName ( )

virtual

GetObjectMarkerCoordinateFrame()

virtual char* vtkPlusReadTrackedSignals::GetObjectMarkerCoordinateFrame ( )

virtual

GetObjectPivotPointCoordinateFrame()

virtual char* vtkPlusReadTrackedSignals::GetObjectPivotPointCoordinateFrame ( )

virtual

GetReferenceCoordinateFrame()

virtual char* vtkPlusReadTrackedSignals::GetReferenceCoordinateFrame ( )

virtual

GetSignalStylusRef()

void vtkPlusReadTrackedSignals::GetSignalStylusRef

(

std::deque< double > &

signalComponent

)

Definition at line 203 of file vtkPlusReadTrackedSignals.cxx.

GetSignalStylusTipRef()

void vtkPlusReadTrackedSignals::GetSignalStylusTipRef

(

std::deque< double > &

signalComponent

)

Definition at line 208 of file vtkPlusReadTrackedSignals.cxx.

GetSignalStylusTipSpeed()

void vtkPlusReadTrackedSignals::GetSignalStylusTipSpeed

(

std::deque< double > &

signalComponent

)

Definition at line 213 of file vtkPlusReadTrackedSignals.cxx.

GetSignalZ()

void vtkPlusReadTrackedSignals::GetSignalZ

(

std::deque< double > &

signalComponent

)

GetTimestamps()

void vtkPlusReadTrackedSignals::GetTimestamps

(

std::deque< double > &

timestamps

)

Get the timestamps of the frames where a line was successfully

Definition at line 197 of file vtkPlusReadTrackedSignals.cxx.

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkPlusReadTrackedSignals* vtkPlusReadTrackedSignals::New ( )

static

PrintSelf()

void vtkPlusReadTrackedSignals::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Definition at line 43 of file vtkPlusReadTrackedSignals.cxx.

ReadConfiguration()

PlusStatus vtkPlusReadTrackedSignals::ReadConfiguration

(

vtkXMLDataElement *

aConfig

)

Definition at line 156 of file vtkPlusReadTrackedSignals.cxx.

SafeDownCast()

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

static

SetObjectMarkerCoordinateFrame()

virtual void vtkPlusReadTrackedSignals::SetObjectMarkerCoordinateFrame ( const char *  )

protectedvirtual

SetObjectPivotPointCoordinateFrame()

virtual void vtkPlusReadTrackedSignals::SetObjectPivotPointCoordinateFrame ( const char *  )

protectedvirtual

SetProbeToReferenceTransformName()

void vtkPlusReadTrackedSignals::SetProbeToReferenceTransformName

(

const std::string &

probeToReferenceTransformName

)

Sets the name of the transform to be used for tracking data. Default is "ProbeToReference"

SetReferenceCoordinateFrame()

virtual void vtkPlusReadTrackedSignals::SetReferenceCoordinateFrame ( const char *  )

protectedvirtual

SetSignalTimeRange()

void vtkPlusReadTrackedSignals::SetSignalTimeRange	(	double	rangeMin,
		double	rangeMax
	)

Sets the time range where the signal will be extracted from. If rangeMax<rangeMin then all the input frames will be used to genereate the signal.

Definition at line 55 of file vtkPlusReadTrackedSignals.cxx.

SetTrackerFrames()

void vtkPlusReadTrackedSignals::SetTrackerFrames

(

vtkIGSIOTrackedFrameList *

trackerFrames

)

Sets the input US video frames

Definition at line 49 of file vtkPlusReadTrackedSignals.cxx.

Update()

PlusStatus vtkPlusReadTrackedSignals::Update

(

)

Run the line detection algorithm on the input video frames

Parameters

errorDetail

if the algorithm fails then the details of the problem are returned in this string

Definition at line 183 of file vtkPlusReadTrackedSignals.cxx.

VerifyInputFrames()

PlusStatus vtkPlusReadTrackedSignals::VerifyInputFrames ( )

protected

Definition at line 63 of file vtkPlusReadTrackedSignals.cxx.

Member Data Documentation

m_SignalStylusRef

std::deque<double> vtkPlusReadTrackedSignals::m_SignalStylusRef

protected

Definition at line 80 of file vtkPlusReadTrackedSignals.h.

m_SignalStylusTipRef

std::deque<double> vtkPlusReadTrackedSignals::m_SignalStylusTipRef

protected

Definition at line 81 of file vtkPlusReadTrackedSignals.h.

m_SignalStylusTipSpeed

std::deque<double> vtkPlusReadTrackedSignals::m_SignalStylusTipSpeed

protected

Definition at line 82 of file vtkPlusReadTrackedSignals.h.

m_SignalTimeRangeMax

double vtkPlusReadTrackedSignals::m_SignalTimeRangeMax

protected

Definition at line 85 of file vtkPlusReadTrackedSignals.h.

m_SignalTimeRangeMin

double vtkPlusReadTrackedSignals::m_SignalTimeRangeMin

protected

Definition at line 84 of file vtkPlusReadTrackedSignals.h.

m_SignalTimestamps

std::deque<double> vtkPlusReadTrackedSignals::m_SignalTimestamps

protected

Definition at line 79 of file vtkPlusReadTrackedSignals.h.

m_TrackerFrames

vtkIGSIOTrackedFrameList* vtkPlusReadTrackedSignals::m_TrackerFrames

protected

Definition at line 68 of file vtkPlusReadTrackedSignals.h.

ObjectMarkerCoordinateFrame

char* vtkPlusReadTrackedSignals::ObjectMarkerCoordinateFrame

protected

Name of the object marker coordinate frame (eg. Stylus)

Definition at line 71 of file vtkPlusReadTrackedSignals.h.

ObjectPivotPointCoordinateFrame

char* vtkPlusReadTrackedSignals::ObjectPivotPointCoordinateFrame

protected

Name of the object pivot point coordinate frame (eg. StylusTip)

Definition at line 75 of file vtkPlusReadTrackedSignals.h.

ReferenceCoordinateFrame

char* vtkPlusReadTrackedSignals::ReferenceCoordinateFrame

protected

Name of the reference coordinate frame (eg. Reference)

Definition at line 73 of file vtkPlusReadTrackedSignals.h.

StylusTipToStylusTransform

vtkSmartPointer<vtkMatrix4x4> vtkPlusReadTrackedSignals::StylusTipToStylusTransform

protected

Definition at line 77 of file vtkPlusReadTrackedSignals.h.

---

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

• src/PlusCalibration/vtkPhantomLandmarkRegistrationAlgo/vtkPlusReadTrackedSignals.h
• src/PlusCalibration/vtkPhantomLandmarkRegistrationAlgo/vtkPlusReadTrackedSignals.cxx