#include <visp3/ustk_core/usImageRF2D.h>

Inheritance diagram for usImageRF2D< Type >:

Public Member Functions
	usImageRF2D ()

	usImageRF2D (unsigned int height, unsigned int width)

	usImageRF2D (unsigned int height, unsigned int width, const usImagePreScanSettings &preScanSettings)

	usImageRF2D (const usImageRF2D &other)

virtual	~usImageRF2D ()

const Type *	getBitmap () const

unsigned int	getHeight () const

unsigned int	getNumberOfPixel () const

unsigned int	getRFSampleNumber () const

const Type *	getSignal (unsigned int scanlineIndex) const

unsigned int	getWidth () const

void	init (unsigned int height, unsigned int width)

usImageRF2D< Type > &	operator= (const usImageRF2D< Type > &other)

bool	operator== (const usImageRF2D< Type > &other)

Type	operator() (unsigned int i, unsigned int j) const

void	operator() (unsigned int i, unsigned int j, const Type &value)

void	setScanLineNumber (unsigned int scanLineNumber)

void	resize (const unsigned int height, const unsigned int width)

void	resize (const unsigned int height, const unsigned int width, const Type &val)

Inherited functionalities from usImagePreScanSettings
double	getAxialResolution () const

usImagePreScanSettings	getImagePreScanSettings () const

bool	operator== (const usImagePreScanSettings &other)

void	setAxialResolution (const double axialResolution)

void	setImagePreScanSettings (const usImagePreScanSettings &preScanSettings)

Inherited functionalities from usTransducerSettings
bool	operator== (usTransducerSettings const &other)

double	getDepth () const

double	getFieldOfView () const

std::string	getProbeName () const

int	getSamplingFrequency () const

unsigned int	getScanLineNumber () const

double	getScanLinePitch () const

double	getTransducerRadius () const

usTransducerSettings	getTransducerSettings () const

int	getTransmitFrequency () const

bool	isTransducerConvex () const

bool	operator!= (usTransducerSettings const &other)

bool	scanLineNumberIsSet () const

void	setDepth (double depth)

void	setFieldOfView (double fieldOfView)

void	setProbeName (std::string probeName)

void	setSamplingFrequency (const int samplingFrequency)

void	setScanLinePitch (const double scanLinePitch)

void	setTransducerConvexity (const bool isTransducerConvex)

void	setTransducerSettings (const usTransducerSettings &other)

void	setTransducerRadius (const double transducerRadius)

void	setTransmitFrequency (const int transmitFrequency)

Friends
class	usRawFileParser

class	usNetworkGrabberRF2D

class	usNetworkGrabberRF3D

class	usVirtualServer

Detailed Description

template<class Type>
class usImageRF2D< Type >

2D Radio Frequence (RF) ultrasound image.

This class represents a 2D RF ultrasound image. This image is nothing more than an image (respecting column-major bitmap storage) that contains additional settings that give information about the acquisition process done by the transducer.

The settings associated to an usImageRF2D image are the one implemented in usImagePreScanSettings. We recall that these settings are:

the transducer settings (see usTransducerSettings) that are:
- the name of the probe that could be set using setProbeName() or retrieved using getProbeName().
- the transducer radius $R_{_T}$ in meters (value set to zero for a linear transducer). Its value could be set using setTransducerRadius() and retrieved using getTransducerRadius().
- the scan line pitch that corresponds to the angle $\alpha_{_{SC}}$ (in radians) between two successive scan line beams when the transducer is convex, or to the distance $d_{_{SC}}$ (in meters) when the transducer is linear. To set this value use setScanLinePitch() and to get its value use getScanLinePitch().
- the number of scan lines $n_{_{SC}}$ . To set this setting use setScanLineNumber() and to access to the value use getScanLineNumber().
- the type of ultrasound transducer used for data acquisition: convex or linear. This parameter could be set using setTransducerConvexity(). To know the transducer type use isTransducerConvex().
- the depth that corresponds to the distance in meters between the first and the last pixel in a scan line. To set this value use setDepth() and to get the depth use getDepth().

and an additional axial resolution parameter called $a_{_R}$ which corresponds to the distance (in meters) between two consecutive RF samples along a scan line. To set this value use setAxialResolution() and to retrieve this value use getAxialResolution().

The following figure summarize these settings and shows the structure of an usImageRF2D image:

The following example shows how to read a 2D RF ultrasound image, and set the image settings of your choice.

#include <visp3/ustk_core/usImageIo.h>
#include <visp3/ustk_core/usImageRF2D.h>
 
int main()
{
  // 2D RF image settings
  unsigned int RFSampleNumber = 2000;
  double transducerRadius = 0.007;
  double scanLinePitch = 0.0006;
  unsigned int scanLineNumber = 256;
  bool isTransducerConvex = true;
  double axialResolution = 0.002;
 
  usImageRF2D<short> rf2d(RFSampleNumber, scanLineNumber);
 
  // sets the RF samples values contained in the .raw file in the bitmap of
  //the usImageRF2D, and the settings contained in the mhd header.
  usImageIo::read(rf2d, "path/to/file.mhd");
 
  //sets your own settings
  rf2d.setTransducerRadius(transducerRadius);
  rf2d.setScanLinePitch(scanLinePitch);
  rf2d.setScanLineNumber(scanLineNumber);
  rf2d.setTransducerConvexity(isTransducerConvex);
  rf2d.setAxialResolution(axialResolution);
 
  return 0;
}

Examples: testUsImageRf2DMhdParser.cpp.

Definition at line 111 of file usImageRF2D.h.

Constructor & Destructor Documentation

◆ usImageRF2D() [1/4]

template<class Type >

usImageRF2D< Type >::usImageRF2D

Constructor.

No memory allocation is done

Definition at line 164 of file usImageRF2D.h.

◆ usImageRF2D() [2/4]

template<class Type >

usImageRF2D< Type >::usImageRF2D	(	unsigned int	height,
		unsigned int	width
	)

Initializing constructor.

Parameters

height	Image height.
width	Image width.

Definition at line 174 of file usImageRF2D.h.

References usImageRF2D< Type >::init().

◆ usImageRF2D() [3/4]

template<class Type >

usImageRF2D< Type >::usImageRF2D	(	unsigned int	height,
		unsigned int	width,
		const usImagePreScanSettings &	preScanSettings
	)

Initializing constructor.

Parameters

height	Image height.
width	Image width.
preScanSettings	Pre-scan image settings.

Definition at line 187 of file usImageRF2D.h.

References usTransducerSettings::getScanLineNumber(), usImageRF2D< Type >::init(), and usImagePreScanSettings::setImagePreScanSettings().

◆ usImageRF2D() [4/4]

template<class Type >

usImageRF2D< Type >::usImageRF2D ( const usImageRF2D< Type > & other )

Copy constructor.

Parameters

other 2D RF image to copy

Definition at line 202 of file usImageRF2D.h.

References usImageRF2D< Type >::getBitmap(), usImageRF2D< Type >::getHeight(), usImageRF2D< Type >::getWidth(), and usImageRF2D< Type >::resize().

◆ ~usImageRF2D()

template<class Type >

usImageRF2D< Type >::~usImageRF2D

virtual

Destructor.

Definition at line 215 of file usImageRF2D.h.

Member Function Documentation

◆ getAxialResolution()

double usImagePreScanSettings::getAxialResolution ( ) const

inherited

Axial resolution getter.

Examples: testUsImageRf3DMhdParser.cpp.

Definition at line 118 of file usImagePreScanSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usPreScanToPostScan2DConverter::convert(), usMHDSequenceReader::getImage(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), usPreScanToPostScan3DConverter::init(), usImagePreScanSettings::operator=(), usImagePreScanSettings::operator==(), usImageIo::read(), usImageIo::write(), and usMHDSequenceWriter::write().

◆ getBitmap()

template<class Type >

const Type * usImageRF2D< Type >::getBitmap

Getter for a const pointer on the image bitmap.

Returns: Pointer on image bitmap.

Definition at line 430 of file usImageRF2D.h.

Referenced by usImageRF2D< Type >::operator=(), and usImageRF2D< Type >::usImageRF2D().

◆ getDepth()

double usTransducerSettings::getDepth ( ) const

inherited

Setter for depth : distance in meters between first and last pixel in a scan line.

Returns: Depth in meters.

Examples: tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, and tutorial-sonosite-confidence-map.cpp.

Definition at line 289 of file usTransducerSettings.cpp.

Referenced by usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usRFToPreScan3DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), and usTransducerSettings::operator=().

◆ getFieldOfView()

double usTransducerSettings::getFieldOfView ( ) const

inherited

Getter for the transducer field of view (based on scan line number and pitch).

Returns: The transducer field of view in radians if the probe is convex, in meters if it is linear.

Examples: tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-sonosite-confidence-map.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan-confidence-control.cpp, and tutorial-ultrasonix-servo-target-confidence.cpp.

Definition at line 244 of file usTransducerSettings.cpp.

Referenced by usPostScanToPreScan2DConverter::convert(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usImageDisplayWidgetRobotControl::updateConfidenceAngle(), and usImageDisplayWidgetQmlOverlayServoing::updateConfidenceAngle().

◆ getHeight()

template<class Type >

unsigned int usImageRF2D< Type >::getHeight

Getter for the height of the image

Returns: Image height.

Definition at line 412 of file usImageRF2D.h.

Referenced by usRFToPreScan2DConverter::convert(), usSignalProcessing::Difference(), usSignalProcessing::getXGradient(), usSignalProcessing::getYGradient(), usNetworkGrabberRF3D::includeFrameInVolume(), usImageRF3D< Type >::insertFrame(), usImageRF2D< Type >::operator=(), usImageRF2D< Type >::operator==(), usElastography::run(), usImageRF2D< Type >::usImageRF2D(), and usMHDSequenceWriter::write().

◆ getImagePreScanSettings()

usImagePreScanSettings usImagePreScanSettings::getImagePreScanSettings ( ) const

inherited

Definition at line 120 of file usImagePreScanSettings.cpp.

◆ getNumberOfPixel()

template<class Type >

unsigned int usImageRF2D< Type >::getNumberOfPixel

Getter for the number of pixels in the image.

Returns: Total count of pixels in the image.

Definition at line 418 of file usImageRF2D.h.

Referenced by usNetworkGrabberRF3D::dataArrived().

◆ getProbeName()

std::string usTransducerSettings::getProbeName ( ) const

inherited

Getter for the probe name.

Returns: Name of the probe.

Definition at line 232 of file usTransducerSettings.cpp.

◆ getRFSampleNumber()

template<class Type >

unsigned int usImageRF2D< Type >::getRFSampleNumber

Get the number of RF samples in a scan line.

Returns: Number of RF samples in a scan line.

Definition at line 305 of file usImageRF2D.h.

Referenced by usImageIo::write().

◆ getSamplingFrequency()

int usTransducerSettings::getSamplingFrequency ( ) const

inherited

Getter for sampling frequency : frequency used to sample the echo of the ultrasound wave.

Returns: Sampling frequency Frequency in Hz.

Definition at line 305 of file usTransducerSettings.cpp.

Referenced by usTransducerSettings::operator=(), usTransducerSettings::operator==(), usImageIo::read(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getScanLineNumber()

unsigned int usTransducerSettings::getScanLineNumber ( ) const

inherited

Getter for the scan line number.

Returns: Number of scan lines acquired by the probe transducer.

Definition at line 216 of file usTransducerSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), usTransducerSettings::operator=(), usTransducerSettings::operator==(), usImageIo::read(), usImagePreScan2D< Type >::usImagePreScan2D(), usImagePreScan3D< Type >::usImagePreScan3D(), usImageRF2D< Type >::usImageRF2D(), usImageRF3D< Type >::usImageRF3D(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getScanLinePitch()

double usTransducerSettings::getScanLinePitch ( ) const

inherited

Get the scan line pitch (m).

Returns

When the probe transducer is convex, returns the angle in radians between two successive scan lines acquired by the transducer.
When the probe transducer is linear, returns the distance in meters between two successive scan lines acquired by the transducer.

Examples: tutorial-servo-target-confidence.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-ultrasonix-qt-grabbing-pre-scan-confidence-control.cpp, and tutorial-ultrasonix-servo-target-confidence.cpp.

Definition at line 182 of file usTransducerSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usTransducerSettings::operator=(), usTransducerSettings::operator==(), usImageIo::read(), usImageDisplayWidgetRobotControl::updateConfidenceAngle(), usImageDisplayWidgetQmlOverlayServoing::updateConfidenceAngle(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getSignal()

template<class Type >

const Type * usImageRF2D< Type >::getSignal ( unsigned int scanlineIndex ) const

Getter for the RF signal at a certain scanline index.

Parameters

scanlineIndex The index of the scanline to acess.

Returns: The RF signal.

Definition at line 437 of file usImageRF2D.h.

Referenced by usRFToPreScan2DConverter::convert().

◆ getTransducerRadius()

double usTransducerSettings::getTransducerRadius ( ) const

inherited

Get the probe transducer radius (m).

Returns: Transducer radius in meters. The transducer radius is set to 0 if the probe is linear.

Examples: tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, and tutorial-sonosite-confidence-map.cpp.

Definition at line 163 of file usTransducerSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usTransducerSettings::operator=(), usTransducerSettings::operator==(), usImageIo::read(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getTransducerSettings()

usTransducerSettings usTransducerSettings::getTransducerSettings ( ) const

inherited

Getter for transducer settings : allows heritating classes to get the transducer settings.

Returns: The transducer settings.

Definition at line 295 of file usTransducerSettings.cpp.

◆ getTransmitFrequency()

int usTransducerSettings::getTransmitFrequency ( ) const

inherited

Getter for transmit frequency : frequency of the ultrasound wave used.

Returns: Transmit frequency in Hz.

Definition at line 311 of file usTransducerSettings.cpp.

Referenced by usTransducerSettings::operator=(), usTransducerSettings::operator==(), usImageIo::read(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getWidth()

template<class Type >

unsigned int usImageRF2D< Type >::getWidth

Getter for the width of the image

Returns: Image width.

Definition at line 424 of file usImageRF2D.h.

Referenced by usRFToPreScan2DConverter::convert(), usSignalProcessing::Difference(), usSignalProcessing::getXGradient(), usSignalProcessing::getYGradient(), usNetworkGrabberRF3D::includeFrameInVolume(), usImageRF3D< Type >::insertFrame(), usImageRF2D< Type >::operator=(), usImageRF2D< Type >::operator==(), usElastography::run(), usImageRF2D< Type >::usImageRF2D(), and usMHDSequenceWriter::write().

◆ init()

template<class Type >

void usImageRF2D< Type >::init	(	unsigned int	height,
		unsigned int	width
	)

Set the size of the image.

Image initialization.

Allocate memory for an [h x w] image, using column major image convention.

Parameters

width	: Image width.
height	: Image height.

Element of the bitmap are not initialized

If the image has been already initialized, memory allocation is done only if the new image size is different, else we re-use the same memory space.

Exceptions

vpException::memoryAllocationError

Definition at line 371 of file usImageRF2D.h.

Referenced by usImageRF2D< Type >::usImageRF2D(), and usNetworkGrabberRF3D::usNetworkGrabberRF3D().

◆ isTransducerConvex()

bool usTransducerSettings::isTransducerConvex ( ) const

inherited

Returns the probe transducer type.

Returns: True if the transducer is convex, false if the transducer is linear.

Definition at line 201 of file usTransducerSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usPreScanToPostScan3DConverter::init(), usTransducerSettings::operator=(), usTransducerSettings::operator==(), usImageIo::read(), usTransducerSettings::setTransducerConvexity(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ operator!=()

bool usTransducerSettings::operator!= ( usTransducerSettings const & other )

inherited

Compare two probe transducer settings.

Returns: False if the settings are the same, true otherwise.

Definition at line 125 of file usTransducerSettings.cpp.

References usTransducerSettings::operator==().

◆ operator()() [1/2]

template<class Type >

Type usImageRF2D< Type >::operator()	(	unsigned int	i,
		unsigned int	j
	)		const

operator() allows to access/modify RF samples values in the image.

Access operator.

Parameters

i	Row index of the pixel to access.
j	Column index of the pixel to access.

Returns: The value of the pixel.

Definition at line 267 of file usImageRF2D.h.

◆ operator()() [2/2]

template<class Type >

void usImageRF2D< Type >::operator()	(	unsigned int	i,
		unsigned int	j,
		const Type &	value
	)

Pixel writing operator.

Parameters

i	Row index of the pixel to write.
j	Column index of the pixel to write.
value	The value to write.

Definition at line 281 of file usImageRF2D.h.

◆ operator=()

template<class Type >

usImageRF2D< Type > & usImageRF2D< Type >::operator= ( const usImageRF2D< Type > & other )

Copy operator.

Definition at line 231 of file usImageRF2D.h.

References usImageRF2D< Type >::getBitmap(), usImageRF2D< Type >::getHeight(), usImageRF2D< Type >::getWidth(), and usImagePreScanSettings::operator=().

◆ operator==() [1/3]

bool usImagePreScanSettings::operator== ( const usImagePreScanSettings & other )

inherited

Comparison operator.

Parameters

other usImagePreScanSettings to compare with.

Definition at line 95 of file usImagePreScanSettings.cpp.

References usImagePreScanSettings::getAxialResolution().

Referenced by usImageRF2D< Type >::operator==().

◆ operator==() [2/3]

template<class Type >

bool usImageRF2D< Type >::operator== ( const usImageRF2D< Type > & other )

Comparison operator.

Definition at line 245 of file usImageRF2D.h.

References usImageRF2D< Type >::getHeight(), usImageRF2D< Type >::getWidth(), and usImagePreScanSettings::operator==().

◆ operator==() [3/3]

bool usTransducerSettings::operator== ( usTransducerSettings const & other )

inherited

Compare two probe transducer settings.

Returns: True if the settings are the same, false otherwise.

Definition at line 111 of file usTransducerSettings.cpp.

References usTransducerSettings::getSamplingFrequency(), usTransducerSettings::getScanLineNumber(), usTransducerSettings::getScanLinePitch(), usTransducerSettings::getTransducerRadius(), usTransducerSettings::getTransmitFrequency(), and usTransducerSettings::isTransducerConvex().

Referenced by usTransducerSettings::operator!=(), and usImagePostScan3D< Type >::operator==().

◆ resize() [1/2]

template<class Type >

void usImageRF2D< Type >::resize	(	const unsigned int	height,
		const unsigned int	width
	)

Resize the 2D RF image.

Updates also the transducer scan line number that corresponds to the image width.

Parameters

height	Image height.
width	Image width.

Definition at line 328 of file usImageRF2D.h.

Referenced by usMHDSequenceReader::acquire(), usNetworkGrabberRF3D::dataArrived(), usImageRF3D< Type >::getFrame(), usMHDSequenceReader::getImage(), usImageIo::read(), and usImageRF2D< Type >::usImageRF2D().

◆ resize() [2/2]

template<class Type >

void usImageRF2D< Type >::resize	(	const unsigned int	height,
		const unsigned int	width,
		const Type &	val
	)

Resize the 2D RF image.

Updates also the transducer scan line number that corresponds to the image width.

Parameters

height	Image height.
width	Image width.
val	Value to set in every pixel.

Definition at line 343 of file usImageRF2D.h.

◆ scanLineNumberIsSet()

bool usTransducerSettings::scanLineNumberIsSet ( ) const

inherited

Getter to know if the scan line number is set (usefull in case of field of view setter call).

Returns: Boolean to know if the scan line number is set or not.

Definition at line 277 of file usTransducerSettings.cpp.

Referenced by usTransducerSettings::operator=().

◆ setAxialResolution()

void usImagePreScanSettings::setAxialResolution ( const double axialResolution )

inherited

Axial resolution setter.

Parameters

axialResolution Axial resloution to assign to the settings.

Examples: testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, and testUsImageRf3DMhdParser.cpp.

Definition at line 113 of file usImagePreScanSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usPostScanToPreScan2DConverter::convert(), usRFToPreScan3DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), and usImageIo::read().

◆ setDepth()

void usTransducerSettings::setDepth ( double depth )

inherited

Setter for depth : distance in meters between first and last pixel in a scan line.

Parameters

depth Distance in meters.

Examples: testUsImageRf3DMhdParser.cpp, tutorial-rfFileToPreScanConversion.cpp, tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-sonosite-confidence-map.cpp, and tutorial-ultrasonix-qt-grabbing-RF-scan-conversion.cpp.

Definition at line 283 of file usTransducerSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), and usImageIo::read().

◆ setFieldOfView()

void usTransducerSettings::setFieldOfView ( double fieldOfView )

inherited

Setter for the transducer field of view (updates the scan line pitch).

Parameters

fieldOfView The transducer field of view in radians if the transducer is convex, in meters if the transducer is linear.

Warning: Be sure to use setScanLineNumber() to update the scan line number before the field of view since this method computes the scan line pitch from the field of view and the scan line pitch.
usTransducerSettings transducerSettings;

transducerSettings.setScanLineNumber(128);

transducerSettings.setFieldOfView(vpMath::rad(57.0)); // field of view is 57 deg

usTransducerSettings
Generic class for 2D ultrasound data common settings associated to the type of probe transducer used ...
Definition: usTransducerSettings.h:81

usTransducerSettings::setFieldOfView
void setFieldOfView(double fieldOfView)
Definition: usTransducerSettings.cpp:265

usTransducerSettings::setScanLineNumber
void setScanLineNumber(unsigned int scanLineNumber)
Definition: usTransducerSettings.cpp:222

Examples: tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, and tutorial-sonosite-confidence-map.cpp.

Definition at line 265 of file usTransducerSettings.cpp.

Referenced by usPostScanToPreScan2DConverter::convert().

◆ setImagePreScanSettings()

void usImagePreScanSettings::setImagePreScanSettings ( const usImagePreScanSettings & preScanSettings )

inherited

Copy constructor.

Parameters

preScanSettings Pre-scan settings to copy.

Examples: tutorial-elastography-3D-basic.cpp, and tutorial-sonosite-confidence-map.cpp.

Definition at line 69 of file usImagePreScanSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usPostScanToPreScan2DConverter::convert(), usRFToPreScan2DConverter::convert(), usRFToPreScan3DConverter::convert(), usImageRF3D< Type >::getFrame(), usMHDSequenceReader::getImage(), usImageIo::read(), usScanlineConfidence2D::run(), and usImageRF2D< Type >::usImageRF2D().

◆ setProbeName()

void usTransducerSettings::setProbeName ( std::string probeName )

inherited

Setter for the probe name.

Parameters

probeName Name of the probe.

Examples: tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-sonosite-confidence-map.cpp, and tutorial-sonosite-grabber.cpp.

Definition at line 238 of file usTransducerSettings.cpp.

◆ setSamplingFrequency()

void usTransducerSettings::setSamplingFrequency ( const int samplingFrequency )

inherited

Setter for sampling frequency : frequency used to sample the echo of the ultrasound wave.

Parameters

samplingFrequency Frequency in Hz.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan2DXmlParser.cpp, testUsImagePostScan3DMhdParser.cpp, testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, and testUsImageRf3DMhdParser.cpp.

Definition at line 317 of file usTransducerSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), usImageIo::read(), usImageSettingsXmlParser::readMainClass(), and usImageSettingsXmlParser::setImageSettings().

◆ setScanLineNumber()

template<class Type >

void usImageRF2D< Type >::setScanLineNumber ( unsigned int scanLineNumber )

Set the transducer scan line number.

Resize also the image width that is equal to the scan line number.

Parameters

scanLineNumber Number of scan lines acquired by the transducer.

Definition at line 313 of file usImageRF2D.h.

References usTransducerSettings::setScanLineNumber().

◆ setScanLinePitch()

void usTransducerSettings::setScanLinePitch ( const double scanLinePitch )

inherited

Set the scan line pitch.

Parameters

scanLinePitch If the probe transducer is convex, this parameters refers to the angle in radians between two successive scan lines acquired by the transducer. If the probe is linear, this parameters refers to the distance in meters between two successive scan lines acquired by the transducer.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan2DXmlParser.cpp, testUsImagePostScan3DMhdParser.cpp, testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, testUsImageRf3DMhdParser.cpp, tutorial-rfFileToPreScanConversion.cpp, tutorial-sonosite-grabber.cpp, and tutorial-ultrasonix-qt-grabbing-RF-scan-conversion.cpp.

Definition at line 171 of file usTransducerSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), usImageIo::read(), usImageSettingsXmlParser::readMainClass(), and usImageSettingsXmlParser::setImageSettings().

◆ setTransducerConvexity()

void usTransducerSettings::setTransducerConvexity ( const bool isTransducerConvex )

inherited

Set the probe transducer type.

Parameters

isTransducerConvex True if the transducer is convex, false if the transducer is linear. Sets the probe transducer radius to 0 in case of a linear transducer.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan2DXmlParser.cpp, testUsImagePostScan3DMhdParser.cpp, testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, testUsImageRf3DMhdParser.cpp, tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-sonosite-confidence-map.cpp, tutorial-sonosite-grabber.cpp, and tutorial-ultrasonix-qt-grabbing-RF-scan-conversion.cpp.

Definition at line 189 of file usTransducerSettings.cpp.

References usTransducerSettings::isTransducerConvex().

Referenced by usMHDSequenceReader::acquire(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), usImageIo::read(), usImageSettingsXmlParser::readMainClass(), and usImageSettingsXmlParser::setImageSettings().

◆ setTransducerRadius()

void usTransducerSettings::setTransducerRadius ( const double transducerRadius )

inherited

Set the probe transducer radius (m).

Parameters

transducerRadius Probe transducer radius in meters. The probe transducer radius is set to 0 in case of a linear probe. See isTransducerConvex() and setProbeConvex(bool) for more information.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan2DXmlParser.cpp, testUsImagePostScan3DMhdParser.cpp, testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, testUsImageRf3DMhdParser.cpp, tutorial-rfFileToPreScanConversion.cpp, tutorial-servo-target-confidence.cpp, tutorial-servo-target.cpp, tutorial-sonosite-confidence-control.cpp, tutorial-sonosite-confidence-map.cpp, tutorial-sonosite-grabber.cpp, and tutorial-ultrasonix-qt-grabbing-RF-scan-conversion.cpp.

Definition at line 157 of file usTransducerSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), usImageIo::read(), usImageSettingsXmlParser::readMainClass(), and usImageSettingsXmlParser::setImageSettings().

◆ setTransducerSettings()

void usTransducerSettings::setTransducerSettings ( const usTransducerSettings & other )

inherited

Assignment operator.

Parameters

other Settings you want to assign.

See also: operator=()

Examples: tutorial-ultrasonix-qt-grabbing-RF-scan-conversion.cpp.

Definition at line 210 of file usTransducerSettings.cpp.

Referenced by usPreScanToPostScan3DConverter::convert().

◆ setTransmitFrequency()

void usTransducerSettings::setTransmitFrequency ( const int transmitFrequency )

inherited

Setter for transmit frequency : frequency of the ultrasound wave used.

Parameters

transmitFrequency Frequency in Hz.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan2DXmlParser.cpp, testUsImagePostScan3DMhdParser.cpp, testUsImagePreScan2DMhdParser.cpp, testUsImagePreScan2DXmlParser.cpp, testUsImagePreScan3DMhdParser.cpp, and testUsImageRf3DMhdParser.cpp.

Definition at line 326 of file usTransducerSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), usImageIo::read(), usImageSettingsXmlParser::readMainClass(), and usImageSettingsXmlParser::setImageSettings().

Friends And Related Function Documentation

◆ usNetworkGrabberRF2D

template<class Type >

friend class usNetworkGrabberRF2D

friend

Definition at line 114 of file usImageRF2D.h.

◆ usNetworkGrabberRF3D

template<class Type >

friend class usNetworkGrabberRF3D

friend

Definition at line 115 of file usImageRF2D.h.

◆ usRawFileParser

template<class Type >

friend class usRawFileParser

friend

Definition at line 113 of file usImageRF2D.h.

◆ usVirtualServer

template<class Type >

friend class usVirtualServer

friend

Definition at line 116 of file usImageRF2D.h.

Public Member Functions

Friends

Detailed Description

template<class Type> class usImageRF2D< Type >

Constructor & Destructor Documentation

◆ usImageRF2D() [1/4]

◆ usImageRF2D() [2/4]

◆ usImageRF2D() [3/4]

◆ usImageRF2D() [4/4]

◆ ~usImageRF2D()

Member Function Documentation

◆ getAxialResolution()

◆ getBitmap()

◆ getDepth()

◆ getFieldOfView()

◆ getHeight()

◆ getImagePreScanSettings()

◆ getNumberOfPixel()

◆ getProbeName()

◆ getRFSampleNumber()

◆ getSamplingFrequency()

◆ getScanLineNumber()

◆ getScanLinePitch()

◆ getSignal()

◆ getTransducerRadius()

◆ getTransducerSettings()

◆ getTransmitFrequency()

◆ getWidth()

◆ init()

◆ isTransducerConvex()

◆ operator!=()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=()

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ resize() [1/2]

◆ resize() [2/2]

◆ scanLineNumberIsSet()

◆ setAxialResolution()

◆ setDepth()

◆ setFieldOfView()

◆ setImagePreScanSettings()

◆ setProbeName()

◆ setSamplingFrequency()

◆ setScanLineNumber()

◆ setScanLinePitch()

◆ setTransducerConvexity()

◆ setTransducerRadius()

◆ setTransducerSettings()

◆ setTransmitFrequency()

Friends And Related Function Documentation

◆ usNetworkGrabberRF2D

◆ usNetworkGrabberRF3D

◆ usRawFileParser

◆ usVirtualServer

template<class Type>
class usImageRF2D< Type >