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/vtkPlusClariusCommand.h>
Public Types | |
| typedef vtkPlusCommand | Superclass |
Public Member Functions | |
| virtual vtkPlusCommand * | Clone () |
| virtual void | CompressRawDataOff () |
| virtual void | CompressRawDataOn () |
| virtual PlusStatus | Execute () |
| virtual const char * | GetClassName () |
| virtual void | GetCommandNames (std::list< std::string > &cmdNames) |
| virtual bool | GetCompressRawData () |
| virtual std::string | GetDescription (const std::string &commandName) |
| virtual double | GetRawDataLastNSeconds () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual PlusStatus | ReadConfiguration (vtkXMLDataElement *aConfig) |
| virtual void | SetCompressRawData (bool) |
| void | SetNameToSaveRawData () |
| virtual void | SetRawDataLastNSeconds (double) |
| vtkGetStdStringMacro (ClariusDeviceId) | |
| vtkGetStdStringMacro (OutputFilename) | |
| vtkSetStdStringMacro (ClariusDeviceId) | |
| vtkSetStdStringMacro (OutputFilename) | |
| 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 vtkPlusClariusCommand * | New () |
| static vtkPlusClariusCommand * | SafeDownCast (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 | |
| vtkPlusClarius * | GetClariusDevice () |
| vtkPlusClariusCommand () | |
| virtual | ~vtkPlusClariusCommand () |
| Protected Member Functions inherited from vtkPlusCommand | |
| virtual vtkPlusDataCollector * | GetDataCollector () |
| 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 | |
| std::string | ClariusDeviceId |
| bool | CompressRawData |
| std::string | OutputFilename |
| double | RawDataLastNSeconds |
| Protected Attributes inherited from vtkPlusCommand | |
| int | ClientId |
| vtkPlusCommandProcessor * | CommandProcessor |
| 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 22 of file vtkPlusClariusCommand.h.
Member Typedef Documentation
◆ Superclass
Definition at line 26 of file vtkPlusClariusCommand.h.
Constructor & Destructor Documentation
◆ vtkPlusClariusCommand()
|
protected |
Definition at line 29 of file vtkPlusClariusCommand.cxx.
◆ ~vtkPlusClariusCommand()
|
protectedvirtual |
Definition at line 36 of file vtkPlusClariusCommand.cxx.
Member Function Documentation
◆ Clone()
|
inlinevirtual |
Implements vtkPlusCommand.
Definition at line 28 of file vtkPlusClariusCommand.h.
◆ CompressRawDataOff()
|
virtual |
◆ CompressRawDataOn()
|
virtual |
◆ Execute()
|
virtual |
Executes the command
Implements vtkPlusCommand.
Definition at line 105 of file vtkPlusClariusCommand.cxx.
◆ GetClariusDevice()
|
protected |
Definition at line 143 of file vtkPlusClariusCommand.cxx.
◆ GetClassName()
|
virtual |
◆ GetCommandNames()
|
virtual |
Get all the command names that this class can execute
Implements vtkPlusCommand.
Definition at line 47 of file vtkPlusClariusCommand.cxx.
◆ GetCompressRawData()
|
virtual |
Compress raw data using gzip if enabled
◆ GetDescription()
|
virtual |
Gets the description for the specified command name.
Implements vtkPlusCommand.
Definition at line 54 of file vtkPlusClariusCommand.cxx.
◆ GetRawDataLastNSeconds()
|
virtual |
The number of seconds of raw data to retrieve
◆ IsA()
|
virtual |
◆ IsTypeOf()
|
static |
◆ New()
|
static |
◆ PrintSelf()
|
virtual |
Reimplemented from vtkPlusCommand.
Definition at line 41 of file vtkPlusClariusCommand.cxx.
◆ ReadConfiguration()
|
virtual |
Read command parameters from XML
Reimplemented from vtkPlusCommand.
Definition at line 72 of file vtkPlusClariusCommand.cxx.
◆ SafeDownCast()
|
static |
◆ SetCompressRawData()
|
virtual |
◆ SetNameToSaveRawData()
| void vtkPlusClariusCommand::SetNameToSaveRawData | ( | ) |
Set the command to get the raw data from the clarius See: https://support.clarius.com/hc/en-us/articles/360019787932-Raw-Data-Collection
Definition at line 66 of file vtkPlusClariusCommand.cxx.
◆ SetRawDataLastNSeconds()
|
virtual |
◆ vtkGetStdStringMacro() [1/2]
| vtkPlusClariusCommand::vtkGetStdStringMacro | ( | ClariusDeviceId | ) |
Id of the Clarius device
◆ vtkGetStdStringMacro() [2/2]
| vtkPlusClariusCommand::vtkGetStdStringMacro | ( | OutputFilename | ) |
Output filename of the raw Clarius data Should be a .tar file
◆ vtkSetStdStringMacro() [1/2]
| vtkPlusClariusCommand::vtkSetStdStringMacro | ( | ClariusDeviceId | ) |
◆ vtkSetStdStringMacro() [2/2]
| vtkPlusClariusCommand::vtkSetStdStringMacro | ( | OutputFilename | ) |
◆ WriteConfiguration()
|
virtual |
Write command parameters to XML
Reimplemented from vtkPlusCommand.
Definition at line 88 of file vtkPlusClariusCommand.cxx.
Member Data Documentation
◆ ClariusDeviceId
|
protected |
Definition at line 83 of file vtkPlusClariusCommand.h.
◆ CompressRawData
|
protected |
Definition at line 82 of file vtkPlusClariusCommand.h.
◆ OutputFilename
|
protected |
Definition at line 84 of file vtkPlusClariusCommand.h.
◆ RawDataLastNSeconds
|
protected |
Definition at line 85 of file vtkPlusClariusCommand.h.
The documentation for this class was generated from the following files:
- src/PlusServer/Commands/vtkPlusClariusCommand.h
- src/PlusServer/Commands/vtkPlusClariusCommand.cxx
