usElastography Class Reference

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

Public Types
enum	MotionEstimator { OF , BMA_TAYLOR }

Public Member Functions
	usElastography ()
	usElastography (usImageRF2D< short int > &Pre, usImageRF2D< short int > &Post)
virtual	~usElastography ()
double	getFPS (void)
double	getSamplingFrequency (void)
vpImage< unsigned char >	run ()
void	setDecimationFactor (unsigned int decimationFactor)
void	setFPS (double fps)
void	setSamplingFrequency (double samplingFrequency)
void	setLSQpercentage (double per)
void	setMotionEstimator (MotionEstimator t_mest)
void	setPostCompression (const usImageRF2D< short > &Post)
void	setPreCompression (const usImageRF2D< short > &Pre)
void	setROI (int tx, int ty, int tw, int th)
void	updateRF (const usImageRF2D< short int > &image)
void	updateROIPos (int tx, int ty)

Detailed Description

Computation of a strain map using two sucessive RF images acquired at different compressions of the probe.

This class produces a strain map based on tissues displacements between 2 input RF images.

The typical use of this class is :

• Set the ROI in the RF image, with setROI()
• Set the pre and post compressed images, with setPreCompression() and setPostCompression() or with updateRF().
• Run the process, using run()

Examples

tutorial-elastography-2D-basic.cpp, tutorial-elastography-2D-separate-displays.cpp, tutorial-elastography-2D.cpp, and tutorial-elastography-BMA-2D.cpp.

Definition at line 64 of file usElastography.h.

Member Enumeration Documentation

MotionEstimator

enum usElastography::MotionEstimator

Enumerator
OF
BMA_TAYLOR

Definition at line 67 of file usElastography.h.

Constructor & Destructor Documentation

usElastography() [1/2]

usElastography::usElastography

(

)

Default constructor.

Definition at line 41 of file usElastography.cpp.

References OF.

usElastography() [2/2]

usElastography::usElastography	(	usImageRF2D< short int > &	Pre,
		usImageRF2D< short int > &	Post
	)

Constructor setting the pre-compressed and the post-compressed images to perform elastography on.

Parameters

Pre	Pre-compresssed RF image.
Post	Post-compresssed RF image.

Definition at line 75 of file usElastography.cpp.

References OF, setPostCompression(), and setPreCompression().

~usElastography()

usElastography::~usElastography ( )

virtual

Destructor, free memory.

Definition at line 93 of file usElastography.cpp.

Member Function Documentation

getFPS()

double usElastography::getFPS ( void  )

inline

Definition at line 72 of file usElastography.h.

Referenced by usElastography3D::getFPS().

getSamplingFrequency()

double usElastography::getSamplingFrequency ( void  )

inline

Definition at line 73 of file usElastography.h.

Referenced by usElastography3D::getSamplingFrequency().

run()

vpImage< unsigned char > usElastography::run

(

)

Run the elastography computation.

Returns

The elastography image of the ROI (dark = hard tissues, white = soft).

Strain estimation "LSQ strain estimation"

Strain matrix S

Examples

tutorial-elastography-2D-basic.cpp, tutorial-elastography-2D-separate-displays.cpp, tutorial-elastography-2D.cpp, and tutorial-elastography-BMA-2D.cpp.

Definition at line 200 of file usElastography.cpp.

References usSignalProcessing::BilinearInterpolation(), BMA_TAYLOR, usSignalProcessing::Difference(), usSignalProcessing::GaussianFilter(), usImageRF2D< Type >::getHeight(), usImageRF2D< Type >::getWidth(), usSignalProcessing::getXGradient(), usSignalProcessing::getYGradient(), and usSignalProcessing::HadamardProd().

Referenced by usElastography3D::run(), and usElastographyQtWrapper::updateFrame().

setDecimationFactor()

void usElastography::setDecimationFactor ( unsigned int  decimationFactor )

inline

Examples

tutorial-elastography-2D-basic.cpp.

Definition at line 77 of file usElastography.h.

Referenced by usElastography3D::setDecimationFactor().

setFPS()

void usElastography::setFPS

(

double

fps

)

Setter for frames per second parameter of the acquisition.

Parameters

fps	Frames per second.

Definition at line 130 of file usElastography.cpp.

Referenced by usElastography3D::setFPS().

setLSQpercentage()

void usElastography::setLSQpercentage

(

double

per

)

Setter for LSQ strain percentage.

Parameters

per	LSQ strain percentage.

Definition at line 124 of file usElastography.cpp.

Referenced by usElastography3D::setLSQpercentage().

setMotionEstimator()

void usElastography::setMotionEstimator ( MotionEstimator  t_mest )

inline

Examples

tutorial-elastography-BMA-2D.cpp.

Definition at line 81 of file usElastography.h.

Referenced by usElastography3D::setMotionEstimator().

setPostCompression()

void usElastography::setPostCompression

(

const usImageRF2D< short > &

Post

)

Post-compresssed RF image setter.

Parameters

Post	Post-compresssed RF image.

Definition at line 114 of file usElastography.cpp.

Referenced by usElastography3D::run(), updateRF(), and usElastography().

setPreCompression()

void usElastography::setPreCompression

(

const usImageRF2D< short > &

Pre

)

Pre-compresssed RF image setter.

Parameters

Pre	Pre-compresssed RF image.

Definition at line 104 of file usElastography.cpp.

Referenced by usElastography3D::run(), updateRF(), and usElastography().

setROI()

void usElastography::setROI	(	int	tx,
		int	ty,
		int	tw,
		int	th
	)

ROI setter: the ROI is the region in the RF image in which to compute the elastography.

Parameters

tx	Top left column of the ROI.
ty	Top left row of the ROI.
tw	ROI width in px.
th	ROI height in px.

Examples

tutorial-elastography-2D-basic.cpp, tutorial-elastography-2D-separate-displays.cpp, tutorial-elastography-2D.cpp, and tutorial-elastography-BMA-2D.cpp.

Definition at line 161 of file usElastography.cpp.

Referenced by usElastographyQtWrapper::setROI(), and usElastography3D::setROI().

setSamplingFrequency()

void usElastography::setSamplingFrequency

(

double

samplingFrequency

)

Setter for sampling frequency of the ultrasound wave.

Parameters

samplingFrequency

Sampling frequency in Hertz.

Definition at line 136 of file usElastography.cpp.

Referenced by usElastography3D::setSamplingFrequency().

updateRF()

void usElastography::updateRF

(

const usImageRF2D< short int > &

image

)

Updater of pre/post compressed image : sets the new image as pre-compressed image for process, and sets the old pre-compressed image as new post-compressed.

Parameters

image

New pre-compressed image.

Examples

tutorial-elastography-2D-separate-displays.cpp, tutorial-elastography-2D.cpp, and tutorial-elastography-BMA-2D.cpp.

Definition at line 143 of file usElastography.cpp.

References setPostCompression(), and setPreCompression().

Referenced by usElastographyQtWrapper::updateFrame().

updateROIPos()

void usElastography::updateROIPos	(	int	tx,
		int	ty
	)

ROI position update, allows to move the ROI in the image.

Parameters

tx	New top left column of the ROI.
ty	New top left row of the ROI.

Definition at line 175 of file usElastography.cpp.

Referenced by usElastography3D::updateROIPos().