#include <visp3/ustk_core/usImagePostScan3D.h>

Inheritance diagram for usImagePostScan3D< Type >:

Public Types
enum	usMotorType { LinearMotor = 0 , TiltingMotor = 1 , RotationalMotor = 2 }

Public Member Functions
	usImagePostScan3D ()

	usImagePostScan3D (const usImage3D< Type > &image, const usTransducerSettings &transducerSettings, const usMotorSettings &motorSettings, double spacingX, double spacingY, double spacingZ, double scanLineDepth)

	usImagePostScan3D (const usImagePostScan3D &other)

virtual	~usImagePostScan3D ()

double	getElementSpacingX () const

double	getElementSpacingY () const

double	getElementSpacingZ () const

double	getScanLineDepth () const

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

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

void	setData (const usImage3D< Type > &image3D)

void	setElementSpacingX (double elementSpacingX)

void	setElementSpacingY (double elementSpacingY)

void	setElementSpacingZ (double elementSpacingZ)

void	setScanLineDepth (double scanLineDepth)

Inherited functionalities from usImage3D
Type *	getConstData () const

Type *	getData ()

Type *	getData (unsigned int i, unsigned int j, unsigned int k)

unsigned int	getWidth () const

unsigned int	getHeight () const

unsigned int	getNumberOfFrames () const

unsigned int	getSize () const

void	initData (Type value)

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

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

void	operator() (unsigned int i, unsigned int j, unsigned int k, Type value)

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

void	setData (Type *data, int numberOfVoxels)

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)

Inherited functionalities from usMotorSettings
unsigned int	getFrameNumber () const

double	getFramePitch () const

double	getMotorFieldOfView () const

double	getMotorRadius () const

usMotorSettings	getMotorSettings () const

usMotorType	getMotorType () const

bool	frameNumberIsSet () const

bool	operator== (const usMotorSettings &other)

bool	operator!= (const usMotorSettings &other)

void	setFrameNumber (unsigned int frameNumber)

void	setFramePitch (double framePitch)

void	setMotorFieldOfView (double motorFieldOfView)

void	setMotorRadius (double motorRadius)

void	setMotorSettings (const usMotorSettings &other)

void	setMotorType (const usMotorType &motorType)

Detailed Description

template<class Type>
class usImagePostScan3D< Type >

3D post-scan ultrasound image.

This class represents a 3D post-scan ultrasound image. This image is nothing more than an usImage3D that contains 3D post-scan data and additional settings that give information about the acquisition process.

The settings associated to an usImagePostScan3D image are the:

transducer settings implemented in 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().

the motor settings implemented in usMotorSettings that are:
- the type of motor used to move the transducer: linear, tilting (small rotation) or rotationnal (360° rotation). This type is defined in usMotorType and could be set using setMotorType(). To retrieve the motor type use getMotorType().
- the motor radius $R_{_M}$ (value set to zero for a linear motor). This value could be set using setMotorRadius() or get using getMotorRadius().
- the frame pitch that corresponds to the angle $\alpha_{_F}$ (in radians) between to successive frame acquisitions when the motor is convex, or to the distance $d_{_F}$ (in meters) when the motor is linear. To set this value use setFramePitch() and to access use getFramePitch().
- the frame number $n_{_F}$ that corresponds to the number of frames acquired by the probe to generate the 3D volume. This number is set using setFrameNumber() and could be retrieved using getFrameNumber().

The following figure summarize these settings and shows the structure of an usImagePostScan3D image when the motor is linear:

This other figure summarize these settings and shows the structure of an usImagePostScan3D image when the motor is convex:

The following example shows how to build a 3D post-scan ultrasound image from an usImage3D, and from acquisiton settings.

#include <visp3/ustk_core/usImagePostScan3D.h>
 
int main()
{
  // Transducer settings
  unsigned int BModeSampleNumber = 200;
  double transducerRadius = 0.045;;
  double scanLinePitch = 0.01;
  unsigned int scanLineNumber = 256;
  bool isTransducerConvex = true;
  double axialResolution = 0.001;
 
  // Motor settings
  double motorRadius = 0.004;
  double framePitch = 0.06;
  unsigned int frameNumber = 10;
  usMotorSettings::usMotorType motorType = usMotorSettings::LinearMotor;
 
  // Post-scan data settings
  unsigned int dimX = 200;
  unsigned int dimY = 200;
  unsigned int dimZ = 20;
 
  usTransducerSettings transducerSettings;
  transducerSettings.setTransducerRadius(transducerRadius);
  transducerSettings.setScanLinePitch(scanLinePitch);
  transducerSettings.setScanLineNumber(scanLineNumber);
  transducerSettings.setTransducerConvexity(isTransducerConvex);
 
  usMotorSettings motorSettings;
  motorSettings.setMotorRadius(motorRadius);
  motorSettings.setFramePitch(framePitch);
  motorSettings.setFrameNumber(frameNumber);
  motorSettings.setMotorType(motorType);
 
  usImage3D<unsigned char> I(dimX, dimY, dimZ);
 
  usImagePostScan3D<unsigned char> postScan3d;
  postScan3d.setData(I);
  postScan3d.setTransducerSettings(transducerSettings);
  postScan3d.setMotorSettings(motorSettings);
}

Definition at line 142 of file usImagePostScan3D.h.

Member Enumeration Documentation

◆ usMotorType

enum usMotorSettings::usMotorType

inherited

Enumerator for motor type

Enumerator
LinearMotor	Case of a linear motor.
TiltingMotor	Case of a tilting motor (small rotation).
RotationalMotor	Case of a roatational motor (360° rotation).

Definition at line 81 of file usMotorSettings.h.

Constructor & Destructor Documentation

◆ usImagePostScan3D() [1/3]

template<class Type >

usImagePostScan3D< Type >::usImagePostScan3D

Basic constructor, all parameters set to default values.

Definition at line 180 of file usImagePostScan3D.h.

◆ usImagePostScan3D() [2/3]

template<class Type >

usImagePostScan3D< Type >::usImagePostScan3D	(	const usImage3D< Type > &	image,
		const usTransducerSettings &	transducerSettings,
		const usMotorSettings &	motorSettings,
		double	spacingX,
		double	spacingY,
		double	spacingZ,
		double	scanLineDepth
	)

Constructor from 3D image data, transducer and motor settings.

Parameters

image	3D data to copy.
transducerSettings	Transducer settings to copy.
motorSettings	Motor settings to copy.
spacingX	distancee (in meters) between two voxels on X-axis
spacingY	distancee (in meters) between two voxels on Y-axis
spacingZ	distancee (in meters) between two voxels on Z-axis
scanLineDepth	distancee (in meters) between first and last voxel of a scan line.

Definition at line 209 of file usImagePostScan3D.h.

◆ usImagePostScan3D() [3/3]

template<class Type >

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

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

Parameters

◆ ~usImagePostScan3D()

template<class Type >

usImagePostScan3D< Type >::~usImagePostScan3D

virtual

Destructor.

Definition at line 221 of file usImagePostScan3D.h.

Member Function Documentation

◆ frameNumberIsSet()

bool usMotorSettings::frameNumberIsSet ( ) const

inherited

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

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

Definition at line 200 of file usMotorSettings.cpp.

Referenced by usMotorSettings::operator=(), and usMotorSettings::operator==().

◆ getConstData()

template<class Type >

Type* usImage3D< Type >::getConstData ( ) const

inlineinherited

Get the pointer to the const data container.

Returns: The pointer to the const data container.

Definition at line 104 of file usImage3D.h.

Referenced by usVolumeProcessing::absoluteDifference(), usVTKConverter::convert(), usPreScanToPostScan3DConverter::convert(), usVolumeProcessing::difference(), usVolumeProcessing::frangi(), usVolumeProcessing::gradient(), usVolumeProcessing::hessian(), usVolumeProcessing::max(), usVolumeProcessing::min(), usVolumeProcessing::norm(), and usImage3D< Type >::operator==().

◆ getData() [1/2]

template<class Type >

Type* usImage3D< Type >::getData ( )

inlineinherited

Get the pointer to the data container.

Returns: The pointer to the data container.

Definition at line 110 of file usImage3D.h.

Referenced by usVolumeProcessing::absoluteDifference(), usPreScanToPostScan3DConverter::convert(), usVolumeProcessing::difference(), usVolumeProcessing::frangi(), usVolumeProcessing::gradient(), usVolumeProcessing::hessian(), and usVolumeProcessing::norm().

◆ getData() [2/2]

template<class Type >

Type* usImage3D< Type >::getData	(	unsigned int	i,
		unsigned int	j,
		unsigned int	k
	)

inlineinherited

Get the pointer to the data container for specified position in the volume.

Parameters

i	Index on i-axis to acess
j	Index on j-axis to acess
k	Index on k-axis to acess

Returns: The pointer to the voxel specified indexes.

Definition at line 119 of file usImage3D.h.

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

◆ getElementSpacingX()

template<class Type >

double usImagePostScan3D< Type >::getElementSpacingX

Get the element spacing along the x-axis.

Returns: The element spacing along the x-axis, in meters.

Definition at line 280 of file usImagePostScan3D.h.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usVTKConverter::convert(), usImagePostScan3D< Type >::operator=(), usImagePostScan3D< Type >::operator==(), and usImageIo::write().

◆ getElementSpacingY()

template<class Type >

double usImagePostScan3D< Type >::getElementSpacingY

Get the element spacing along the y-axis.

Returns: The element spacing along the y-axis, in meters.

Definition at line 286 of file usImagePostScan3D.h.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usVTKConverter::convert(), usImagePostScan3D< Type >::operator=(), usImagePostScan3D< Type >::operator==(), and usImageIo::write().

◆ getElementSpacingZ()

template<class Type >

double usImagePostScan3D< Type >::getElementSpacingZ

Get the element spacing along the z-axis.

Returns: The element spacing along the z-axis, in meters.

Definition at line 292 of file usImagePostScan3D.h.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usVTKConverter::convert(), usImagePostScan3D< Type >::operator=(), usImagePostScan3D< Type >::operator==(), and usImageIo::write().

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

◆ getFrameNumber()

unsigned int usMotorSettings::getFrameNumber ( ) const

inherited

Getter for frame number.

Returns: The number of frames used for 3D acquisition.

Definition at line 159 of file usMotorSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), usMotorSettings::operator=(), usMotorSettings::operator==(), usImagePreScan3D< Type >::usImagePreScan3D(), usImageRF3D< Type >::usImageRF3D(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getFramePitch()

double usMotorSettings::getFramePitch ( ) const

inherited

Get the frame pitch (radians or meters).

Returns: framePitch Frame pitch between two sucessive frames. In meters if motorType is linear, in radians otherwise.

Definition at line 153 of file usMotorSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usMotorSettings::operator=(), usMotorSettings::operator==(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getHeight()

template<class Type >

unsigned int usImage3D< Type >::getHeight ( ) const

inlineinherited

◆ getMotorFieldOfView()

double usMotorSettings::getMotorFieldOfView ( ) const

inherited

Getter for the motor field of view (based on frame number and pitch).

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

Definition at line 206 of file usMotorSettings.cpp.

◆ getMotorRadius()

double usMotorSettings::getMotorRadius ( ) const

inherited

Get the motor radius (m).

Returns: motorRadius Motor radius in meters.

Definition at line 141 of file usMotorSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usMotorSettings::operator=(), usMotorSettings::operator==(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getMotorSettings()

usMotorSettings usMotorSettings::getMotorSettings ( ) const

inherited

Definition at line 234 of file usMotorSettings.cpp.

◆ getMotorType()

usMotorSettings::usMotorType usMotorSettings::getMotorType ( ) const

inherited

Get the motor type : linear, titling (small rotation angle) or rotational (360° rotation).

Returns: usMotorType to get the motor type.

Definition at line 178 of file usMotorSettings.cpp.

Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPreScanToPostScan3DConverter::init(), usMotorSettings::operator=(), usMotorSettings::operator==(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().

◆ getNumberOfFrames()

template<class Type >

unsigned int usImage3D< Type >::getNumberOfFrames ( ) const

inlineinherited

Get the volume size along the k-axis (frame nubmer).

Returns: The k-axis size in voxels, in number of voxels.

Definition at line 137 of file usImage3D.h.

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

◆ getScanLineDepth()

template<class Type >

double usImagePostScan3D< Type >::getScanLineDepth

Get the scan line depth in meters.

Returns: The scan line depth, in meters.

Definition at line 298 of file usImagePostScan3D.h.

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

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

◆ getSize()

template<class Type >

unsigned int usImage3D< Type >::getSize ( ) const

inlineinherited

Get the volume size.

Returns: The number of voxels in the volume.

Definition at line 143 of file usImage3D.h.

Referenced by usVolumeProcessing::absoluteDifference(), usVolumeProcessing::difference(), usVolumeProcessing::frangi(), usVolumeProcessing::gradient(), usVolumeProcessing::hessian(), usVolumeProcessing::max(), usVolumeProcessing::min(), and usVolumeProcessing::norm().

◆ 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 usImage3D< Type >::getWidth ( ) const

inlineinherited

Get the volume width.

Returns: The volume width, in number of voxels.

Definition at line 125 of file usImage3D.h.

◆ initData()

template<class Type >

void usImage3D< Type >::initData ( Type value )

inherited

Initialize the data container with the specified value.

Parameters

value The data

Definition at line 367 of file usImage3D.h.

Referenced by usVolumeProcessing::applyFilter(), usPreScanToPostScan3DConverter::convert(), and usImage3D< Type >::usImage3D().

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

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

inherited

Compare two motor settings.

Parameters

other Motor settings to compare.

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

Definition at line 116 of file usMotorSettings.cpp.

References usMotorSettings::operator==().

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

template<class Type >

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

inlineinherited

Access operator.

Parameters

i	Index on i-axis to acess
j	Index on j-axis to acess
k	Index on k-axis to acess

Definition at line 169 of file usImage3D.h.

◆ operator()() [2/2]

template<class Type >

void usImage3D< Type >::operator()	(	unsigned int	i,
		unsigned int	j,
		unsigned int	k,
		Type	value
	)

inlineinherited

Modification operator.

Parameters

i	Index on i-axis to modify
j	Index on j-axis to modify
k	Index on k-axis to modify
value	Value to insert at the desired index

Definition at line 181 of file usImage3D.h.

◆ operator=()

template<class Type >

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

Assignement operator.

Definition at line 226 of file usImagePostScan3D.h.

References usImagePostScan3D< Type >::getElementSpacingX(), usImagePostScan3D< Type >::getElementSpacingY(), usImagePostScan3D< Type >::getElementSpacingZ(), usImagePostScan3D< Type >::getScanLineDepth(), usImage3D< Type >::operator=(), usMotorSettings::operator=(), and usTransducerSettings::operator=().

◆ operator==() [1/4]

template<class Type >

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

inherited

Comparison operator.

Parameters

other The 3d image to compare. Comparing image parameters, and all volume voxel by voxel.

Definition at line 332 of file usImage3D.h.

References usImage3D< Type >::getConstData(), usImage3D< Type >::getHeight(), usImage3D< Type >::getNumberOfFrames(), and usImage3D< Type >::getWidth().

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

◆ operator==() [2/4]

template<class Type >

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

Comparison operator.

Definition at line 247 of file usImagePostScan3D.h.

References usImagePostScan3D< Type >::getElementSpacingX(), usImagePostScan3D< Type >::getElementSpacingY(), usImagePostScan3D< Type >::getElementSpacingZ(), usImagePostScan3D< Type >::getScanLineDepth(), usImage3D< Type >::operator==(), usMotorSettings::operator==(), and usTransducerSettings::operator==().

◆ operator==() [3/4]

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

inherited

Compare two motor settings.

Parameters

other Motor settings to compare.

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

Definition at line 104 of file usMotorSettings.cpp.

References usMotorSettings::frameNumberIsSet(), usMotorSettings::getFrameNumber(), usMotorSettings::getFramePitch(), usMotorSettings::getMotorRadius(), and usMotorSettings::getMotorType().

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

◆ operator==() [4/4]

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

template<class Type >

void usImage3D< Type >::resize	(	unsigned int	height,
		unsigned int	width,
		unsigned int	numberOfFrames
	)

inherited

Resize the image if needed (if new dimensions differ from old ones).

Parameters

height	The volume size along i axis.
width	The volume size along j axis.
numberOfFrames	The volume size along k axis.

Definition at line 376 of file usImage3D.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=().

◆ setData() [1/2]

template<class Type >

void usImagePostScan3D< Type >::setData ( const usImage3D< Type > & image3D )

Setter for image data.

Parameters

image3D 3D image data you want to set.

Definition at line 271 of file usImagePostScan3D.h.

References usImage3D< Type >::operator=().

◆ setData() [2/2]

template<class Type >

void usImage3D< Type >::setData	(	Type *	data,
		int	numberOfVoxels
	)

inherited

Set the data container.

Parameters

data	The data container.
numberOfVoxels	The number of voxels in the image.

Definition at line 354 of file usImage3D.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().

◆ setElementSpacingX()

template<class Type >

void usImagePostScan3D< Type >::setElementSpacingX ( double elementSpacingX )

Set the element spacing along the x-axis.

Parameters

elementSpacingX The element spacing along the x-axis, in meters.

Definition at line 304 of file usImagePostScan3D.h.

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

◆ setElementSpacingY()

template<class Type >

void usImagePostScan3D< Type >::setElementSpacingY ( double elementSpacingY )

Set the element spacing along the y-axis.

Parameters

elementSpacingY The element spacing along the y-axis, in meters.

Definition at line 313 of file usImagePostScan3D.h.

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

◆ setElementSpacingZ()

template<class Type >

void usImagePostScan3D< Type >::setElementSpacingZ ( double elementSpacingZ )

Set the element spacing along the z-axis.

Parameters

elementSpacingZ The element spacing along the z-axis, in meters.

Definition at line 322 of file usImagePostScan3D.h.

Referenced by usMHDSequenceReader::acquire(), usPreScanToPostScan3DConverter::convert(), 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::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().

◆ setFrameNumber()

void usMotorSettings::setFrameNumber ( unsigned int frameNumber )

inherited

Setter for frame number.

Parameters

frameNumber The number of frames used for 3D acquisition.

Examples: testUsImagePostScan3DMhdParser.cpp.

Definition at line 190 of file usMotorSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), usImageIo::read(), usImagePreScan3D< Type >::resize(), usImageRF3D< Type >::resize(), usImagePreScan3D< Type >::setFrameNumber(), and usImageRF3D< Type >::setFrameNumber().

◆ setFramePitch()

void usMotorSettings::setFramePitch ( double framePitch )

inherited

Set the frame angle (rad).

Parameters

framePitch Frame angle of the probe in radians.

Examples: testUsImagePostScan3DMhdParser.cpp, and testUsImagePreScan3DMhdParser.cpp.

Definition at line 147 of file usMotorSettings.cpp.

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

◆ setMotorFieldOfView()

void usMotorSettings::setMotorFieldOfView ( double motorFieldOfView )

inherited

Setter for the motor field of view (updates the frame pitch).

Parameters

motorFieldOfView The motor field of view in radians if the motor is convex, in meters if the motor is linear.

Warning: Be sure to use setFrameNumber() to update the frame number before the field of view since this method computes the frame pitch from the field of view and the frame pitch.
usMotorSettings motorSettings;

motorSettings.setFrameNumber(128);

motorSettings.setMotorFieldOfView(vpMath::rad(57.0)); // field of view is 57 deg

usMotorSettings::setMotorFieldOfView
void setMotorFieldOfView(double motorFieldOfView)
Definition: usMotorSettings.cpp:226

Definition at line 226 of file usMotorSettings.cpp.

◆ setMotorRadius()

void usMotorSettings::setMotorRadius ( double motorRadius )

inherited

Set the motor radius (m).

Parameters

motorRadius Motor radius in meters.

Examples: testUsImagePostScan3DMhdParser.cpp, and testUsImagePreScan3DMhdParser.cpp.

Definition at line 135 of file usMotorSettings.cpp.

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

◆ setMotorSettings()

void usMotorSettings::setMotorSettings ( const usMotorSettings & other )

inherited

Set the motor settings from other motor settings.

Returns: usMotorSettings Settings to copy.

Definition at line 184 of file usMotorSettings.cpp.

Referenced by usMHDSequenceReader::acquire(), usRFToPreScan3DConverter::convert(), usPreScanToPostScan3DConverter::convert(), usMHDSequenceReader::getImage(), and usImageIo::read().

◆ setMotorType()

void usMotorSettings::setMotorType ( const usMotorType & motorType )

inherited

Set the motor type : convex or linear (from probe type used to acquire the image).

Parameters

motorType Motor type to specify the motor type : LinearMotor, TiltingMotor (for a rotative motor), RotationalMotor (for a 360° rotative motor).

Examples: testUsImagePostScan3DMhdParser.cpp, and testUsImagePreScan3DMhdParser.cpp.

Definition at line 166 of file usMotorSettings.cpp.

References usMotorSettings::LinearMotor, and usMotorSettings::setMotorRadius().

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

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

◆ setScanLineDepth()

template<class Type >

void usImagePostScan3D< Type >::setScanLineDepth ( double scanLineDepth )

Set the scan line depth (distance between first and last pixel of a scan line).

Parameters

scanLineDepth The scan line depth, in meters.

Definition at line 331 of file usImagePostScan3D.h.

Referenced by usPreScanToPostScan3DConverter::convert().

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

Public Types

Public Member Functions

Detailed Description

template<class Type> class usImagePostScan3D< Type >

Member Enumeration Documentation

◆ usMotorType

Constructor & Destructor Documentation

◆ usImagePostScan3D() [1/3]

◆ usImagePostScan3D() [2/3]

◆ usImagePostScan3D() [3/3]

◆ ~usImagePostScan3D()

Member Function Documentation

◆ frameNumberIsSet()

◆ getConstData()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getDepth()

◆ getElementSpacingX()

◆ getElementSpacingY()

◆ getElementSpacingZ()

◆ getFieldOfView()

◆ getFrameNumber()

◆ getFramePitch()

◆ getHeight()

◆ getMotorFieldOfView()

◆ getMotorRadius()

◆ getMotorSettings()

◆ getMotorType()

◆ getNumberOfFrames()

◆ getProbeName()

◆ getSamplingFrequency()

◆ getScanLineDepth()

◆ getScanLineNumber()

◆ getScanLinePitch()

◆ getSize()

◆ getTransducerRadius()

◆ getTransducerSettings()

◆ getTransmitFrequency()

◆ getWidth()

◆ initData()

◆ isTransducerConvex()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=()

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ resize()

◆ scanLineNumberIsSet()

◆ setData() [1/2]

◆ setData() [2/2]

◆ setDepth()

◆ setElementSpacingX()

◆ setElementSpacingY()

◆ setElementSpacingZ()

◆ setFieldOfView()

◆ setFrameNumber()

◆ setFramePitch()

◆ setMotorFieldOfView()

◆ setMotorRadius()

◆ setMotorSettings()

◆ setMotorType()

◆ setProbeName()

◆ setSamplingFrequency()

◆ setScanLineDepth()

◆ setScanLineNumber()

◆ setScanLinePitch()

◆ setTransducerConvexity()

◆ setTransducerRadius()

◆ setTransducerSettings()

◆ setTransmitFrequency()

template<class Type>
class usImagePostScan3D< Type >