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

Class for interfacing an Infrared Seek capture device and recording frames into a Plus buffer. More...

#include <src/PlusDataCollection/InfraredSeekCam/vtkInfraredSeekCam.h>

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

Public Types

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

Public Member Functions

PlusStatus FreezeDevice (bool freeze)
 
virtual const char * GetClassName ()
 
PlusStatus InternalUpdate ()
 
virtual int IsA (const char *type)
 
bool IsTracker () const
 
virtual PlusStatus NotifyConfigured ()
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
bool ReadBinaryFile (const std::string &filename, cv::Mat &temp) const
 
PlusStatus ReadConfiguration (vtkXMLDataElement *config)
 
bool ReadImage (cv::Mat &output, const std::string &filename) const
 
PlusStatus WriteConfiguration (vtkXMLDataElement *config)
 
- 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 bool IsVirtual () const
 
virtual int OutputChannelCount () const
 
virtual PlusStatus Probe ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual PlusStatus Reset ()
 
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 vtkInfraredSeekCamNew ()
 
static vtkInfraredSeekCamSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusDevice
static PlusStatus GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)
 
static int IsTypeOf (const char *type)
 
static vtkPlusDeviceNew ()
 
static vtkPlusDeviceSafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual PlusStatus InternalConnect () VTK_OVERRIDE
 
virtual PlusStatus InternalDisconnect () VTK_OVERRIDE
 
 vtkInfraredSeekCam ()
 
 ~vtkInfraredSeekCam ()
 
- 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)
 
virtual vtkPlusDataCollectorGetDataCollector ()
 
double GetRecordingStartTime () const
 
bool GetStartThreadForInternalUpdates () const
 
bool HasGracePeriodExpired ()
 
virtual PlusStatus InternalStartRecording ()
 
virtual PlusStatus InternalStopRecording ()
 
virtual void InternalWriteInputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void InternalWriteOutputChannels (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

cv::Mat Bias
 
float CalibBias
 
float CalibMul
 
bool CalibTemperature
 
std::shared_ptr< LibSeek::SeekThermalPro > Capture
 
bool ExistsBias
 
bool ExistsFlat
 
cv::Mat Flat
 
std::shared_ptr< cv::Mat > Frame
 
cv::Mat FrameFloat
 
cv::Mat FrameInt
 
- Protected Attributes inherited from vtkPlusDevice
double AcquisitionRate
 
int Connected
 
bool CorrectlyConfigured
 
StreamBufferItemCurrentStreamBufferItem
 
vtkPlusDataCollectorDataCollector
 
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

Class for interfacing an Infrared Seek capture device and recording frames into a Plus buffer.

Definition at line 26 of file vtkInfraredSeekCam.h.

Member Typedef Documentation

◆ Superclass

Definition at line 30 of file vtkInfraredSeekCam.h.

Constructor & Destructor Documentation

◆ vtkInfraredSeekCam()

vtkInfraredSeekCam::vtkInfraredSeekCam ( )
protected

Definition at line 24 of file vtkInfraredSeekCam.cxx.

◆ ~vtkInfraredSeekCam()

vtkInfraredSeekCam::~vtkInfraredSeekCam ( )
protected

Definition at line 34 of file vtkInfraredSeekCam.cxx.

Member Function Documentation

◆ FreezeDevice()

PlusStatus vtkInfraredSeekCam::FreezeDevice ( bool  freeze)

Manage device frozen state

Definition at line 106 of file vtkInfraredSeekCam.cxx.

◆ GetClassName()

virtual const char* vtkInfraredSeekCam::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

◆ InternalConnect()

PlusStatus vtkInfraredSeekCam::InternalConnect ( )
protectedvirtual

Should be overridden to connect to the hardware

Reimplemented from vtkPlusDevice.

Definition at line 117 of file vtkInfraredSeekCam.cxx.

◆ InternalDisconnect()

PlusStatus vtkInfraredSeekCam::InternalDisconnect ( )
protectedvirtual

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

Reimplemented from vtkPlusDevice.

Definition at line 133 of file vtkInfraredSeekCam.cxx.

◆ InternalUpdate()

PlusStatus vtkInfraredSeekCam::InternalUpdate ( )
virtual

Get an update from the tracking system and push the new transforms to the tools. This function is called by the tracker thread.

Reimplemented from vtkPlusDevice.

Definition at line 142 of file vtkInfraredSeekCam.cxx.

◆ IsA()

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

Reimplemented from vtkPlusDevice.

◆ IsTracker()

bool vtkInfraredSeekCam::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 42 of file vtkInfraredSeekCam.h.

◆ IsTypeOf()

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

◆ New()

static vtkInfraredSeekCam* vtkInfraredSeekCam::New ( )
static

◆ NotifyConfigured()

PlusStatus vtkInfraredSeekCam::NotifyConfigured ( )
virtual

Verify the device is correctly configured

Reimplemented from vtkPlusDevice.

Definition at line 201 of file vtkInfraredSeekCam.cxx.

◆ PrintSelf()

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

Reimplemented from vtkPlusDevice.

Definition at line 39 of file vtkInfraredSeekCam.cxx.

◆ ReadBinaryFile()

bool vtkInfraredSeekCam::ReadBinaryFile ( const std::string &  filename,
cv::Mat &  temp 
) const

Definition at line 219 of file vtkInfraredSeekCam.cxx.

◆ ReadConfiguration()

PlusStatus vtkInfraredSeekCam::ReadConfiguration ( vtkXMLDataElement *  config)
virtual

Read configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 47 of file vtkInfraredSeekCam.cxx.

◆ ReadImage()

bool vtkInfraredSeekCam::ReadImage ( cv::Mat &  output,
const std::string &  filename 
) const

Definition at line 84 of file vtkInfraredSeekCam.cxx.

◆ SafeDownCast()

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

◆ WriteConfiguration()

PlusStatus vtkInfraredSeekCam::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 99 of file vtkInfraredSeekCam.cxx.

Member Data Documentation

◆ Bias

cv::Mat vtkInfraredSeekCam::Bias
protected

Definition at line 65 of file vtkInfraredSeekCam.h.

◆ CalibBias

float vtkInfraredSeekCam::CalibBias
protected

Definition at line 72 of file vtkInfraredSeekCam.h.

◆ CalibMul

float vtkInfraredSeekCam::CalibMul
protected

Definition at line 71 of file vtkInfraredSeekCam.h.

◆ CalibTemperature

bool vtkInfraredSeekCam::CalibTemperature
protected

Definition at line 70 of file vtkInfraredSeekCam.h.

◆ Capture

std::shared_ptr<LibSeek::SeekThermalPro> vtkInfraredSeekCam::Capture
protected

Definition at line 61 of file vtkInfraredSeekCam.h.

◆ ExistsBias

bool vtkInfraredSeekCam::ExistsBias
protected

Definition at line 69 of file vtkInfraredSeekCam.h.

◆ ExistsFlat

bool vtkInfraredSeekCam::ExistsFlat
protected

Definition at line 68 of file vtkInfraredSeekCam.h.

◆ Flat

cv::Mat vtkInfraredSeekCam::Flat
protected

Definition at line 64 of file vtkInfraredSeekCam.h.

◆ Frame

std::shared_ptr<cv::Mat> vtkInfraredSeekCam::Frame
protected

Definition at line 62 of file vtkInfraredSeekCam.h.

◆ FrameFloat

cv::Mat vtkInfraredSeekCam::FrameFloat
protected

Definition at line 66 of file vtkInfraredSeekCam.h.

◆ FrameInt

cv::Mat vtkInfraredSeekCam::FrameInt
protected

Definition at line 67 of file vtkInfraredSeekCam.h.


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