usVolumeGrabbedInfo< Type > Class Template Reference

#include <visp3/ustk_grabber/usVolumeGrabbedInfo.h>

Inheritance diagram for usVolumeGrabbedInfo< Type >:

Public Member Functions
	usVolumeGrabbedInfo ()
	~usVolumeGrabbedInfo ()
void	addTimeStamp (quint64 timestamp, unsigned int position)
quint32	getVolumeCount () const
std::vector< uint64_t >	getTimeStamps () const
void	setVolumeCount (quint32 volumeCount)

Detailed Description

template<class Type>
class usVolumeGrabbedInfo< Type >

Class to store additionnal informations arriving on the network with ultrasound volumes grabbed, such as volume count, timestamps. Usefull to do real-time process.

Examples

tutorial-elastography-3D-acquisition.cpp, tutorial-ultrasonix-qt-grabbing-RF3D.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan3D-display.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan3D.cpp, tutorial-ustk-virtual-server-RF3D.cpp, and tutorial-ustk-virtual-server-preScan3D.cpp.

Definition at line 57 of file usVolumeGrabbedInfo.h.

Constructor & Destructor Documentation

usVolumeGrabbedInfo()

template<class Type >

usVolumeGrabbedInfo< Type >::usVolumeGrabbedInfo

explicit

Constructor.

Definition at line 78 of file usVolumeGrabbedInfo.h.

~usVolumeGrabbedInfo()

template<class Type >

usVolumeGrabbedInfo< Type >::~usVolumeGrabbedInfo

Destructor.

Definition at line 83 of file usVolumeGrabbedInfo.h.

Member Function Documentation

addTimeStamp()

template<class Type >

void usVolumeGrabbedInfo< Type >::addTimeStamp	(	quint64	timestamp,
		unsigned int	position
	)

Includes a new timestamp into the array (corresponding to a frame of the volume).

Parameters

timestamp	The new timestamp when the first frame in the volume was acquired.
position	The new timestamp position in the array (from O to array size - 1).

Definition at line 105 of file usVolumeGrabbedInfo.h.

getTimeStamps()

template<class Type >

std::vector< uint64_t > usVolumeGrabbedInfo< Type >::getTimeStamps

Getter for the timestamps array.

Returns

The vector of timestamps (make sure you filled it with addTimeStamp() at every new frame before call this method.

Examples

tutorial-ustk-virtual-server-RF3D.cpp.

Definition at line 121 of file usVolumeGrabbedInfo.h.

getVolumeCount()

template<class Type >

quint32 usVolumeGrabbedInfo< Type >::getVolumeCount

Volume count getter.

Returns

The volume number since beginning of acquisition.

Examples

tutorial-elastography-3D-acquisition.cpp, tutorial-ultrasonix-qt-grabbing-RF3D.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan3D-display.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan3D.cpp, tutorial-ustk-virtual-server-RF3D.cpp, and tutorial-ustk-virtual-server-preScan3D.cpp.

Definition at line 89 of file usVolumeGrabbedInfo.h.

setVolumeCount()

template<class Type >

void usVolumeGrabbedInfo< Type >::setVolumeCount

(

quint32

volumeCount

)

Volume count setter.

Parameters

volumeCount

The volume number since beginning of acquisition.

Definition at line 95 of file usVolumeGrabbedInfo.h.