#include <visp3/ustk_core/usImagePreScan2D.h>

Inheritance diagram for usImagePreScan2D< Type >:

Public Member Functions
	usImagePreScan2D ()

	usImagePreScan2D (unsigned int height, unsigned int width)

	usImagePreScan2D (const vpImage< Type > &image, const usImagePreScanSettings &preScanSettings)

	usImagePreScan2D (const usImagePreScan2D &other)

virtual	~usImagePreScan2D ()

unsigned int	getBModeSampleNumber () const

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

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

bool	operator!= (const usImagePreScan2D< Type > &other)

void	setData (const vpImage< Type > image)

void	setScanLineNumber (unsigned int scanLineNumber)

void	resize (const unsigned int h, const unsigned int w)

void	resize (const unsigned int h, const unsigned int w, 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)

Detailed Description

template<class Type>
class usImagePreScan2D< Type >

2D pre-scan ultrasound image.

This class represents a 2D pre-scan ultrasound image. This image is nothing more than a vpImage that contains ultrasound 2D pre-scan data and additional settings that give information about the acquisition process done by the transducer. The bitmap storage is done in row-major.

The settings associated to an usImagePreScan2D 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 B-Mode 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 usImagePreScan2D image:

The following example shows how to build a 2D pre-scan ultrasound image from a vpImage and from acquisition settings.

#include <visp3/ustk_core/usImagePreScan2D.h>
 
int main()
{
  // 2D pre-scan image settings
  unsigned int BModeSampleNumber = 200;
  double transducerRadius = 0.007;
  double scanLinePitch = 0.04;
  unsigned int scanLineNumber = 256;
  bool isTransducerConvex = true;
  double axialResolution = 0.005;
 
  vpImage<unsigned char> I(BModeSampleNumber, scanLineNumber);
  usImagePreScan2D<unsigned char> preScan2d;
  preScan2d.setTransducerRadius(transducerRadius);
  preScan2d.setScanLinePitch(scanLinePitch);
  preScan2d.setScanLineNumber(scanLineNumber);
  preScan2d.setTransducerConvexity(isTransducerConvex);
  preScan2d.setAxialResolution(axialResolution);
  preScan2d.setData(I);
}

Definition at line 105 of file usImagePreScan2D.h.

Constructor & Destructor Documentation

◆ usImagePreScan2D() [1/4]

template<class Type >

usImagePreScan2D< Type >::usImagePreScan2D

Basic constructor, all settings set to default values.

Definition at line 141 of file usImagePreScan2D.h.

◆ usImagePreScan2D() [2/4]

template<class Type >

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

Constructor from image size.

Parameters

height	Image height.
width	Image width.

Definition at line 159 of file usImagePreScan2D.h.

References usTransducerSettings::setScanLineNumber().

◆ usImagePreScan2D() [3/4]

template<class Type >

usImagePreScan2D< Type >::usImagePreScan2D	(	const vpImage< Type > &	image,
		const usImagePreScanSettings &	preScanSettings
	)

Constructor from an image and pre-scan settings.

Parameters

image	Image you want to set.
preScanSettings	Pre-scan settings you want to set.

Definition at line 171 of file usImagePreScan2D.h.

References usTransducerSettings::getScanLineNumber().

◆ usImagePreScan2D() [4/4]

template<class Type >

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

Copy constructor.

Parameters

other 2D pre-scan image you want to copy.

Definition at line 148 of file usImagePreScan2D.h.

◆ ~usImagePreScan2D()

template<class Type >

usImagePreScan2D< Type >::~usImagePreScan2D

virtual

Destructor.

Definition at line 181 of file usImagePreScan2D.h.

Member Function Documentation

◆ getAxialResolution()

double usImagePreScanSettings::getAxialResolution ( ) const

inherited

Axial resolution getter.

Examples: testUsImageRf3DMhdParser.cpp.

Definition at line 120 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().

◆ getBModeSampleNumber()

template<class Type >

unsigned int usImagePreScan2D< Type >::getBModeSampleNumber

Get the number of A-samples of B-Mode samples in a scan line.

Returns: BModeSampleNumber Number of A-samples in a scan line.

Definition at line 227 of file usImagePreScan2D.h.

Referenced by usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usImageIo::read(), and usImageIo::write().

◆ 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().

◆ getImagePreScanSettings()

usImagePreScanSettings usImagePreScanSettings::getImagePreScanSettings ( ) const

inherited

Definition at line 122 of file usImagePreScanSettings.cpp.

◆ 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.

◆ 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().

◆ 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().

◆ 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!=() [1/2]

template<class Type >

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

Comparison operator.

Definition at line 208 of file usImagePreScan2D.h.

◆ operator!=() [2/2]

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=()

template<class Type >

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

Copy operator.

Definition at line 186 of file usImagePreScan2D.h.

References usImagePreScanSettings::operator=().

◆ operator==() [1/3]

template<class Type >

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

Comparison operator.

Definition at line 200 of file usImagePreScan2D.h.

◆ operator==() [2/3]

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

inherited

Comparison operator.

Parameters

other usImagePreScanSettings to compare with.

Definition at line 97 of file usImagePreScanSettings.cpp.

References usImagePreScanSettings::getAxialResolution().

Referenced by usImageRF2D< Type >::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 usImagePreScan2D< Type >::resize	(	const unsigned int	h,
		const unsigned int	w
	)

Resize the 2D pre-scan image.

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

Parameters

h	Image height.
w	Image width.

Definition at line 261 of file usImagePreScan2D.h.

References usTransducerSettings::setScanLineNumber().

Referenced by usMHDSequenceReader::acquire(), usPostScanToPreScan2DConverter::convert(), usRFToPreScan2DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usImagePreScan3D< Type >::getFrame(), usMHDSequenceReader::getImage(), usImageIo::read(), and usScanlineConfidence2D::run().

◆ resize() [2/2]

template<class Type >

void usImagePreScan2D< Type >::resize	(	const unsigned int	h,
		const unsigned int	w,
		const Type	val
	)

Resize the 2D pre-scan image and set all the pixel to a given value.

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

Parameters

h	Image height.
w	Image width.
val	Value set to each pixel.

Definition at line 275 of file usImagePreScan2D.h.

References usTransducerSettings::setScanLineNumber().

◆ 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 115 of file usImagePreScanSettings.cpp.

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

◆ setData()

template<class Type >

void usImagePreScan2D< Type >::setData ( const vpImage< Type > image )

Setter for the image data.

Parameters

image The image to set.

Definition at line 236 of file usImagePreScan2D.h.

◆ 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 71 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 usImagePreScan2D< 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 248 of file usImagePreScan2D.h.

References usTransducerSettings::setScanLineNumber().

Referenced by usPostScanToPreScan2DConverter::convert(), and usImageIo::read().

◆ 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().

Public Member Functions

Detailed Description

template<class Type> class usImagePreScan2D< Type >

Constructor & Destructor Documentation

◆ usImagePreScan2D() [1/4]

◆ usImagePreScan2D() [2/4]

◆ usImagePreScan2D() [3/4]

◆ usImagePreScan2D() [4/4]

◆ ~usImagePreScan2D()

Member Function Documentation

◆ getAxialResolution()

◆ getBModeSampleNumber()

◆ getDepth()

◆ getFieldOfView()

◆ getImagePreScanSettings()

◆ getProbeName()

◆ getSamplingFrequency()

◆ getScanLineNumber()

◆ getScanLinePitch()

◆ getTransducerRadius()

◆ getTransducerSettings()

◆ getTransmitFrequency()

◆ isTransducerConvex()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=()

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ resize() [1/2]

◆ resize() [2/2]

◆ scanLineNumberIsSet()

◆ setAxialResolution()

◆ setData()

◆ setDepth()

◆ setFieldOfView()

◆ setImagePreScanSettings()

◆ setProbeName()

◆ setSamplingFrequency()

◆ setScanLineNumber()

◆ setScanLinePitch()

◆ setTransducerConvexity()

◆ setTransducerRadius()

◆ setTransducerSettings()

◆ setTransmitFrequency()

template<class Type>
class usImagePreScan2D< Type >