vtkPlusTrackedFrameProcessor Class Reference

Simple interface class to allow running various algorithms that process tracked frame lists. More...

#include <src/PlusImageProcessing/vtkPlusTrackedFrameProcessor.h>

Inheritance diagram for vtkPlusTrackedFrameProcessor:

Collaboration diagram for vtkPlusTrackedFrameProcessor:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual vtkIGSIOTrackedFrameList *	GetInputFrames ()
virtual vtkIGSIOTrackedFrameList *	GetOutputFrames ()
virtual const char *	GetProcessorTypeName ()=0
virtual vtkIGSIOTransformRepository *	GetTransformRepository ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
virtual PlusStatus	ReadConfiguration (vtkXMLDataElement *processingElement)
virtual void	SetInputFrames (vtkIGSIOTrackedFrameList *inputFrames)
virtual void	SetTransformRepository (vtkIGSIOTransformRepository *transformRepository)
virtual PlusStatus	Update ()
virtual PlusStatus	WriteConfiguration (vtkXMLDataElement *processingElement)

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

Protected Member Functions
virtual PlusStatus	ProcessFrame (igsioTrackedFrame *inputFrame, igsioTrackedFrame *outputFrame)=0
	vtkPlusTrackedFrameProcessor ()
virtual	~vtkPlusTrackedFrameProcessor ()

Protected Attributes
vtkIGSIOTrackedFrameList *	InputFrames
vtkIGSIOTrackedFrameList *	OutputFrames
vtkIGSIOTransformRepository *	TransformRepository

Detailed Description

Simple interface class to allow running various algorithms that process tracked frame lists.

Definition at line 21 of file vtkPlusTrackedFrameProcessor.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPlusTrackedFrameProcessor::Superclass

Definition at line 24 of file vtkPlusTrackedFrameProcessor.h.

Constructor & Destructor Documentation

vtkPlusTrackedFrameProcessor()

vtkPlusTrackedFrameProcessor::vtkPlusTrackedFrameProcessor ( )

protected

Definition at line 20 of file vtkPlusTrackedFrameProcessor.cxx.

~vtkPlusTrackedFrameProcessor()

vtkPlusTrackedFrameProcessor::~vtkPlusTrackedFrameProcessor ( )

protectedvirtual

Definition at line 28 of file vtkPlusTrackedFrameProcessor.cxx.

Member Function Documentation

GetClassName()

virtual const char* vtkPlusTrackedFrameProcessor::GetClassName ( )

virtual

Reimplemented in vtkPlusBoneEnhancer, and vtkPlusTransverseProcessEnhancer.

GetInputFrames()

virtual vtkIGSIOTrackedFrameList* vtkPlusTrackedFrameProcessor::GetInputFrames ( )

virtual

GetOutputFrames()

virtual vtkIGSIOTrackedFrameList* vtkPlusTrackedFrameProcessor::GetOutputFrames ( )

virtual

Get the processed output data. Perform processing if needed.

GetProcessorTypeName()

virtual const char* vtkPlusTrackedFrameProcessor::GetProcessorTypeName ( )

pure virtual

Get the Type attribute of the configuration element

Implemented in vtkPlusBoneEnhancer, and vtkPlusTransverseProcessEnhancer.

GetTagName()

static const char* vtkPlusTrackedFrameProcessor::GetTagName ( )

inlinestatic

Get the tag name of the configuration element

Definition at line 53 of file vtkPlusTrackedFrameProcessor.h.

GetTransformRepository()

virtual vtkIGSIOTransformRepository* vtkPlusTrackedFrameProcessor::GetTransformRepository ( )

virtual

IsA()

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

virtual

Reimplemented in vtkPlusBoneEnhancer, and vtkPlusTransverseProcessEnhancer.

IsTypeOf()

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

static

PrintSelf()

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

virtual

Reimplemented in vtkPlusBoneEnhancer, and vtkPlusTransverseProcessEnhancer.

Definition at line 37 of file vtkPlusTrackedFrameProcessor.cxx.

ProcessFrame()

virtual PlusStatus vtkPlusTrackedFrameProcessor::ProcessFrame ( igsioTrackedFrame *  inputFrame, igsioTrackedFrame *  outputFrame  )

protectedpure virtual

Default Update() method calls this processing function for each frame. Typically this method should be overridden in derived classes. Both input and output frames are already allocated by the caller method.

Implemented in vtkPlusBoneEnhancer, and vtkPlusTransverseProcessEnhancer.

ReadConfiguration()

PlusStatus vtkPlusTrackedFrameProcessor::ReadConfiguration ( vtkXMLDataElement *  processingElement )

virtual

Read configuration from xml data

Definition at line 43 of file vtkPlusTrackedFrameProcessor.cxx.

SafeDownCast()

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

static

SetInputFrames()

virtual void vtkPlusTrackedFrameProcessor::SetInputFrames ( vtkIGSIOTrackedFrameList *  inputFrames )

virtual

Set the input tracked frame data

Parameters

frame

frame containing image (and optional tracking or other metadata)

SetTransformRepository()

virtual void vtkPlusTrackedFrameProcessor::SetTransformRepository ( vtkIGSIOTransformRepository *  transformRepository )

virtual

Set the transform repository (optional, may contain various persistent calibration transforms)

Update()

PlusStatus vtkPlusTrackedFrameProcessor::Update ( void  )

virtual

Perform processing. Results are saved to OutputFrames. It calls ProcessFrame for each input frame. The method can be overriden, for example if frames are not processed one by one.

Definition at line 58 of file vtkPlusTrackedFrameProcessor.cxx.

WriteConfiguration()

PlusStatus vtkPlusTrackedFrameProcessor::WriteConfiguration ( vtkXMLDataElement *  processingElement )

virtual

Write configuration to xml data

Definition at line 50 of file vtkPlusTrackedFrameProcessor.cxx.

Member Data Documentation

InputFrames

vtkIGSIOTrackedFrameList* vtkPlusTrackedFrameProcessor::InputFrames

protected

Definition at line 68 of file vtkPlusTrackedFrameProcessor.h.

OutputFrames

vtkIGSIOTrackedFrameList* vtkPlusTrackedFrameProcessor::OutputFrames

protected

Definition at line 70 of file vtkPlusTrackedFrameProcessor.h.

TransformRepository

vtkIGSIOTransformRepository* vtkPlusTrackedFrameProcessor::TransformRepository

protected

Definition at line 69 of file vtkPlusTrackedFrameProcessor.h.

---

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

• src/PlusImageProcessing/vtkPlusTrackedFrameProcessor.h
• src/PlusImageProcessing/vtkPlusTrackedFrameProcessor.cxx