#include <visp3/ustk_core/usImagePostScan2D.h>

Inheritance diagram for usImagePostScan2D< Type >:

Public Member Functions
	usImagePostScan2D ()

	usImagePostScan2D (const vpImage< Type > &image, const usTransducerSettings &transducerSettings, double widthResolution=0.0, double heightResolution=0.0)

	usImagePostScan2D (const usImagePostScan2D< Type > &other)

virtual	~usImagePostScan2D ()

double	getHeightResolution () const

double	getWidthResolution () const

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

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

void	setData (const vpImage< Type > &image)

void	setHeightResolution (double heightResolution)

void	setWidthResolution (double widthResolution)

Inherited functionalities from usTransducerSettings
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	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	setScanLineNumber (unsigned int scanLineNumber)

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 usImagePostScan2D< Type >

2D post-scan ultrasound image.

This class represents a 2D post-scan ultrasound image. This image is nothing more than a vpImage that contains ultrasound 2D post-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 usImagePostScan2D image are the following:

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 two additional resolution parameters called that correspond to the size in meter of a pixel. They can be set using setWidthResolution() and setHeightResolution() respectively. To access to the values use getWidthResolution() and getHeightResolution() respectively.

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

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

#include <visp3/ustk_core/usImagePostScan2D.h>
 
int main()
{
  // 2D post-scan image settings
  unsigned int width = 320;
  unsigned int height = 240;
  double transducerRadius = 0.045;
  double scanLinePitch = 0.0012;
  unsigned int scanLineNumber = 256;
  bool isTransducerConvex = true;
  double widthResolution = 0.002;
  double heightResolution = 0.002;
 
  vpImage<unsigned char> I(height, width);
  usImagePostScan2D<unsigned char> postScan2d;
  postScan2d.setTransducerRadius(transducerRadius);
  postScan2d.setScanLinePitch(scanLinePitch);
  postScan2d.setScanLineNumber(scanLineNumber);
  postScan2d.setTransducerConvexity(isTransducerConvex);
  postScan2d.setWidthResolution(widthResolution);
  postScan2d.setHeightResolution(heightResolution);
  postScan2d.setData(I);
}

Definition at line 108 of file usImagePostScan2D.h.

Constructor & Destructor Documentation

◆ usImagePostScan2D() [1/3]

template<class Type >

usImagePostScan2D< Type >::usImagePostScan2D

Basic constructor, all parameters set to default values.

Definition at line 136 of file usImagePostScan2D.h.

◆ usImagePostScan2D() [2/3]

template<class Type >

usImagePostScan2D< Type >::usImagePostScan2D	(	const vpImage< Type > &	image,
		const usTransducerSettings &	transducerSettings,
		double	widthResolution = `0.0`,
		double	heightResolution = `0.0`
	)

Constructor from an image and transducer settings.

Parameters

image	Image containing the 2D post-scan data to copy.
transducerSettings	Transducer settings associated to the data.
heightResolution	Height (in meters) of a pixel.
widthResolution	Width (in meters) of a pixel.

Definition at line 160 of file usImagePostScan2D.h.

◆ usImagePostScan2D() [3/3]

template<class Type >

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

Copy constructor from an other 2D post-scan image.

Parameters

◆ ~usImagePostScan2D()

template<class Type >

usImagePostScan2D< Type >::~usImagePostScan2D

virtual

Destructor.

Definition at line 170 of file usImagePostScan2D.h.

Member Function Documentation

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

◆ getHeightResolution()

template<class Type >

double usImagePostScan2D< Type >::getHeightResolution

Getter for pixel height resolution.

Returns: Height of a pixel (in meters).

Definition at line 223 of file usImagePostScan2D.h.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usImagePostScan2D< Type >::operator=(), usImagePostScan2D< Type >::operator==(), usMHDSequenceWriter::write(), and usImageIo::write().

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

◆ getWidthResolution()

template<class Type >

double usImagePostScan2D< Type >::getWidthResolution

Getter for pixel width resolution.

Returns: Width of a pixel (in meters).

Definition at line 229 of file usImagePostScan2D.h.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usImagePostScan2D< Type >::operator=(), usImagePostScan2D< Type >::operator==(), usMHDSequenceWriter::write(), and usImageIo::write().

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

template<class Type >

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

Assignement operator.

Definition at line 175 of file usImagePostScan2D.h.

References usImagePostScan2D< Type >::getHeightResolution(), usImagePostScan2D< Type >::getWidthResolution(), and usTransducerSettings::operator=().

◆ operator==() [1/2]

template<class Type >

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

Comparison operator.

Definition at line 193 of file usImagePostScan2D.h.

References usImagePostScan2D< Type >::getHeightResolution(), and usImagePostScan2D< Type >::getWidthResolution().

◆ operator==() [2/2]

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

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

◆ setData()

template<class Type >

void usImagePostScan2D< Type >::setData ( const vpImage< Type > & image )

Setter that updates 2D post-scan image data.

Parameters

image Data to set.

Definition at line 214 of file usImagePostScan2D.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

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

◆ setHeightResolution()

template<class Type >

void usImagePostScan2D< Type >::setHeightResolution ( double heightResolution )

Setter for pixel height resolution.

Parameters

heightResolution Height of a pixel (in meters).

Definition at line 235 of file usImagePostScan2D.h.

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

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

void usTransducerSettings::setScanLineNumber ( unsigned int scanLineNumber )

inherited

Setter for the scan line number.

Parameters

scanLineNumber Number of scan lines acquired by the probe transducer.

Examples: testUsImagePostScan2DMhdParser.cpp, testUsImagePostScan3DMhdParser.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 222 of file usTransducerSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usPreScanToPostScan2DConverter::convert(), usMHDSequenceReader::getImage(), usImageIo::read(), usImageSettingsXmlParser::readMainClass(), usImagePreScan2D< Type >::resize(), usImagePreScan3D< Type >::resize(), usImageRF3D< Type >::resize(), usImageSettingsXmlParser::setImageSettings(), usImagePreScan2D< Type >::setScanLineNumber(), usImagePreScan3D< Type >::setScanLineNumber(), usImageRF2D< Type >::setScanLineNumber(), usImageRF3D< Type >::setScanLineNumber(), and usImagePreScan2D< Type >::usImagePreScan2D().

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

◆ setWidthResolution()

template<class Type >

void usImagePostScan2D< Type >::setWidthResolution ( double widthResolution )

Setter for pixel width resolution.

Parameters

widthResolution Width of a pixel (in meters).

Definition at line 244 of file usImagePostScan2D.h.

Referenced by usMHDSequenceReader::acquire(), usPreScanToPostScan2DConverter::convert(), usVTKConverter::convert(), usMHDSequenceReader::getImage(), and usImageIo::read().

Public Member Functions

Detailed Description

template<class Type> class usImagePostScan2D< Type >

Constructor & Destructor Documentation

◆ usImagePostScan2D() [1/3]

◆ usImagePostScan2D() [2/3]

◆ usImagePostScan2D() [3/3]

◆ ~usImagePostScan2D()

Member Function Documentation

◆ getDepth()

◆ getFieldOfView()

◆ getHeightResolution()

◆ getProbeName()

◆ getSamplingFrequency()

◆ getScanLineNumber()

◆ getScanLinePitch()

◆ getTransducerRadius()

◆ getTransducerSettings()

◆ getTransmitFrequency()

◆ getWidthResolution()

◆ isTransducerConvex()

◆ operator!=()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ scanLineNumberIsSet()

◆ setData()

◆ setDepth()

◆ setFieldOfView()

◆ setHeightResolution()

◆ setProbeName()

◆ setSamplingFrequency()

◆ setScanLineNumber()

◆ setScanLinePitch()

◆ setTransducerConvexity()

◆ setTransducerRadius()

◆ setTransducerSettings()

◆ setTransmitFrequency()

◆ setWidthResolution()

template<class Type>
class usImagePostScan2D< Type >