PlusLib
2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
|
Class for providing video input interfaces between VTK and Epiphan frame grabber device. More...
#include <src/PlusDataCollection/Epiphan/vtkPlusEpiphanVideoSource.h>
Public Types | |
typedef vtkPlusDevice | Superclass |
![]() | |
typedef vtkImageAlgorithm | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
std::array< int, 3 > | GetClipRectangleOrigin () const |
std::array< int, 3 > | GetClipRectangleSize () const |
virtual int | IsA (const char *type) |
virtual bool | IsTracker () const |
virtual PlusStatus | NotifyConfigured () |
virtual void | PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE |
virtual PlusStatus | ReadConfiguration (vtkXMLDataElement *config) |
void | SetClipRectangleOrigin (const std::array< int, 3 > &origin) |
void | SetClipRectangleSize (const std::array< int, 3 > &size) |
vtkGetStdStringMacro (GrabberLocation) | |
vtkSetStdStringMacro (GrabberLocation) | |
virtual PlusStatus | WriteConfiguration (vtkXMLDataElement *config) |
![]() | |
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 vtkPlusEpiphanVideoSource * | New () |
static vtkPlusEpiphanVideoSource * | SafeDownCast (vtkObject *o) |
![]() | |
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 | InternalConnect () |
virtual PlusStatus | InternalDisconnect () |
virtual PlusStatus | InternalStartRecording () |
virtual PlusStatus | InternalStopRecording () |
PlusStatus | InternalUpdate () |
vtkPlusEpiphanVideoSource () | |
vtkSetStdStringMacro (ScaleMode) | |
vtkSetStdStringMacro (RotationMode) | |
~vtkPlusEpiphanVideoSource () | |
![]() | |
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 vtkPlusDataCollector * | GetDataCollector () |
double | GetRecordingStartTime () const |
bool | GetStartThreadForInternalUpdates () const |
bool | HasGracePeriodExpired () |
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 () |
Additional Inherited Members | |
![]() | |
double | InternalUpdateRate |
vtkIGSIORecursiveCriticalSection * | UpdateMutex |
vtkTimeStamp | UpdateTime |
![]() | |
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 void * | vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data) |
![]() | |
static const int | VIRTUAL_DEVICE_FRAME_RATE = 50 |
Class for providing video input interfaces between VTK and Epiphan frame grabber device.
Definition at line 23 of file vtkPlusEpiphanVideoSource.h.
Definition at line 27 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Constructor
Definition at line 27 of file vtkPlusEpiphanVideoSource.cxx.
|
protected |
Destructor
Definition at line 54 of file vtkPlusEpiphanVideoSource.cxx.
|
virtual |
Reimplemented from vtkPlusDevice.
std::array< int, 3 > vtkPlusEpiphanVideoSource::GetClipRectangleOrigin | ( | ) | const |
Get the clip rectangle origin to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the whole frame is captured.
Definition at line 450 of file vtkPlusEpiphanVideoSource.cxx.
std::array< int, 3 > vtkPlusEpiphanVideoSource::GetClipRectangleSize | ( | ) | const |
Get the clip rectangle size to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the values are ignored and the whole frame is captured.
Definition at line 438 of file vtkPlusEpiphanVideoSource.cxx.
|
protectedvirtual |
Device-specific connect
Reimplemented from vtkPlusDevice.
Definition at line 87 of file vtkPlusEpiphanVideoSource.cxx.
|
protectedvirtual |
Device-specific disconnect
Reimplemented from vtkPlusDevice.
Definition at line 198 of file vtkPlusEpiphanVideoSource.cxx.
|
protectedvirtual |
Device-specific recording start
Reimplemented from vtkPlusDevice.
Definition at line 220 of file vtkPlusEpiphanVideoSource.cxx.
|
protectedvirtual |
Device-specific recording stop
Reimplemented from vtkPlusDevice.
Definition at line 232 of file vtkPlusEpiphanVideoSource.cxx.
|
protectedvirtual |
The internal function which actually does the grab.
Reimplemented from vtkPlusDevice.
Definition at line 239 of file vtkPlusEpiphanVideoSource.cxx.
|
virtual |
Reimplemented from vtkPlusDevice.
|
virtual |
Is this device a tracker
Reimplemented from vtkPlusDevice.
Definition at line 81 of file vtkPlusEpiphanVideoSource.cxx.
|
static |
|
static |
|
virtual |
Perform any completion tasks once configured
Reimplemented from vtkPlusDevice.
Definition at line 456 of file vtkPlusEpiphanVideoSource.cxx.
|
virtual |
Reimplemented from vtkPlusDevice.
Definition at line 75 of file vtkPlusEpiphanVideoSource.cxx.
|
virtual |
Read configuration from xml data
Reimplemented from vtkPlusDevice.
Definition at line 310 of file vtkPlusEpiphanVideoSource.cxx.
|
static |
void vtkPlusEpiphanVideoSource::SetClipRectangleOrigin | ( | const std::array< int, 3 > & | origin | ) |
Set the clip rectangle origin to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the whole frame is captured.
Definition at line 444 of file vtkPlusEpiphanVideoSource.cxx.
void vtkPlusEpiphanVideoSource::SetClipRectangleSize | ( | const std::array< int, 3 > & | size | ) |
Set the clip rectangle size to apply to the image in pixel coordinates. If the ClipRectangleSize is (0,0) then the values are ignored and the whole frame is captured. Width of the ClipRectangle typically have to be a multiple of 4.
Definition at line 432 of file vtkPlusEpiphanVideoSource.cxx.
vtkPlusEpiphanVideoSource::vtkGetStdStringMacro | ( | GrabberLocation | ) |
Get the Epiphan device location
vtkPlusEpiphanVideoSource::vtkSetStdStringMacro | ( | GrabberLocation | ) |
Set the Epiphan device location. If no location parameter is specified then the device is attempted to be detected automatically. Format of the location string: local:[SERIAL] Specifies a local frame grabber. Optionally the serial number can be specified. net:[ADDRESS[:PORT]] Specifies a network frame grabber at the specified address/port. If no address is specified, then a random network frame grabber on the local subnet may be found. sn:SERIAL Specifies a local or network frame grabber with the specified serial number. Checks the local framegrabbers first. id:INDEX Specifies a local frame grabber with the specified index.
|
protected |
|
protected |
|
virtual |
Write configuration to xml data
Reimplemented from vtkPlusDevice.
Definition at line 415 of file vtkPlusEpiphanVideoSource.cxx.
|
protected |
Definition at line 107 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 102 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 103 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 108 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 105 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 106 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 104 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 111 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 110 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 113 of file vtkPlusEpiphanVideoSource.h.
|
protected |
Definition at line 112 of file vtkPlusEpiphanVideoSource.h.