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
vtkPlusPrincipalMotionDetectionAlgo 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/vtkTemporalCalibrationAlgo/vtkPlusPrincipalMotionDetectionAlgo.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

void ComputePrincipalAxis (std::deque< itk::Point< double, 3 > > &trackerPositions, itk::Point< double, 3 > &principalAxisOfMotion, int numValidFrames)
 
virtual const char * GetClassName ()
 
void GetDetectedPositions (std::deque< double > &positions)
 
void GetDetectedTimestamps (std::deque< double > &timestamps)
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
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 vtkPlusPrincipalMotionDetectionAlgoNew ()
 
static vtkPlusPrincipalMotionDetectionAlgoSafeDownCast (vtkObject *o)
 

Protected Member Functions

PlusStatus ComputeTrackerPositionMetric ()
 
PlusStatus VerifyInputFrames ()
 
 vtkPlusPrincipalMotionDetectionAlgo ()
 
virtual ~vtkPlusPrincipalMotionDetectionAlgo ()
 

Protected Attributes

std::string m_ProbeToReferenceTransformName
 
double m_SignalTimeRangeMax
 
double m_SignalTimeRangeMin
 
std::deque< double > m_SignalTimestamps
 
std::deque< double > m_SignalValues
 
vtkIGSIOTrackedFrameList * m_TrackerFrames
 

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 20 of file vtkPlusPrincipalMotionDetectionAlgo.h.

Member Typedef Documentation

◆ Superclass

Definition at line 24 of file vtkPlusPrincipalMotionDetectionAlgo.h.

Constructor & Destructor Documentation

◆ vtkPlusPrincipalMotionDetectionAlgo()

vtkPlusPrincipalMotionDetectionAlgo::vtkPlusPrincipalMotionDetectionAlgo ( )
protected

Definition at line 25 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ ~vtkPlusPrincipalMotionDetectionAlgo()

vtkPlusPrincipalMotionDetectionAlgo::~vtkPlusPrincipalMotionDetectionAlgo ( )
protectedvirtual

Definition at line 32 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

Member Function Documentation

◆ ComputePrincipalAxis()

void vtkPlusPrincipalMotionDetectionAlgo::ComputePrincipalAxis ( std::deque< itk::Point< double, 3 > > &  trackerPositions,
itk::Point< double, 3 > &  principalAxisOfMotion,
int  numValidFrames 
)

Definition at line 164 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ ComputeTrackerPositionMetric()

PlusStatus vtkPlusPrincipalMotionDetectionAlgo::ComputeTrackerPositionMetric ( )
protected

Definition at line 79 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ GetClassName()

virtual const char* vtkPlusPrincipalMotionDetectionAlgo::GetClassName ( )
virtual

◆ GetDetectedPositions()

void vtkPlusPrincipalMotionDetectionAlgo::GetDetectedPositions ( std::deque< double > &  positions)

Get the line positions on the frames where a line was successfully detected

Definition at line 246 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ GetDetectedTimestamps()

void vtkPlusPrincipalMotionDetectionAlgo::GetDetectedTimestamps ( std::deque< double > &  timestamps)

Get the timestamps of the frames where a line was successfully detected

Definition at line 240 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkPlusPrincipalMotionDetectionAlgo* vtkPlusPrincipalMotionDetectionAlgo::New ( )
static

◆ PrintSelf()

void vtkPlusPrincipalMotionDetectionAlgo::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Definition at line 37 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ SafeDownCast()

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

◆ SetProbeToReferenceTransformName()

void vtkPlusPrincipalMotionDetectionAlgo::SetProbeToReferenceTransformName ( const std::string &  probeToReferenceTransformName)

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

Definition at line 56 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ SetSignalTimeRange()

void vtkPlusPrincipalMotionDetectionAlgo::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 49 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ SetTrackerFrames()

void vtkPlusPrincipalMotionDetectionAlgo::SetTrackerFrames ( vtkIGSIOTrackedFrameList *  trackerFrames)

Sets the input US video frames

Definition at line 43 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ Update()

PlusStatus vtkPlusPrincipalMotionDetectionAlgo::Update ( )

Run the line detection algorithm on the input video frames

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

Definition at line 226 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

◆ VerifyInputFrames()

PlusStatus vtkPlusPrincipalMotionDetectionAlgo::VerifyInputFrames ( )
protected

Definition at line 62 of file vtkPlusPrincipalMotionDetectionAlgo.cxx.

Member Data Documentation

◆ m_ProbeToReferenceTransformName

std::string vtkPlusPrincipalMotionDetectionAlgo::m_ProbeToReferenceTransformName
protected

Definition at line 58 of file vtkPlusPrincipalMotionDetectionAlgo.h.

◆ m_SignalTimeRangeMax

double vtkPlusPrincipalMotionDetectionAlgo::m_SignalTimeRangeMax
protected

Definition at line 64 of file vtkPlusPrincipalMotionDetectionAlgo.h.

◆ m_SignalTimeRangeMin

double vtkPlusPrincipalMotionDetectionAlgo::m_SignalTimeRangeMin
protected

Definition at line 63 of file vtkPlusPrincipalMotionDetectionAlgo.h.

◆ m_SignalTimestamps

std::deque<double> vtkPlusPrincipalMotionDetectionAlgo::m_SignalTimestamps
protected

Definition at line 61 of file vtkPlusPrincipalMotionDetectionAlgo.h.

◆ m_SignalValues

std::deque<double> vtkPlusPrincipalMotionDetectionAlgo::m_SignalValues
protected

Definition at line 60 of file vtkPlusPrincipalMotionDetectionAlgo.h.

◆ m_TrackerFrames

vtkIGSIOTrackedFrameList* vtkPlusPrincipalMotionDetectionAlgo::m_TrackerFrames
protected

Definition at line 57 of file vtkPlusPrincipalMotionDetectionAlgo.h.


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