UsTK : Ultrasound ToolKit  version 2.0.1 under development (2023-12-07)
Public Member Functions | List of all members
usFrameGrabbedInfo< Type > Class Template Reference
ustk: Ultrasound tool kit » ustk_grabber: UsTK grabber module

#include <visp3/ustk_grabber/usFrameGrabbedInfo.h>

+ Inheritance diagram for usFrameGrabbedInfo< Type >:

Public Member Functions

 usFrameGrabbedInfo ()
 
 ~usFrameGrabbedInfo ()
 
quint32 getFrameCount () const
 
int getFramesPerVolume () const
 
quint64 getTimeStamp () const
 
void setFrameCount (quint32 frameCount)
 
void setFramesPerVolume (int framesPerVolume)
 
void setTimeStamp (quint64 timeStamp)
 

Detailed Description

template<class Type>
class usFrameGrabbedInfo< Type >

Class to store additionnal informations arriving on the network with ultrasound images grabbed, such as frame count, timestamp. Usefull to do real-time process.

Examples
tutorial-elastography-2D-separate-displays.cpp, tutorial-elastography-2D.cpp, tutorial-elastography-BMA-2D.cpp, tutorial-ultrasonix-qt-grabbing-RF-scan-conversion.cpp, tutorial-ultrasonix-qt-grabbing-RF.cpp, tutorial-ultrasonix-qt-grabbing-post-scan.cpp, tutorial-ultrasonix-qt-grabbing-post-scan3D.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan-confidence-control.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan-confidence.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan.cpp, tutorial-ustk-virtual-server-RF2D.cpp, tutorial-ustk-virtual-server-postScan2D.cpp, and tutorial-ustk-virtual-server-preScan2D.cpp.

Definition at line 59 of file usFrameGrabbedInfo.h.

Constructor & Destructor Documentation

◆ usFrameGrabbedInfo()

template<class Type >
usFrameGrabbedInfo< Type >::usFrameGrabbedInfo
explicit

Constructor.

Definition at line 83 of file usFrameGrabbedInfo.h.

◆ ~usFrameGrabbedInfo()

template<class Type >
usFrameGrabbedInfo< Type >::~usFrameGrabbedInfo

Destructor.

Definition at line 90 of file usFrameGrabbedInfo.h.

Member Function Documentation

◆ getFrameCount()

template<class Type >
quint32 usFrameGrabbedInfo< Type >::getFrameCount

Frame count getter.

Returns
The frame number since beginning of acquisition.
Examples
tutorial-elastography-2D-separate-displays.cpp, tutorial-elastography-2D.cpp, tutorial-elastography-BMA-2D.cpp, tutorial-ultrasonix-qt-grabbing-RF-scan-conversion.cpp, tutorial-ultrasonix-qt-grabbing-RF.cpp, tutorial-ultrasonix-qt-grabbing-post-scan.cpp, tutorial-ultrasonix-qt-grabbing-post-scan3D.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan-confidence.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan.cpp, tutorial-ustk-virtual-server-RF2D.cpp, tutorial-ustk-virtual-server-postScan2D.cpp, and tutorial-ustk-virtual-server-preScan2D.cpp.

Definition at line 96 of file usFrameGrabbedInfo.h.

Referenced by usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), and usNetworkGrabberPreScan2D::invertRowsCols().

◆ getFramesPerVolume()

template<class Type >
int usFrameGrabbedInfo< Type >::getFramesPerVolume

Frame per volume getter.

Returns
The number of frames per volume acquired. Used to reconstruct 3D volumes.

Definition at line 102 of file usFrameGrabbedInfo.h.

Referenced by usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), and usNetworkGrabberPreScan2D::invertRowsCols().

◆ getTimeStamp()

template<class Type >
quint64 usFrameGrabbedInfo< Type >::getTimeStamp

Time stamp getter.

Returns
The time stamp of ultrasound station when the frame was acquired.

Definition at line 108 of file usFrameGrabbedInfo.h.

Referenced by usNetworkGrabberRF3D::dataArrived(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), and usNetworkGrabberPreScan2D::invertRowsCols().

◆ setFrameCount()

template<class Type >
void usFrameGrabbedInfo< Type >::setFrameCount ( quint32  frameCount)

Frame count setter.

Parameters
frameCountThe frame number since beginning of acquisition.

Definition at line 114 of file usFrameGrabbedInfo.h.

Referenced by usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), and usNetworkGrabberRF3D::dataArrived().

◆ setFramesPerVolume()

template<class Type >
void usFrameGrabbedInfo< Type >::setFramesPerVolume ( int  framesPerVolume)

Frame per volume setter.

Parameters
framesPerVolumeThe number of frames per volume acquired. Used to reconstruct 3D volumes.

Definition at line 120 of file usFrameGrabbedInfo.h.

Referenced by usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), and usNetworkGrabberRF3D::dataArrived().

◆ setTimeStamp()

template<class Type >
void usFrameGrabbedInfo< Type >::setTimeStamp ( quint64  timeStamp)

Time stamp setter.

Parameters
timeStampThe time stamp of ultrasound station when the frame was acquired.

Definition at line 129 of file usFrameGrabbedInfo.h.

Referenced by usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), and usNetworkGrabberRF3D::dataArrived().