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
vtkPlusVolumeReconstructor Class Reference

Reconstructs a volume from tracked frames. More...

#include <src/PlusVolumeReconstruction/vtkPlusVolumeReconstructor.h>

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

Public Types

typedef vtkIGSIOVolumeReconstructor Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual PlusStatus SaveReconstructedVolumeToFile (const std::string &filename, bool accumulation=false, bool useCompression=true) override
 
virtual PlusStatus SaveReconstructedVolumeToFile (const std::string &filename, bool accumulation=false, bool useCompression=true, std::vector< std::string > *customFields=nullptr, std::vector< std::string > *customValues=nullptr)
 
virtual PlusStatus SaveReconstructedVolumeToMetafile (const std::string &filename, bool accumulation=false, bool useCompression=true, std::vector< std::string > *customFields=nullptr, std::vector< std::string > *customValues=nullptr)
 
virtual PlusStatus UpdateImportanceMask () override
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusVolumeReconstructorNew ()
 
static vtkPlusVolumeReconstructorSafeDownCast (vtkObject *o)
 
static PlusStatus SaveReconstructedVolumeToFile (vtkImageData *volumeToSave, const std::string &filename, bool useCompression=true, std::vector< std::string > *customFields=nullptr, std::vector< std::string > *customValues=nullptr)
 
static PlusStatus SaveReconstructedVolumeToMetafile (vtkImageData *volumeToSave, const std::string &filename, bool useCompression=true, std::vector< std::string > *customFields=nullptr, std::vector< std::string > *customValues=nullptr)
 

Protected Member Functions

 vtkPlusVolumeReconstructor ()
 
virtual ~vtkPlusVolumeReconstructor ()
 

Detailed Description

Reconstructs a volume from tracked frames.

This is a convenience class for inserting tracked frames into a volume using the vtkPlusPasteSliceIntoVolume algorithm. It reads/writes reconstruction parameters and the calibration matrix from configuration XML data element and can also compute the size of the output volume that can contain all the frames.

Coordinate systems to be used in this class: Image: Coordinate system aligned to the frame. Unit: pixels. Origin: the first pixel in the image pixel array as stored in memory. Not cropped to US content of the image. Tool: Unit: mm. Origin: origin of the sensor/DRB mounted on the tracked tool (probe). Tracker: Unit: mm. Origin: origin of the tracker device (usually camera or EM transmitter). Reference: Unit: mm. Origin: origin of the sensor/DRB mounted on the reference tool (DRB fixed to the imaged object)

If no reference DRB is used then use Identity ReferenceToTracker transforms, and so Reference will be the same as Tracker. So we can still refer to the output system as Reference.

See also
vtkPlusPasteSliceIntoVolume

Definition at line 42 of file vtkPlusVolumeReconstructor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkIGSIOVolumeReconstructor vtkPlusVolumeReconstructor::Superclass

Definition at line 47 of file vtkPlusVolumeReconstructor.h.

Constructor & Destructor Documentation

◆ vtkPlusVolumeReconstructor()

vtkPlusVolumeReconstructor::vtkPlusVolumeReconstructor ( )
protected

Definition at line 20 of file vtkPlusVolumeReconstructor.cxx.

◆ ~vtkPlusVolumeReconstructor()

vtkPlusVolumeReconstructor::~vtkPlusVolumeReconstructor ( )
protectedvirtual

Definition at line 25 of file vtkPlusVolumeReconstructor.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusVolumeReconstructor::GetClassName ( )
virtual

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkPlusVolumeReconstructor* vtkPlusVolumeReconstructor::New ( )
static

◆ PrintSelf()

void vtkPlusVolumeReconstructor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Definition at line 30 of file vtkPlusVolumeReconstructor.cxx.

◆ SafeDownCast()

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

◆ SaveReconstructedVolumeToFile() [1/3]

igsioStatus vtkPlusVolumeReconstructor::SaveReconstructedVolumeToFile ( const std::string &  filename,
bool  accumulation = false,
bool  useCompression = true 
)
overridevirtual

Save reconstructed volume to file

Parameters
filenamePath and filename of the output file \accumulation True if accumulation buffer needs to be saved, false if gray levels (default) \useCompression True if compression is turned on (default), false otherwise \customFields List of custom header fields to insert into the output file \customValues List of custom header values corresponding to customFields to insert into the output file

Definition at line 36 of file vtkPlusVolumeReconstructor.cxx.

◆ SaveReconstructedVolumeToFile() [2/3]

igsioStatus vtkPlusVolumeReconstructor::SaveReconstructedVolumeToFile ( const std::string &  filename,
bool  accumulation = false,
bool  useCompression = true,
std::vector< std::string > *  customFields = nullptr,
std::vector< std::string > *  customValues = nullptr 
)
virtual

Definition at line 42 of file vtkPlusVolumeReconstructor.cxx.

◆ SaveReconstructedVolumeToFile() [3/3]

PlusStatus vtkPlusVolumeReconstructor::SaveReconstructedVolumeToFile ( vtkImageData *  volumeToSave,
const std::string &  filename,
bool  useCompression = true,
std::vector< std::string > *  customFields = nullptr,
std::vector< std::string > *  customValues = nullptr 
)
static

Save reconstructed volume to file

Parameters
volumeToSaveReconstructed volume to be saved
filenamePath and filename of the output file \useCompression True if compression is turned on (default), false otherwise \customFields List of custom header fields to insert into the output file \customValues List of custom header values corresponding to customFields to insert into the output file

Definition at line 65 of file vtkPlusVolumeReconstructor.cxx.

◆ SaveReconstructedVolumeToMetafile() [1/2]

virtual PlusStatus vtkPlusVolumeReconstructor::SaveReconstructedVolumeToMetafile ( const std::string &  filename,
bool  accumulation = false,
bool  useCompression = true,
std::vector< std::string > *  customFields = nullptr,
std::vector< std::string > *  customValues = nullptr 
)
inlinevirtual

Definition at line 62 of file vtkPlusVolumeReconstructor.h.

◆ SaveReconstructedVolumeToMetafile() [2/2]

static PlusStatus vtkPlusVolumeReconstructor::SaveReconstructedVolumeToMetafile ( vtkImageData *  volumeToSave,
const std::string &  filename,
bool  useCompression = true,
std::vector< std::string > *  customFields = nullptr,
std::vector< std::string > *  customValues = nullptr 
)
inlinestatic

Definition at line 73 of file vtkPlusVolumeReconstructor.h.

◆ UpdateImportanceMask()

PlusStatus vtkPlusVolumeReconstructor::UpdateImportanceMask ( )
overridevirtual

Definition at line 103 of file vtkPlusVolumeReconstructor.cxx.


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