us Namespace Reference

Classes
struct	usImageHeader

Enumerations
enum	ImageType {   UNKNOWN = -1 , NOT_SET , RF_2D , RF_3D ,   PRESCAN_2D , PRESCAN_3D , POSTSCAN_2D , POSTSCAN_3D }

Functions
VISP_EXPORT std::string	getDataSetPath ()

Detailed Description

General tools.

Enumeration Type Documentation

ImageType

enum us::ImageType

Enum to know the ultrasound image type Used in ultrasonix grabber to adapt the grabber when we receive the header, and in the mhd parser.

Enumerator
UNKNOWN	Unkownn format.
NOT_SET	Not set (usefull for mhd parser).
RF_2D	Case of 2D RF image.
RF_3D	Case of 3D RF image.
PRESCAN_2D	Case of 2D pre-scan image.
PRESCAN_3D	Case of 3D pre-scan image.
POSTSCAN_2D	Case of 2D post-scan image.
POSTSCAN_3D	Case of 3D post-scan image.

Definition at line 65 of file us.h.

Function Documentation

getDataSetPath()

std::string us::getDataSetPath

(

)

Get UsTK data set path. UsTK data set can be downloaded from https://gitlab.inria.fr/lagadic/ustk-dataset.

This function returns the path to the folder that contains the data.

• It checks first if the data set is installed in /usr/share/ustk-dataset. In that case returns then "/usr/share/ustk-dataset".
• Then it checks if USTK_DATASET_PATH environment variable that gives the location of the data is set. In that case returns the content of this environment var.

If the path is not found, returns an empty string.

Examples

tutorial-confidence-map.cpp, tutorial-elastography-2D-basic.cpp, tutorial-elastography-3D-basic.cpp, tutorial-image-display-qwidget.cpp, tutorial-mesh-deformation.cpp, and tutorial-rfFileToPreScanConversion.cpp.

Definition at line 54 of file us.cpp.

Referenced by usResliceMatrixViewer::openPostScan3D(), and us2DSceneWidget::saveViewSlot().