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

This command reconstructs a volume from an image sequence and saves it to disk or sends it to the client in an IMAGE message. More...

#include <src/PlusServer/Commands/vtkPlusReconstructVolumeCommand.h>

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

Public Types

typedef vtkPlusCommand Superclass
 

Public Member Functions

virtual vtkPlusCommandClone ()
 
virtual PlusStatus Execute ()
 
virtual bool GetApplyHoleFilling ()
 
virtual const char * GetClassName ()
 
virtual void GetCommandNames (std::list< std::string > &cmdNames)
 
virtual std::string GetDescription (const std::string &commandName)
 
virtual void GetOutputExtent (int [6])
 
virtual intGetOutputExtent ()
 
virtual void GetOutputExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetOutputOrigin (double &, double &, double &)
 
virtual void GetOutputOrigin (double [3])
 
virtual double * GetOutputOrigin ()
 
virtual double * GetOutputSpacing ()
 
virtual void GetOutputSpacing (double &, double &, double &)
 
virtual void GetOutputSpacing (double [3])
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *aConfig)
 
virtual void SetApplyHoleFilling (bool)
 
void SetNameToGetSnapshot ()
 
void SetNameToReconstruct ()
 
void SetNameToResume ()
 
void SetNameToStart ()
 
void SetNameToStop ()
 
void SetNameToSuspend ()
 
virtual void SetOutputExtent (int [6])
 
virtual void SetOutputExtent (int, int, int, int, int, int)
 
virtual void SetOutputOrigin (double, double, double)
 
virtual void SetOutputOrigin (double [3])
 
virtual void SetOutputSpacing (double [3])
 
virtual void SetOutputSpacing (double, double, double)
 
 vtkGetStdStringMacro (InputSeqFilename)
 
 vtkGetStdStringMacro (OutputVolFilename)
 
 vtkGetStdStringMacro (OutputVolDeviceName)
 
 vtkGetStdStringMacro (VolumeReconstructorDeviceId)
 
 vtkSetStdStringMacro (InputSeqFilename)
 
 vtkSetStdStringMacro (OutputVolFilename)
 
 vtkSetStdStringMacro (OutputVolDeviceName)
 
 vtkSetStdStringMacro (VolumeReconstructorDeviceId)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *aConfig)
 
- Public Member Functions inherited from vtkPlusCommand
virtual int GetClientId ()
 
virtual uint32_t GetId ()
 
virtual bool GetRespondWithCommandMessage ()
 
void PopCommandResponses (PlusCommandResponseList &responses)
 
virtual void SetClientId (int)
 
virtual void SetCommandProcessor (vtkPlusCommandProcessor *processor)
 
virtual void SetId (uint32_t)
 
void SetMetaData (const igtl::MessageBase::MetaDataMap &metaData)
 
virtual void SetRespondWithCommandMessage (bool)
 
 vtkGetStdStringMacro (Name)
 
 vtkGetStdStringMacro (DeviceName)
 
 vtkSetStdStringMacro (Name)
 
 vtkSetStdStringMacro (DeviceName)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusReconstructVolumeCommandNew ()
 
static vtkPlusReconstructVolumeCommandSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusCommand
static PlusStatus GenerateCommandDeviceName (const std::string &uid, std::string &outDeviceName)
 
static std::string GenerateReplyDeviceName (uint32_t uid)
 
static std::string GetPrefixFromCommandDeviceName (const std::string &deviceName)
 
static std::string GetUidFromCommandDeviceName (const std::string &deviceName)
 
static bool IsCommandDeviceName (const std::string &deviceName)
 
static bool IsReplyDeviceName (const std::string &deviceName, const std::string &uid=std::string(""))
 

Protected Member Functions

vtkPlusVirtualVolumeReconstructorGetVolumeReconstructorDevice ()
 
void operator= (const vtkPlusReconstructVolumeCommand &)
 
PlusStatus ProcessImageReply (vtkImageData *volumeToSend, const std::string &outputVolFilename, const std::string &outputVolDeviceName, std::string &resultMessage)
 
 vtkPlusReconstructVolumeCommand ()
 
 vtkPlusReconstructVolumeCommand (const vtkPlusReconstructVolumeCommand &)
 
virtual ~vtkPlusReconstructVolumeCommand ()
 
- Protected Member Functions inherited from vtkPlusCommand
virtual vtkPlusDataCollectorGetDataCollector ()
 
virtual vtkIGSIOTransformRepository * GetTransformRepository ()
 
void QueueCommandResponse (PlusStatus status, const std::string &message, const std::string &error="", const igtl::MessageBase::MetaDataMap *metaData=nullptr)
 
PlusStatus ValidateName ()
 
 vtkPlusCommand ()
 
virtual ~vtkPlusCommand ()
 

Protected Attributes

bool ApplyHoleFilling
 
std::string InputSeqFilename
 
int OutputExtent [6]
 
double OutputOrigin [3]
 
double OutputSpacing [3]
 
std::string OutputVolDeviceName
 
std::string OutputVolFilename
 
std::string VolumeReconstructorDeviceId
 
- Protected Attributes inherited from vtkPlusCommand
int ClientId
 
vtkPlusCommandProcessorCommandProcessor
 
PlusCommandResponseList CommandResponseQueue
 
std::string DeviceName
 
uint32_t Id
 
igtl::MessageBase::MetaDataMap MetaData
 
std::string Name
 
bool RespondWithCommandMessage
 

Additional Inherited Members

- Static Public Attributes inherited from vtkPlusCommand
static const std::string DEVICE_NAME_COMMAND = "CMD"
 
static const std::string DEVICE_NAME_REPLY = "ACK"
 

Detailed Description

This command reconstructs a volume from an image sequence and saves it to disk or sends it to the client in an IMAGE message.

Definition at line 23 of file vtkPlusReconstructVolumeCommand.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkPlusReconstructVolumeCommand.h.

Constructor & Destructor Documentation

◆ vtkPlusReconstructVolumeCommand() [1/2]

vtkPlusReconstructVolumeCommand::vtkPlusReconstructVolumeCommand ( )
protected

Definition at line 34 of file vtkPlusReconstructVolumeCommand.cxx.

◆ ~vtkPlusReconstructVolumeCommand()

vtkPlusReconstructVolumeCommand::~vtkPlusReconstructVolumeCommand ( )
protectedvirtual

Definition at line 52 of file vtkPlusReconstructVolumeCommand.cxx.

◆ vtkPlusReconstructVolumeCommand() [2/2]

vtkPlusReconstructVolumeCommand::vtkPlusReconstructVolumeCommand ( const vtkPlusReconstructVolumeCommand )
protected

Member Function Documentation

◆ Clone()

virtual vtkPlusCommand* vtkPlusReconstructVolumeCommand::Clone ( )
inlinevirtual

Implements vtkPlusCommand.

Definition at line 30 of file vtkPlusReconstructVolumeCommand.h.

◆ Execute()

PlusStatus vtkPlusReconstructVolumeCommand::Execute ( )
virtual

Executes the command

Implements vtkPlusCommand.

Definition at line 200 of file vtkPlusReconstructVolumeCommand.cxx.

◆ GetApplyHoleFilling()

virtual bool vtkPlusReconstructVolumeCommand::GetApplyHoleFilling ( )
virtual

◆ GetClassName()

virtual const char* vtkPlusReconstructVolumeCommand::GetClassName ( )
virtual

◆ GetCommandNames()

void vtkPlusReconstructVolumeCommand::GetCommandNames ( std::list< std::string > &  cmdNames)
virtual

Get all the command names that this class can execute

Implements vtkPlusCommand.

Definition at line 89 of file vtkPlusReconstructVolumeCommand.cxx.

◆ GetDescription()

std::string vtkPlusReconstructVolumeCommand::GetDescription ( const std::string &  commandName)
virtual

Gets the description for the specified command name.

Implements vtkPlusCommand.

Definition at line 101 of file vtkPlusReconstructVolumeCommand.cxx.

◆ GetOutputExtent() [1/3]

virtual void vtkPlusReconstructVolumeCommand::GetOutputExtent ( int ,
int ,
int ,
int ,
int ,
int  
)
virtual

◆ GetOutputExtent() [2/3]

virtual void vtkPlusReconstructVolumeCommand::GetOutputExtent ( int  [6])
virtual

◆ GetOutputExtent() [3/3]

virtual int* vtkPlusReconstructVolumeCommand::GetOutputExtent ( )
virtual

Get extent of the output data in Reference coordinate system

◆ GetOutputOrigin() [1/3]

virtual double* vtkPlusReconstructVolumeCommand::GetOutputOrigin ( )
virtual

Get origin of the output data in Reference coordinate system

◆ GetOutputOrigin() [2/3]

virtual void vtkPlusReconstructVolumeCommand::GetOutputOrigin ( double &  ,
double &  ,
double &   
)
virtual

◆ GetOutputOrigin() [3/3]

virtual void vtkPlusReconstructVolumeCommand::GetOutputOrigin ( double  [3])
virtual

◆ GetOutputSpacing() [1/3]

virtual double* vtkPlusReconstructVolumeCommand::GetOutputSpacing ( )
virtual

Get spacing of the output data in Reference coordinate system

◆ GetOutputSpacing() [2/3]

virtual void vtkPlusReconstructVolumeCommand::GetOutputSpacing ( double &  ,
double &  ,
double &   
)
virtual

◆ GetOutputSpacing() [3/3]

virtual void vtkPlusReconstructVolumeCommand::GetOutputSpacing ( double  [3])
virtual

◆ GetVolumeReconstructorDevice()

vtkPlusVirtualVolumeReconstructor * vtkPlusReconstructVolumeCommand::GetVolumeReconstructorDevice ( )
protected

Definition at line 408 of file vtkPlusReconstructVolumeCommand.cxx.

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkPlusReconstructVolumeCommand* vtkPlusReconstructVolumeCommand::New ( )
static

◆ operator=()

void vtkPlusReconstructVolumeCommand::operator= ( const vtkPlusReconstructVolumeCommand )
protected

◆ PrintSelf()

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

Reimplemented from vtkPlusCommand.

Definition at line 83 of file vtkPlusReconstructVolumeCommand.cxx.

◆ ProcessImageReply()

PlusStatus vtkPlusReconstructVolumeCommand::ProcessImageReply ( vtkImageData *  volumeToSend,
const std::string &  outputVolFilename,
const std::string &  outputVolDeviceName,
std::string &  resultMessage 
)
protected

Saves image to disk (if requested) and prepare sending image as a response (if requested)

Definition at line 367 of file vtkPlusReconstructVolumeCommand.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusReconstructVolumeCommand::ReadConfiguration ( vtkXMLDataElement *  aConfig)
virtual

Read command parameters from XML

Reimplemented from vtkPlusCommand.

Definition at line 139 of file vtkPlusReconstructVolumeCommand.cxx.

◆ SafeDownCast()

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

◆ SetApplyHoleFilling()

virtual void vtkPlusReconstructVolumeCommand::SetApplyHoleFilling ( bool  )
virtual

◆ SetNameToGetSnapshot()

void vtkPlusReconstructVolumeCommand::SetNameToGetSnapshot ( )

Definition at line 77 of file vtkPlusReconstructVolumeCommand.cxx.

◆ SetNameToReconstruct()

void vtkPlusReconstructVolumeCommand::SetNameToReconstruct ( )

Definition at line 57 of file vtkPlusReconstructVolumeCommand.cxx.

◆ SetNameToResume()

void vtkPlusReconstructVolumeCommand::SetNameToResume ( )

Definition at line 73 of file vtkPlusReconstructVolumeCommand.cxx.

◆ SetNameToStart()

void vtkPlusReconstructVolumeCommand::SetNameToStart ( )

Definition at line 61 of file vtkPlusReconstructVolumeCommand.cxx.

◆ SetNameToStop()

void vtkPlusReconstructVolumeCommand::SetNameToStop ( )

Definition at line 65 of file vtkPlusReconstructVolumeCommand.cxx.

◆ SetNameToSuspend()

void vtkPlusReconstructVolumeCommand::SetNameToSuspend ( )

Definition at line 69 of file vtkPlusReconstructVolumeCommand.cxx.

◆ SetOutputExtent() [1/2]

virtual void vtkPlusReconstructVolumeCommand::SetOutputExtent ( int  [6])
virtual

◆ SetOutputExtent() [2/2]

virtual void vtkPlusReconstructVolumeCommand::SetOutputExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Set extent of the output data in Reference coordinate system. This is required to be set, otherwise the reconstructed volume will be empty.

◆ SetOutputOrigin() [1/2]

virtual void vtkPlusReconstructVolumeCommand::SetOutputOrigin ( double  ,
double  ,
double   
)
virtual

Set origin of the output data in Reference coordinate system. This is required to be set, otherwise the reconstructed volume will be empty.

◆ SetOutputOrigin() [2/2]

virtual void vtkPlusReconstructVolumeCommand::SetOutputOrigin ( double  [3])
virtual

◆ SetOutputSpacing() [1/2]

virtual void vtkPlusReconstructVolumeCommand::SetOutputSpacing ( double  [3])
virtual

◆ SetOutputSpacing() [2/2]

virtual void vtkPlusReconstructVolumeCommand::SetOutputSpacing ( double  ,
double  ,
double   
)
virtual

Set spacing of the output data in Reference coordinate system. This is required to be set, otherwise the reconstructed volume will be empty.

◆ vtkGetStdStringMacro() [1/4]

vtkPlusReconstructVolumeCommand::vtkGetStdStringMacro ( InputSeqFilename  )

File name of the sequence file that contains the image frames

◆ vtkGetStdStringMacro() [2/4]

vtkPlusReconstructVolumeCommand::vtkGetStdStringMacro ( OutputVolFilename  )

If specified, the reconstructed volume will be saved into this filename

◆ vtkGetStdStringMacro() [3/4]

vtkPlusReconstructVolumeCommand::vtkGetStdStringMacro ( OutputVolDeviceName  )

If specified, the reconstructed volume will sent to the client through OpenIGTLink, using this device name

◆ vtkGetStdStringMacro() [4/4]

vtkPlusReconstructVolumeCommand::vtkGetStdStringMacro ( VolumeReconstructorDeviceId  )

Id of the live reconstruction command to be stopped, suspended, or resumed at the next Execute

◆ vtkSetStdStringMacro() [1/4]

vtkPlusReconstructVolumeCommand::vtkSetStdStringMacro ( InputSeqFilename  )

◆ vtkSetStdStringMacro() [2/4]

vtkPlusReconstructVolumeCommand::vtkSetStdStringMacro ( OutputVolFilename  )

◆ vtkSetStdStringMacro() [3/4]

vtkPlusReconstructVolumeCommand::vtkSetStdStringMacro ( OutputVolDeviceName  )

◆ vtkSetStdStringMacro() [4/4]

vtkPlusReconstructVolumeCommand::vtkSetStdStringMacro ( VolumeReconstructorDeviceId  )

◆ WriteConfiguration()

PlusStatus vtkPlusReconstructVolumeCommand::WriteConfiguration ( vtkXMLDataElement *  aConfig)
virtual

Write command parameters to XML

Reimplemented from vtkPlusCommand.

Definition at line 161 of file vtkPlusReconstructVolumeCommand.cxx.

Member Data Documentation

◆ ApplyHoleFilling

bool vtkPlusReconstructVolumeCommand::ApplyHoleFilling
protected

Definition at line 117 of file vtkPlusReconstructVolumeCommand.h.

◆ InputSeqFilename

std::string vtkPlusReconstructVolumeCommand::InputSeqFilename
protected

Definition at line 107 of file vtkPlusReconstructVolumeCommand.h.

◆ OutputExtent

int vtkPlusReconstructVolumeCommand::OutputExtent[6]
protected

Definition at line 115 of file vtkPlusReconstructVolumeCommand.h.

◆ OutputOrigin

double vtkPlusReconstructVolumeCommand::OutputOrigin[3]
protected

Definition at line 113 of file vtkPlusReconstructVolumeCommand.h.

◆ OutputSpacing

double vtkPlusReconstructVolumeCommand::OutputSpacing[3]
protected

Definition at line 114 of file vtkPlusReconstructVolumeCommand.h.

◆ OutputVolDeviceName

std::string vtkPlusReconstructVolumeCommand::OutputVolDeviceName
protected

Definition at line 109 of file vtkPlusReconstructVolumeCommand.h.

◆ OutputVolFilename

std::string vtkPlusReconstructVolumeCommand::OutputVolFilename
protected

Definition at line 108 of file vtkPlusReconstructVolumeCommand.h.

◆ VolumeReconstructorDeviceId

std::string vtkPlusReconstructVolumeCommand::VolumeReconstructorDeviceId
protected

Definition at line 110 of file vtkPlusReconstructVolumeCommand.h.


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