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
vtkPlusVirtualCapture Class Reference
DataCollection

#include <src/PlusDataCollection/VirtualDevices/vtkPlusVirtualCapture.h>

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

Public Types

typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

virtual PlusStatus CloseFile (const char *aFilename=NULL, std::string *resultFilename=NULL)
 
virtual double GetActualFrameRate ()
 
virtual std::string GetBaseFilename ()
 
virtual const char * GetClassName ()
 
virtual vtkPlusDataCollector * GetDataCollector ()
 
virtual bool GetEnableCapturing ()
 
virtual bool GetEnableCapturingOnStart ()
 
virtual bool GetEnableFileCompression ()
 
virtual unsigned int GetFrameBufferSize ()
 
virtual bool GetIsData3D ()
 
virtual std::string GetOutputFileName ()
 
virtual double GetRequestedFrameRate ()
 
virtual long int GetTotalFramesRecorded ()
 
virtual bool HasUnsavedData () const
 
virtual PlusStatus InternalUpdate ()
 
virtual void InternalWriteOutputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual int IsA (const char *type)
 
virtual bool IsTracker () const
 
virtual bool IsVirtual () const
 
virtual PlusStatus NotifyConfigured ()
 
virtual PlusStatus OpenFile (const char *aFilename=NULL)
 
virtual int OutputChannelCount () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *)
 
virtual PlusStatus Reset ()
 
virtual void SetBaseFilename (std::string)
 
virtual PlusStatus SetCustomHeaderField (const std::string &fieldName, const std::string &fieldValue)
 
void SetEnableCapturing (bool aValue)
 
void SetEnableFileCompression (bool aFileCompression)
 
virtual void SetFrameBufferSize (unsigned int)
 
virtual void SetRequestedFrameRate (double)
 
virtual PlusStatus TakeSnapshot ()
 
 vtkGetStdStringMacro (EncodingFourCC)
 
 vtkSetStdStringMacro (EncodingFourCC) virtual void SetEnableCapturingOnStart(bool)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *)
 
- Public Member Functions inherited from vtkPlusDevice
PlusStatus AddFieldDataSource (vtkPlusDataSource *aSource)
 
PlusStatus AddInputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddOutputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddTool (vtkPlusDataSource *tool, bool requireUniquePortName=true)
 
PlusStatus AddVideoSource (vtkPlusDataSource *anImage)
 
void ClearAllBuffers ()
 
virtual PlusStatus Connect ()
 
virtual PlusStatus CreateDefaultOutputChannel (const char *channelId=NULL, bool addSource=true)
 
void DeepCopy (const vtkPlusDevice &device)
 
virtual PlusStatus Disconnect ()
 
virtual PlusStatus ForceUpdate ()
 
virtual double GetAcquisitionRate () const
 
virtual PlusStatus GetBufferSize (vtkPlusChannel &aChannel, int &outVal, const std::string &aSourceId=std::string(""))
 
virtual int GetConnected () const
 
virtual bool GetCorrectlyConfigured () const
 
PlusStatus GetDataSource (const char *aSourceId, vtkPlusDataSource *&aSource)
 
PlusStatus GetDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource)
 
virtual double GetDesiredTimestamp ()
 
virtual std::string GetDeviceId () const
 
PlusStatus GetFieldDataSource (const char *aSourceId, vtkPlusDataSource *&aSource) const
 
PlusStatus GetFieldDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource) const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorBegin () const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorEnd () const
 
PlusStatus GetFirstActiveOutputVideoSource (vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetFirstActiveTool (vtkPlusDataSource *&aTool) const
 
PlusStatus GetFirstOutputChannel (vtkPlusChannel *&aChannel)
 
PlusStatus GetFirstVideoSource (vtkPlusDataSource *&anImage)
 
virtual unsigned long GetFrameNumber () const
 
virtual double GetFrameTimeStamp () const
 
virtual PlusStatus GetImage (const std::string &requestedImageId, std::string &assignedImageId, const std::string &imageReferencFrameName, vtkImageData *imageData, vtkMatrix4x4 *ijkToReferenceTransform)
 
virtual PlusStatus GetImageMetaData (igsioCommon::ImageMetaDataList &imageMetaDataItems)
 
virtual US_IMAGE_TYPE GetImageType (vtkPlusChannel &aChannel)
 
PlusStatus GetInputDevices (std::vector< vtkPlusDevice * > &outDeviceList) const
 
PlusStatus GetInputDevicesRecursive (std::vector< vtkPlusDevice * > &outDeviceList) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
double GetInternalUpdateRate () const
 
virtual double GetLocalTimeOffsetSec () const
 
double GetMissingInputGracePeriodSec () const
 
virtual int GetNumberOfFieldDataSources () const
 
virtual int GetNumberOfTools () const
 
virtual int GetNumberOfVideoSources () const
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const char *aChannelId)
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const std::string &aChannelId)
 
ChannelContainerConstIterator GetOutputChannelsEnd () const
 
ChannelContainerIterator GetOutputChannelsEnd ()
 
ChannelContainerConstIterator GetOutputChannelsStart () const
 
ChannelContainerIterator GetOutputChannelsStart ()
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
virtual std::string GetParameter (const std::string &key) const
 
virtual PlusStatus GetParameter (const std::string &key, std::string &outValue) const
 
virtual igsioCommon::VTKScalarPixelType GetPixelType (vtkPlusChannel &aChannel)
 
virtual std::string GetSdkVersion ()
 
virtual double GetStartTime ()
 
virtual double GetTimestampClosestToDesired ()
 
PlusStatus GetTool (const char *aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetTool (const std::string &aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetToolByPortName (const char *aPortName, vtkPlusDataSource *&aSource)
 
PlusStatus GetToolByPortName (const std::string &aPortName, vtkPlusDataSource *&aSource)
 
DataSourceContainerConstIterator GetToolIteratorBegin () const
 
DataSourceContainerConstIterator GetToolIteratorEnd () const
 
std::string GetToolReferenceFrameName () const
 
virtual int GetUpdateWithDesiredTimestamp ()
 
PlusStatus GetVideoSource (const char *aSourceId, vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetVideoSourceByIndex (const unsigned int index, vtkPlusDataSource *&aVideoSource)
 
DataSourceContainerConstIterator GetVideoSourceIteratorBegin () const
 
DataSourceContainerConstIterator GetVideoSourceIteratorEnd () const
 
std::vector< vtkPlusDataSource * > GetVideoSources () const
 
PlusStatus GetVideoSourcesByPortName (const char *aPortName, std::vector< vtkPlusDataSource * > &sources)
 
PlusStatus GetVideoSourcesByPortName (const std::string &aPortName, std::vector< vtkPlusDataSource * > &sources)
 
virtual bool IsConnected () const
 
virtual bool IsRecording () const
 
virtual bool IsResettable ()
 
virtual PlusStatus Probe ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual PlusStatus SendText (const std::string &textToSend, std::string *textReceived=NULL)
 
PlusStatus SetAcquisitionRate (double aRate)
 
virtual PlusStatus SetBufferSize (vtkPlusChannel &aChannel, int FrameBufferSize, const std::string &aSourceId=std::string(""))
 
virtual void SetDataCollector (vtkPlusDataCollector *_arg)
 
virtual void SetDesiredTimestamp (double)
 
void SetDeviceId (const std::string &id)
 
void SetFieldDataSourcesBufferSize (int aBufferSize)
 
virtual PlusStatus SetImageType (vtkPlusChannel &aChannel, US_IMAGE_TYPE imageType)
 
virtual PlusStatus SetInputFrameSize (vtkPlusDataSource &aSource, unsigned int x, unsigned int y, unsigned int z)
 
virtual void SetLocalTimeOffsetSec (double aTimeOffsetSec)
 
virtual void SetMissingInputGracePeriodSec (double)
 
virtual PlusStatus SetParameter (const std::string &key, const std::string &value)
 
virtual PlusStatus SetPixelType (vtkPlusChannel &aChannel, igsioCommon::VTKScalarPixelType pixelType)
 
virtual void SetStartTime (double startTime)
 
void SetToolReferenceFrameName (const std::string &frameName)
 
void SetToolsBufferSize (int aBufferSize)
 
virtual void SetUpdateWithDesiredTimestamp (int)
 
virtual PlusStatus StartRecording ()
 
virtual PlusStatus StopRecording ()
 
virtual void UpdateWithDesiredTimestampOff ()
 
virtual void UpdateWithDesiredTimestampOn ()
 
virtual PlusStatus WriteToolsToSequenceFile (const std::string &filename, bool useCompression=false)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusVirtualCapture * New ()
 
static vtkPlusVirtualCapture * SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusDevice
static PlusStatus GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)
 
static int IsTypeOf (const char *type)
 
static vtkPlusDevice * New ()
 
static vtkPlusDevice * SafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual PlusStatus ClearRecordedFrames ()
 
PlusStatus GetInputTrackedFrame (igsioTrackedFrame &aFrame)
 
PlusStatus GetInputTrackedFrameListSampled (double &lastAlreadyRecordedFrameTimestamp, double &nextFrameToBeRecordedTimestamp, vtkIGSIOTrackedFrameList *recordedFrames, double requestedFramePeriodSec, double maxProcessingTimeSec)
 
PlusStatus GetLatestInputItemTimestamp (double &timestamp)
 
virtual PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
virtual bool IsFrameBuffered () const
 
virtual void SetActualFrameRate (double)
 
virtual void SetIsData3D (bool)
 
 vtkPlusVirtualCapture ()
 
virtual PlusStatus WriteFrames (bool force=false)
 
virtual ~vtkPlusVirtualCapture ()
 
- Protected Member Functions inherited from vtkPlusDevice
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, const igsioVideoFrame &frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, void *imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType &frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
PlusStatus EnsureUniqueDataSourceId (const std::string &aSourceId)
 
vtkXMLDataElement * FindInputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindOutputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindThisDeviceElement (vtkXMLDataElement *rootXMLElement)
 
double GetRecordingStartTime () const
 
bool GetStartThreadForInternalUpdates () const
 
bool HasGracePeriodExpired ()
 
virtual PlusStatus InternalStartRecording ()
 
virtual PlusStatus InternalStopRecording ()
 
virtual void InternalWriteInputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void SetCorrectlyConfigured (bool)
 
virtual void SetRecordingStartTime (double)
 
virtual void SetStartThreadForInternalUpdates (bool)
 
virtual PlusStatus ToolTimeStampedUpdate (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, unsigned long frameNumber, double unfilteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus ToolTimeStampedUpdateWithoutFiltering (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, double unfilteredtimestamp, double filteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
 vtkPlusDevice ()
 
virtual ~vtkPlusDevice ()
 

Protected Attributes

double ActualFrameRate
 
std::string BaseFilename
 
std::string CurrentFilename
 
bool EnableCapturing
 
bool EnableCapturingOnStart
 
bool EnableFileCompression
 
std::string EncodingFourCC
 
int FirstFrameIndexInThisSegment
 
unsigned int FrameBufferSize
 
vtkPlusLogger::LogLevelType GracePeriodLogLevel
 
bool IsData3D
 
bool IsHeaderPrepared
 
double LastAlreadyRecordedFrameTimestamp
 
double LastUpdateTime
 
double NextFrameToBeRecordedTimestamp
 
vtkIGSIOTrackedFrameList * RecordedFrames
 
double RequestedFrameRate
 
double TimeWaited
 
long int TotalFramesRecorded
 
vtkIGSIOSequenceIOBase * Writer
 
vtkSmartPointer< vtkIGSIORecursiveCriticalSection > WriterAccessMutex
 
- Protected Attributes inherited from vtkPlusDevice
double AcquisitionRate
 
int Connected
 
bool CorrectlyConfigured
 
StreamBufferItem * CurrentStreamBufferItem
 
vtkPlusDataCollector * DataCollector
 
double DesiredTimestamp
 
std::string DeviceId
 
DataSourceContainer Fields
 
unsigned long FrameNumber
 
double FrameTimeStamp
 
ChannelContainer InputChannels
 
double LocalTimeOffsetSec
 
double MissingInputGracePeriodSec
 
ChannelContainer OutputChannels
 
int OutputNeedsInitialization
 
std::map< std::string, std::string > Parameters
 
int Recording
 
double RecordingStartTime
 
std::set< std::string > ReportedUnknownTools
 
bool RequireImageOrientationInConfiguration
 
bool RequirePortNameInDeviceSetConfiguration
 
bool StartThreadForInternalUpdates
 
bool ThreadAlive
 
vtkMultiThreader * Threader
 
int ThreadId
 
double TimestampClosestToDesired
 
std::string ToolReferenceFrameName
 
DataSourceContainer Tools
 
int UpdateWithDesiredTimestamp
 
DataSourceContainer VideoSources
 

Additional Inherited Members

- Public Attributes inherited from vtkPlusDevice
double InternalUpdateRate
 
vtkIGSIORecursiveCriticalSection * UpdateMutex
 
vtkTimeStamp UpdateTime
 
- Static Public Attributes inherited from vtkPlusDevice
static const std::string BMODE_PORT_NAME = "B"
 
static const std::string PARAMETER_XML_ELEMENT_TAG = "Parameter"
 
static const std::string PARAMETERS_XML_ELEMENT_TAG = "Parameters"
 
static const std::string RFMODE_PORT_NAME = "Rf"
 
- Static Protected Member Functions inherited from vtkPlusDevice
static void * vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data)
 
- Static Protected Attributes inherited from vtkPlusDevice
static const int VIRTUAL_DEVICE_FRAME_RATE = 50
 

Detailed Description

Definition at line 23 of file vtkPlusVirtualCapture.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusVirtualCapture::Superclass

Definition at line 27 of file vtkPlusVirtualCapture.h.

Constructor & Destructor Documentation

◆ vtkPlusVirtualCapture()

vtkPlusVirtualCapture::vtkPlusVirtualCapture ( )
protected

Definition at line 36 of file vtkPlusVirtualCapture.cxx.

◆ ~vtkPlusVirtualCapture()

vtkPlusVirtualCapture::~vtkPlusVirtualCapture ( )
protectedvirtual

Definition at line 69 of file vtkPlusVirtualCapture.cxx.

Member Function Documentation

◆ ClearRecordedFrames()

PlusStatus vtkPlusVirtualCapture::ClearRecordedFrames ( )
protectedvirtual

Definition at line 457 of file vtkPlusVirtualCapture.cxx.

◆ CloseFile()

PlusStatus vtkPlusVirtualCapture::CloseFile ( const char *  aFilename = NULL,
std::string *  resultFilename = NULL 
)
virtual

Close the output file. resultFilename contains the full path of the actual written file name. It may be different than the requested name if the requested name was not valid (for example wrong extension).

Definition at line 223 of file vtkPlusVirtualCapture.cxx.

◆ GetActualFrameRate()

virtual double vtkPlusVirtualCapture::GetActualFrameRate ( )
virtual

◆ GetBaseFilename()

virtual std::string vtkPlusVirtualCapture::GetBaseFilename ( )
virtual

◆ GetClassName()

virtual const char* vtkPlusVirtualCapture::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

◆ GetDataCollector()

virtual vtkPlusDataCollector* vtkPlusVirtualCapture::GetDataCollector ( )
inlinevirtual

Reimplemented from vtkPlusDevice.

Definition at line 92 of file vtkPlusVirtualCapture.h.

◆ GetEnableCapturing()

virtual bool vtkPlusVirtualCapture::GetEnableCapturing ( )
virtual

Enables capturing frames. It can be used for pausing the recording.

◆ GetEnableCapturingOnStart()

virtual bool vtkPlusVirtualCapture::GetEnableCapturingOnStart ( )
virtual

◆ GetEnableFileCompression()

virtual bool vtkPlusVirtualCapture::GetEnableFileCompression ( )
virtual

◆ GetFrameBufferSize()

virtual unsigned int vtkPlusVirtualCapture::GetFrameBufferSize ( )
virtual

◆ GetInputTrackedFrame()

PlusStatus vtkPlusVirtualCapture::GetInputTrackedFrame ( igsioTrackedFrame &  aFrame)
protected

Definition at line 656 of file vtkPlusVirtualCapture.cxx.

◆ GetInputTrackedFrameListSampled()

PlusStatus vtkPlusVirtualCapture::GetInputTrackedFrameListSampled ( double &  lastAlreadyRecordedFrameTimestamp,
double &  nextFrameToBeRecordedTimestamp,
vtkIGSIOTrackedFrameList *  recordedFrames,
double  requestedFramePeriodSec,
double  maxProcessingTimeSec 
)
protected

Definition at line 668 of file vtkPlusVirtualCapture.cxx.

◆ GetIsData3D()

virtual bool vtkPlusVirtualCapture::GetIsData3D ( )
virtual

◆ GetLatestInputItemTimestamp()

PlusStatus vtkPlusVirtualCapture::GetLatestInputItemTimestamp ( double &  timestamp)
protected

Definition at line 680 of file vtkPlusVirtualCapture.cxx.

◆ GetOutputFileName()

virtual std::string vtkPlusVirtualCapture::GetOutputFileName ( )
inlinevirtual

Definition at line 97 of file vtkPlusVirtualCapture.h.

◆ GetRequestedFrameRate()

virtual double vtkPlusVirtualCapture::GetRequestedFrameRate ( )
virtual

◆ GetTotalFramesRecorded()

virtual long int vtkPlusVirtualCapture::GetTotalFramesRecorded ( )
virtual

◆ HasUnsavedData()

bool vtkPlusVirtualCapture::HasUnsavedData ( ) const
virtual

Definition at line 451 of file vtkPlusVirtualCapture.cxx.

◆ InternalConnect()

PlusStatus vtkPlusVirtualCapture::InternalConnect ( )
protectedvirtual

Should be overridden to connect to the hardware

Reimplemented from vtkPlusDevice.

Definition at line 130 of file vtkPlusVirtualCapture.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusVirtualCapture::InternalDisconnect ( )
protectedvirtual

Release the video driver. Should be overridden to disconnect from the hardware.

Reimplemented from vtkPlusDevice.

Definition at line 148 of file vtkPlusVirtualCapture.cxx.

◆ InternalUpdate()

PlusStatus vtkPlusVirtualCapture::InternalUpdate ( )
virtual

The subclass will do all the hardware-specific update stuff in this function. It should call ToolUpdate() for each tool. Note that vtkPlusDevice.cxx starts up a separate thread after InternalStartRecording() is called, and that InternalUpdate() is called repeatedly from within that thread. Therefore, any code within InternalUpdate() must be thread safe. You can temporarily pause the thread by locking this->UpdateMutex->Lock() e.g. if you need to communicate with the device from outside of InternalUpdate(). A call to this->UpdateMutex->Unlock() will resume the thread.

Reimplemented from vtkPlusDevice.

Definition at line 279 of file vtkPlusVirtualCapture.cxx.

◆ InternalWriteOutputChannels()

void vtkPlusVirtualCapture::InternalWriteOutputChannels ( vtkXMLDataElement *  rootXMLElement)
virtual

Method that writes output streams to XML

Reimplemented from vtkPlusDevice.

Definition at line 465 of file vtkPlusVirtualCapture.cxx.

◆ IsA()

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

Reimplemented from vtkPlusDevice.

◆ IsFrameBuffered()

bool vtkPlusVirtualCapture::IsFrameBuffered ( ) const
protectedvirtual

Definition at line 528 of file vtkPlusVirtualCapture.cxx.

◆ IsTracker()

virtual bool vtkPlusVirtualCapture::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 94 of file vtkPlusVirtualCapture.h.

◆ IsTypeOf()

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

◆ IsVirtual()

virtual bool vtkPlusVirtualCapture::IsVirtual ( ) const
inlinevirtual

Reimplemented from vtkPlusDevice.

Definition at line 95 of file vtkPlusVirtualCapture.h.

◆ New()

static vtkPlusVirtualCapture* vtkPlusVirtualCapture::New ( )
static

◆ NotifyConfigured()

PlusStatus vtkPlusVirtualCapture::NotifyConfigured ( )
virtual

Perform any completion tasks once configured

Reimplemented from vtkPlusDevice.

Definition at line 422 of file vtkPlusVirtualCapture.cxx.

◆ OpenFile()

PlusStatus vtkPlusVirtualCapture::OpenFile ( const char *  aFilename = NULL)
virtual

Open the output file for writing

Definition at line 175 of file vtkPlusVirtualCapture.cxx.

◆ OutputChannelCount()

int vtkPlusVirtualCapture::OutputChannelCount ( ) const
virtual

Reimplemented from vtkPlusDevice.

Definition at line 648 of file vtkPlusVirtualCapture.cxx.

◆ PrintSelf()

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

Reimplemented from vtkPlusDevice.

Definition at line 90 of file vtkPlusVirtualCapture.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusVirtualCapture::ReadConfiguration ( vtkXMLDataElement *  rootConfigElement)
virtual

Read main configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 96 of file vtkPlusVirtualCapture.cxx.

◆ Reset()

PlusStatus vtkPlusVirtualCapture::Reset ( )
virtual

Reset the device. The actual reset action is defined in subclasses. A reset is typically performed on the users request while the device is connected. A reset can be used for zeroing sensors, canceling an operation in progress, etc.

Reimplemented from vtkPlusDevice.

Definition at line 498 of file vtkPlusVirtualCapture.cxx.

◆ SafeDownCast()

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

◆ SetActualFrameRate()

virtual void vtkPlusVirtualCapture::SetActualFrameRate ( double  )
protectedvirtual

◆ SetBaseFilename()

virtual void vtkPlusVirtualCapture::SetBaseFilename ( std::string  )
virtual

◆ SetCustomHeaderField()

PlusStatus vtkPlusVirtualCapture::SetCustomHeaderField ( const std::string &  fieldName,
const std::string &  fieldValue 
)
virtual

Definition at line 599 of file vtkPlusVirtualCapture.cxx.

◆ SetEnableCapturing()

void vtkPlusVirtualCapture::SetEnableCapturing ( bool  aValue)

Definition at line 482 of file vtkPlusVirtualCapture.cxx.

◆ SetEnableFileCompression()

void vtkPlusVirtualCapture::SetEnableFileCompression ( bool  aFileCompression)

Definition at line 471 of file vtkPlusVirtualCapture.cxx.

◆ SetFrameBufferSize()

virtual void vtkPlusVirtualCapture::SetFrameBufferSize ( unsigned int  )
virtual

◆ SetIsData3D()

virtual void vtkPlusVirtualCapture::SetIsData3D ( bool  )
protectedvirtual

◆ SetRequestedFrameRate()

virtual void vtkPlusVirtualCapture::SetRequestedFrameRate ( double  )
virtual

◆ TakeSnapshot()

PlusStatus vtkPlusVirtualCapture::TakeSnapshot ( )
virtual

Definition at line 534 of file vtkPlusVirtualCapture.cxx.

◆ vtkGetStdStringMacro()

vtkPlusVirtualCapture::vtkGetStdStringMacro ( EncodingFourCC  )

◆ vtkSetStdStringMacro()

vtkPlusVirtualCapture::vtkSetStdStringMacro ( EncodingFourCC  )

◆ WriteConfiguration()

PlusStatus vtkPlusVirtualCapture::WriteConfiguration ( vtkXMLDataElement *  rootConfig)
virtual

write main configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 117 of file vtkPlusVirtualCapture.cxx.

◆ WriteFrames()

PlusStatus vtkPlusVirtualCapture::WriteFrames ( bool  force = false)
protectedvirtual

Copy frames to memory buffer or disk. If force flag is true then data is written to disk immediately.

Definition at line 605 of file vtkPlusVirtualCapture.cxx.

Member Data Documentation

◆ ActualFrameRate

double vtkPlusVirtualCapture::ActualFrameRate
protected

Actual frame rate (frames per second)

Definition at line 137 of file vtkPlusVirtualCapture.h.

◆ BaseFilename

std::string vtkPlusVirtualCapture::BaseFilename
protected

Definition at line 153 of file vtkPlusVirtualCapture.h.

◆ CurrentFilename

std::string vtkPlusVirtualCapture::CurrentFilename
protected

File to write

Definition at line 152 of file vtkPlusVirtualCapture.h.

◆ EnableCapturing

bool vtkPlusVirtualCapture::EnableCapturing
protected

Internal flag to control capturing

Definition at line 174 of file vtkPlusVirtualCapture.h.

◆ EnableCapturingOnStart

bool vtkPlusVirtualCapture::EnableCapturingOnStart
protected

Whether to start capturing on connect

Definition at line 171 of file vtkPlusVirtualCapture.h.

◆ EnableFileCompression

bool vtkPlusVirtualCapture::EnableFileCompression
protected

When closing the file, re-read the data from file, and write it compressed

Definition at line 159 of file vtkPlusVirtualCapture.h.

◆ EncodingFourCC

std::string vtkPlusVirtualCapture::EncodingFourCC
protected

FourCC code represending the codec to use when writing the file

Definition at line 162 of file vtkPlusVirtualCapture.h.

◆ FirstFrameIndexInThisSegment

int vtkPlusVirtualCapture::FirstFrameIndexInThisSegment
protected

Frame index of the first frame that is recorded in this segment (since pressed the record button). It is used when estimating the actual frame rate: frames that are acquired before this frame index (i.e., those that were acquired in a different recording segment) will not be taken into account in the actual frame rate computation.

Definition at line 145 of file vtkPlusVirtualCapture.h.

◆ FrameBufferSize

unsigned int vtkPlusVirtualCapture::FrameBufferSize
protected

Definition at line 176 of file vtkPlusVirtualCapture.h.

◆ GracePeriodLogLevel

vtkPlusLogger::LogLevelType vtkPlusVirtualCapture::GracePeriodLogLevel
protected

Definition at line 183 of file vtkPlusVirtualCapture.h.

◆ IsData3D

bool vtkPlusVirtualCapture::IsData3D
protected

Definition at line 178 of file vtkPlusVirtualCapture.h.

◆ IsHeaderPrepared

bool vtkPlusVirtualCapture::IsHeaderPrepared
protected

Preparing the header requires image data already collected, this flag makes the header preparation wait until valid data is collected

Definition at line 165 of file vtkPlusVirtualCapture.h.

◆ LastAlreadyRecordedFrameTimestamp

double vtkPlusVirtualCapture::LastAlreadyRecordedFrameTimestamp
protected

Timestamp of last recorded frame (only frames that have more recent timestamp will be added)

Definition at line 124 of file vtkPlusVirtualCapture.h.

◆ LastUpdateTime

double vtkPlusVirtualCapture::LastUpdateTime
protected

Definition at line 149 of file vtkPlusVirtualCapture.h.

◆ NextFrameToBeRecordedTimestamp

double vtkPlusVirtualCapture::NextFrameToBeRecordedTimestamp
protected

Desired timestamp of the next frame to be recorded

Definition at line 127 of file vtkPlusVirtualCapture.h.

◆ RecordedFrames

vtkIGSIOTrackedFrameList* vtkPlusVirtualCapture::RecordedFrames
protected

Recorded tracked frame list

Definition at line 121 of file vtkPlusVirtualCapture.h.

◆ RequestedFrameRate

double vtkPlusVirtualCapture::RequestedFrameRate
protected

Requested frame rate (frames per second) If the input data source provides data at a higher rate then frames will be skipped. If the input data has lower frame rate then requested then all the frames in the input data will be recorded.

Definition at line 134 of file vtkPlusVirtualCapture.h.

◆ TimeWaited

double vtkPlusVirtualCapture::TimeWaited
protected

Definition at line 148 of file vtkPlusVirtualCapture.h.

◆ TotalFramesRecorded

long int vtkPlusVirtualCapture::TotalFramesRecorded
protected

Record the number of frames captured

Definition at line 168 of file vtkPlusVirtualCapture.h.

◆ Writer

vtkIGSIOSequenceIOBase* vtkPlusVirtualCapture::Writer
protected

Sequence writer to write to

Definition at line 156 of file vtkPlusVirtualCapture.h.

◆ WriterAccessMutex

vtkSmartPointer<vtkIGSIORecursiveCriticalSection> vtkPlusVirtualCapture::WriterAccessMutex
protected

Mutex instance simultaneous access of writer (writer may be accessed from command processing thread and also the internal update thread)

Definition at line 181 of file vtkPlusVirtualCapture.h.

The documentation for this class was generated from the following files:
Generated on Sat Oct 25 2025 01:04:05 for PlusLib by   doxygen 1.8.15