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
vtkPlusSpacingCalibAlgo Class Reference
CalibrationAlgorithm

Calculates ultrasound image spacing from phantom definition file. More...

#include <src/PlusCalibration/vtkSpacingCalibAlgo/vtkPlusSpacingCalibAlgo.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual PlusStatus GenerateReport (vtkPlusHTMLGenerator *htmlReport)
 
virtual const char * GetClassName ()
 
virtual PlusStatus GetError (double &mean, double &stdev)
 
virtual vtkTable * GetReportTable ()
 
virtual PlusStatus GetSpacing (double spacing[2])
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual void SetInputs (vtkIGSIOTrackedFrameList *trackedFrameList, const std::vector< PlusNWire > &nWires)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusSpacingCalibAlgo * New ()
 
static vtkPlusSpacingCalibAlgo * SafeDownCast (vtkObject *o)
 

Protected Member Functions

PlusStatus AddNewColumnToReportTable (const char *columnName)
 
virtual PlusStatus ConstructLinearEquationForCalibration (std::vector< vnl_vector< double > > &aMatrix, std::vector< double > &bVector)
 
virtual vtkIGSIOTrackedFrameList * GetTrackedFrameList ()
 
virtual void SetReportTable (vtkTable *)
 
void SetSpacing (double [2])
 
virtual void SetSpacing (double, double)
 
virtual void SetTrackedFrameList (vtkIGSIOTrackedFrameList *)
 
virtual PlusStatus Update ()
 
virtual PlusStatus UpdateReportTable (const std::vector< vnl_vector< double > > &aMatrix, const std::vector< double > &bVector, const vnl_vector< double > &resultVector)
 
 vtkPlusSpacingCalibAlgo ()
 
virtual ~vtkPlusSpacingCalibAlgo ()
 

Protected Attributes

double ErrorMean
 
double ErrorStdev
 
std::vector< PlusNWire > NWires
 
vtkTable * ReportTable
 
double Spacing [2]
 
vtkIGSIOTrackedFrameList * TrackedFrameList
 
vtkTimeStamp UpdateTime
 

Detailed Description

Calculates ultrasound image spacing from phantom definition file.

Definition at line 25 of file vtkPlusSpacingCalibAlgo.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPlusSpacingCalibAlgo::Superclass

Definition at line 29 of file vtkPlusSpacingCalibAlgo.h.

Constructor & Destructor Documentation

◆ vtkPlusSpacingCalibAlgo()

vtkPlusSpacingCalibAlgo::vtkPlusSpacingCalibAlgo ( )
protected

Definition at line 29 of file vtkPlusSpacingCalibAlgo.cxx.

◆ ~vtkPlusSpacingCalibAlgo()

vtkPlusSpacingCalibAlgo::~vtkPlusSpacingCalibAlgo ( )
protectedvirtual

Definition at line 39 of file vtkPlusSpacingCalibAlgo.cxx.

Member Function Documentation

◆ AddNewColumnToReportTable()

PlusStatus vtkPlusSpacingCalibAlgo::AddNewColumnToReportTable ( const char *  columnName)
protected

Add new column to the report table

Definition at line 314 of file vtkPlusSpacingCalibAlgo.cxx.

◆ ConstructLinearEquationForCalibration()

PlusStatus vtkPlusSpacingCalibAlgo::ConstructLinearEquationForCalibration ( std::vector< vnl_vector< double > > &  aMatrix,
std::vector< double > &  bVector 
)
protectedvirtual

Construct linear equation for spacing calibration

Definition at line 167 of file vtkPlusSpacingCalibAlgo.cxx.

◆ GenerateReport()

PlusStatus vtkPlusSpacingCalibAlgo::GenerateReport ( vtkPlusHTMLGenerator *  htmlReport)
virtual

Add generated html report from spacing calibration to the existing html report htmlReport and plotter arguments has to be defined by the caller function

Definition at line 343 of file vtkPlusSpacingCalibAlgo.cxx.

◆ GetClassName()

virtual const char* vtkPlusSpacingCalibAlgo::GetClassName ( )
virtual

◆ GetError()

PlusStatus vtkPlusSpacingCalibAlgo::GetError ( double &  mean,
double &  stdev 
)
virtual

Get the spacing calibration error

Definition at line 92 of file vtkPlusSpacingCalibAlgo.cxx.

◆ GetReportTable()

virtual vtkTable* vtkPlusSpacingCalibAlgo::GetReportTable ( )
virtual

Report table used for storing algorithm results

◆ GetSpacing()

PlusStatus vtkPlusSpacingCalibAlgo::GetSpacing ( double  spacing[2])
virtual

Get the image spacing (mm/pixel; spacing[0]: lateral axis, spacing[1]: axial axis)

Definition at line 79 of file vtkPlusSpacingCalibAlgo.cxx.

◆ GetTrackedFrameList()

virtual vtkIGSIOTrackedFrameList* vtkPlusSpacingCalibAlgo::GetTrackedFrameList ( )
protectedvirtual

Get tracked frame list

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkPlusSpacingCalibAlgo* vtkPlusSpacingCalibAlgo::New ( )
static

◆ PrintSelf()

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

Definition at line 46 of file vtkPlusSpacingCalibAlgo.cxx.

◆ SafeDownCast()

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

◆ SetInputs()

void vtkPlusSpacingCalibAlgo::SetInputs ( vtkIGSIOTrackedFrameList *  trackedFrameList,
const std::vector< PlusNWire > &  nWires 
)
virtual

Set inputs:

Parameters
trackedFrameListtracked frames with segmentation results
nWiresphantom definition structure
See also
NWire(), vtkIGSIOTrackedFrameList()

Definition at line 69 of file vtkPlusSpacingCalibAlgo.cxx.

◆ SetReportTable()

virtual void vtkPlusSpacingCalibAlgo::SetReportTable ( vtkTable *  )
protectedvirtual

Report table used for storing algorithm results

◆ SetSpacing() [1/2]

virtual void vtkPlusSpacingCalibAlgo::SetSpacing ( double  ,
double   
)
protectedvirtual

Set image spacing (mm/pixel)

◆ SetSpacing() [2/2]

void vtkPlusSpacingCalibAlgo::SetSpacing ( double  [2])
protected

◆ SetTrackedFrameList()

virtual void vtkPlusSpacingCalibAlgo::SetTrackedFrameList ( vtkIGSIOTrackedFrameList *  )
protectedvirtual

Set tracked frame list

◆ Update()

PlusStatus vtkPlusSpacingCalibAlgo::Update ( )
protectedvirtual

Bring this algorithm's outputs up-to-date.

Definition at line 105 of file vtkPlusSpacingCalibAlgo.cxx.

◆ UpdateReportTable()

PlusStatus vtkPlusSpacingCalibAlgo::UpdateReportTable ( const std::vector< vnl_vector< double > > &  aMatrix,
const std::vector< double > &  bVector,
const vnl_vector< double > &  resultVector 
)
protectedvirtual

Update spacing calibration error report table

Definition at line 268 of file vtkPlusSpacingCalibAlgo.cxx.

Member Data Documentation

◆ ErrorMean

double vtkPlusSpacingCalibAlgo::ErrorMean
protected

Calibration error mean

Definition at line 98 of file vtkPlusSpacingCalibAlgo.h.

◆ ErrorStdev

double vtkPlusSpacingCalibAlgo::ErrorStdev
protected

Calibration error standard deviation

Definition at line 101 of file vtkPlusSpacingCalibAlgo.h.

◆ NWires

std::vector<PlusNWire> vtkPlusSpacingCalibAlgo::NWires
protected

Phantom definition structure

Definition at line 92 of file vtkPlusSpacingCalibAlgo.h.

◆ ReportTable

vtkTable* vtkPlusSpacingCalibAlgo::ReportTable
protected

Table used for storing algo results

Definition at line 95 of file vtkPlusSpacingCalibAlgo.h.

◆ Spacing

double vtkPlusSpacingCalibAlgo::Spacing[2]
protected

Image image spacing (mm/pixel; spacing[0]: lateral axis, spacing[1]: axial axis)

Definition at line 83 of file vtkPlusSpacingCalibAlgo.h.

◆ TrackedFrameList

vtkIGSIOTrackedFrameList* vtkPlusSpacingCalibAlgo::TrackedFrameList
protected

Tracked frame list with segmentation results

Definition at line 89 of file vtkPlusSpacingCalibAlgo.h.

◆ UpdateTime

vtkTimeStamp vtkPlusSpacingCalibAlgo::UpdateTime
protected

When the results were computed. The result is recomputed only if the inputs changed more recently than UpdateTime.

Definition at line 104 of file vtkPlusSpacingCalibAlgo.h.

The documentation for this class was generated from the following files:
Generated on Thu Apr 25 2024 01:38:16 for PlusLib by   doxygen 1.8.15