usElastography3D Class Reference

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

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

Detailed Description

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

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

The typical use of this class is :

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

Examples

tutorial-elastography-3D-basic.cpp.

Definition at line 61 of file usElastography3D.h.

Constructor & Destructor Documentation

usElastography3D() [1/2]

usElastography3D::usElastography3D

(

)

Default constructor.

Definition at line 40 of file usElastography3D.cpp.

usElastography3D() [2/2]

usElastography3D::usElastography3D	(	usImageRF3D< short int > &	Pre,
		usImageRF3D< short int > &	Post
	)

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

Parameters

Pre	Pre-compresssed RF volume.
Post	Post-compresssed RF volume.

Definition at line 54 of file usElastography3D.cpp.

References setPostCompression(), and setPreCompression().

~usElastography3D()

usElastography3D::~usElastography3D ( )

virtual

Destructor.

Definition at line 65 of file usElastography3D.cpp.

Member Function Documentation

getFPS()

double usElastography3D::getFPS

(

void

)

Definition at line 113 of file usElastography3D.cpp.

References usElastography::getFPS().

getSamplingFrequency()

double usElastography3D::getSamplingFrequency

(

void

)

Definition at line 115 of file usElastography3D.cpp.

References usElastography::getSamplingFrequency().

run()

usImage3D< unsigned char > usElastography3D::run

(

)

Run the elastography computation.

Returns

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

Examples

tutorial-elastography-3D-basic.cpp.

Definition at line 171 of file usElastography3D.cpp.

References usImageRF3D< Type >::getFrame(), usImage3D< Type >::resize(), usElastography::run(), usElastography::setPostCompression(), and usElastography::setPreCompression().

setDecimationFactor()

void usElastography3D::setDecimationFactor

(

unsigned int

decimationFactor

)

Definition at line 117 of file usElastography3D.cpp.

References usElastography::setDecimationFactor().

setFPS()

void usElastography3D::setFPS

(

double

fps

)

Setter for LSQ strain percentage.

Parameters

fps	LSQ strain percentage.

Definition at line 97 of file usElastography3D.cpp.

References usElastography::setFPS().

setLSQpercentage()

void usElastography3D::setLSQpercentage

(

double

per

)

Setter for LSQ strain percentage.

Parameters

per	LSQ strain percentage.

Definition at line 91 of file usElastography3D.cpp.

References usElastography::setLSQpercentage().

setMotionEstimator()

void usElastography3D::setMotionEstimator

(

usElastography::MotionEstimator

t_mest

)

Definition at line 108 of file usElastography3D.cpp.

References usElastography::setMotionEstimator().

setPostCompression()

void usElastography3D::setPostCompression

(

const usImageRF3D< short > &

Post

)

Post-compresssed RF volume setter.

Parameters

Post	Post-compresssed RF volume.

Examples

tutorial-elastography-3D-basic.cpp.

Definition at line 81 of file usElastography3D.cpp.

Referenced by updateRF(), and usElastography3D().

setPreCompression()

void usElastography3D::setPreCompression

(

const usImageRF3D< short > &

Pre

)

Pre-compresssed RF volume setter.

Parameters

Pre	Pre-compresssed RF volume.

Examples

tutorial-elastography-3D-basic.cpp.

Definition at line 71 of file usElastography3D.cpp.

Referenced by updateRF(), and usElastography3D().

setROI()

void usElastography3D::setROI	(	int	tx,
		int	ty,
		int	tz,
		int	tw,
		int	th,
		int	tf
	)

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.
tz	Top left frame of the ROI.
tw	ROI width in px.
th	ROI height in px.
tf	ROI size in number of frames included.

Examples

tutorial-elastography-3D-basic.cpp.

Definition at line 147 of file usElastography3D.cpp.

References usElastography::setROI().

setSamplingFrequency()

void usElastography3D::setSamplingFrequency

(

double

samplingFrequency

)

Setter for sampling frequency of the ultrasound wave.

Parameters

samplingFrequency

Sampling frequency in Hertz.

Definition at line 103 of file usElastography3D.cpp.

References usElastography::setSamplingFrequency().

updateRF()

void usElastography3D::updateRF

(

const usImageRF3D< short int > &

volume

)

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

Parameters

volume

New pre-compressed volume.

Definition at line 127 of file usElastography3D.cpp.

References setPostCompression(), and setPreCompression().

updateROIPos()

void usElastography3D::updateROIPos	(	int	tx,
		int	ty,
		int	tz
	)

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.
tz	New top left frame of the ROI.

Definition at line 161 of file usElastography3D.cpp.

References usElastography::updateROIPos().