UsTK : Ultrasound ToolKit  version 2.0.1 under development (2023-12-07)
usImageElastography Class Reference

#include </home/soft/ustk/ustk-web-script/ustk-code/modules/ustk_elastography/include/visp3/ustk_elastography/usImageElastography.h>

Public Member Functions

 usImageElastography ()
 
 usImageElastography (const vpImage< unsigned char > &ultrasoundImage, const vpImage< unsigned char > &strainMap, unsigned int heightPosition, unsigned int widthPosition)
 
virtual ~usImageElastography ()
 
vpImage< vpRGBa > getElastoImage ()
 
void setStrainMap (const vpImage< unsigned char > &strainMap, unsigned int heightPosition, unsigned int widthPosition)
 
void setUltrasoundImage (const vpImage< unsigned char > &ultrasoundImage)
 

Detailed Description

Elastography image : contains a 2D B-Mode image (pre-scan or post-scan), with an overlaying colored sub-image to display the strain map of the sub-image region.

This class contains in fact 2 images : the ultrasound image (pre-scan or post-scan), and a second image corresponding to the tissue strain map of a region of interest in the ultrasound image. The strain map image is displayed as a colored overlay of the grayscale ultrasound image.

Warning
For internal process reason the ultrasound image has to be set first. And then when the strain map is set, the "mix" of the 2 image is done.

The following figure represents the output of usImageElastography.

Examples
tutorial-elastography-2D.cpp.

Definition at line 67 of file usImageElastography.h.

Constructor & Destructor Documentation

◆ usImageElastography() [1/2]

usImageElastography::usImageElastography ( )

Constructor.

Definition at line 38 of file usImageElastography.cpp.

◆ usImageElastography() [2/2]

usImageElastography::usImageElastography ( const vpImage< unsigned char > &  ultrasoundImage,
const vpImage< unsigned char > &  strainMap,
unsigned int  heightPosition,
unsigned int  widthPosition 
)

Initializing constructor.

Parameters
ultrasoundImageUltrasound image on which elastography was performed.
strainMapResulting image of elastography process.
heightPositionOffset (in px) between top-left corner of the strain map and top-left corner of the ultrasound image in height direction.
widthPositionOffset (in px) between top-left corner of the strain map and top-left corner of the ultrasound image in width direction.

Definition at line 52 of file usImageElastography.cpp.

◆ ~usImageElastography()

usImageElastography::~usImageElastography ( )
virtual

Destructor.

Definition at line 64 of file usImageElastography.cpp.

Member Function Documentation

◆ getElastoImage()

vpImage< vpRGBa > usImageElastography::getElastoImage ( )

Get the resulting image, combinig ultrasound and elastography.

Returns
The image resulting of the mix of ultrasound image and the strain map of a region of interest.
Examples
tutorial-elastography-2D.cpp.

Definition at line 70 of file usImageElastography.cpp.

◆ setStrainMap()

void usImageElastography::setStrainMap ( const vpImage< unsigned char > &  strainMap,
unsigned int  heightPosition,
unsigned int  widthPosition 
)

Strain map image setter.

Warning
Make sure you already set the ultrasound image with setUltrasoundImage() before calling this method.
Parameters
strainMap
heightPosition
widthPosition
Examples
tutorial-elastography-2D.cpp.

Definition at line 79 of file usImageElastography.cpp.

◆ setUltrasoundImage()

void usImageElastography::setUltrasoundImage ( const vpImage< unsigned char > &  ultrasoundImage)

Ultrasound image setter.

Parameters
ultrasoundImageUltrasound image : base image of elastography.
Examples
tutorial-elastography-2D.cpp.

Definition at line 100 of file usImageElastography.cpp.

Referenced by usImageElastographyCreationWrapper::updateFrame().