UsTK : Ultrasound ToolKit
version 2.0.1 under development (2024-11-21)
|
#include <visp3/ustk_core/usTransducerSettings.h>
Public Member Functions | |
usTransducerSettings () | |
usTransducerSettings (double transducerRadius, double scanLinePitch, unsigned int scanLineNumber, bool transducerConvex, double depth, int transmitFrequency=0, int samplingFrequency=0) | |
usTransducerSettings (const usTransducerSettings &other) | |
virtual | ~usTransducerSettings () |
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 |
usTransducerSettings & | operator= (const usTransducerSettings &other) |
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) |
VISP_EXPORT std::ostream & | operator<< (std::ostream &out, const usTransducerSettings &other) |
Generic class for 2D ultrasound data common settings associated to the type of probe transducer used during acquisition.
This class represents ultrasound transducer common settings which are:
Knowing the scan line pitch ( or ) and the number of scan lines , you can get the transducer field of view using getFieldOfView().
The following figure summerize these transducer settings.
Definition at line 80 of file usTransducerSettings.h.
usTransducerSettings::usTransducerSettings | ( | ) |
Basic constructor, all settings set to default.
Definition at line 50 of file usTransducerSettings.cpp.
usTransducerSettings::usTransducerSettings | ( | double | transducerRadius, |
double | scanLinePitch, | ||
unsigned int | scanLineNumber, | ||
bool | transducerConvex, | ||
double | depth, | ||
int | transmitFrequency = 0 , |
||
int | samplingFrequency = 0 |
||
) |
Full constructor with all the settings availables:
transducerRadius | Distance between the center point of the transducer and the first pixel arc acquired. Value in meters (m). |
scanLinePitch | Radius or distance between 2 successives scan lines acquired by the probe transducer; in radians (rad) if the probe is convex, or in meters (m) if the probe is linear. |
scanLineNumber | Number of scan lines acquired by the probe transducer. |
transducerConvex | Boolean to specify if the probe transducer is convex (true) or linear (false). |
depth | Distance in meters between first and last pixel of a scan line. |
samplingFrequency | : frequency used to sample the ultrasound wave during the acquisition. |
transmitFrequency | : frequency of the ultrasound wave used to create the image. |
Definition at line 69 of file usTransducerSettings.cpp.
usTransducerSettings::usTransducerSettings | ( | const usTransducerSettings & | other | ) |
Copy constructor.
other | Settings to copy. |
Definition at line 82 of file usTransducerSettings.cpp.
|
virtual |
Destructor.
Definition at line 87 of file usTransducerSettings.cpp.
double usTransducerSettings::getDepth | ( | ) | const |
Setter for depth : distance in meters between first and last pixel in a scan line.
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 operator=().
double usTransducerSettings::getFieldOfView | ( | ) | const |
Getter for the transducer field of view (based on scan line number and pitch).
Definition at line 244 of file usTransducerSettings.cpp.
Referenced by usPostScanToPreScan2DConverter::convert(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usImageDisplayWidgetRobotControl::updateConfidenceAngle(), and usImageDisplayWidgetQmlOverlayServoing::updateConfidenceAngle().
std::string usTransducerSettings::getProbeName | ( | ) | const |
Getter for the probe name.
Definition at line 232 of file usTransducerSettings.cpp.
int usTransducerSettings::getSamplingFrequency | ( | ) | const |
Getter for sampling frequency : frequency used to sample the echo of the ultrasound wave.
Definition at line 305 of file usTransducerSettings.cpp.
Referenced by operator=(), operator==(), usImageIo::read(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().
unsigned int usTransducerSettings::getScanLineNumber | ( | ) | const |
Getter for the scan line number.
Definition at line 216 of file usTransducerSettings.cpp.
Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), operator=(), operator==(), usImageIo::read(), usImagePreScan2D< Type >::usImagePreScan2D(), usImagePreScan3D< Type >::usImagePreScan3D(), usImageRF2D< Type >::usImageRF2D(), usImageRF3D< Type >::usImageRF3D(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().
double usTransducerSettings::getScanLinePitch | ( | ) | const |
Get the scan line pitch (m).
Definition at line 182 of file usTransducerSettings.cpp.
Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan3D::includeFrameInVolume(), usNetworkGrabberRF3D::includeFrameInVolume(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), operator=(), operator==(), usImageIo::read(), usImageDisplayWidgetRobotControl::updateConfidenceAngle(), usImageDisplayWidgetQmlOverlayServoing::updateConfidenceAngle(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().
double usTransducerSettings::getTransducerRadius | ( | ) | const |
Get the probe transducer radius (m).
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(), operator=(), operator==(), usImageIo::read(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().
usTransducerSettings usTransducerSettings::getTransducerSettings | ( | ) | const |
Getter for transducer settings : allows heritating classes to get the transducer settings.
Definition at line 295 of file usTransducerSettings.cpp.
int usTransducerSettings::getTransmitFrequency | ( | ) | const |
Getter for transmit frequency : frequency of the ultrasound wave used.
Definition at line 311 of file usTransducerSettings.cpp.
Referenced by operator=(), operator==(), usImageIo::read(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().
bool usTransducerSettings::isTransducerConvex | ( | ) | const |
Returns the probe transducer type.
Definition at line 201 of file usTransducerSettings.cpp.
Referenced by usPixelMeterConversion::convert(), usMeterPixelConversion::convert(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usPostScanToPreScan2DConverter::init(), usPreScanToPostScan2DConverter::init(), usPreScanToPostScan3DConverter::init(), operator=(), operator==(), usImageIo::read(), setTransducerConvexity(), usImageIo::write(), usMHDSequenceWriter::write(), and usImageSettingsXmlParser::writeMainClass().
bool usTransducerSettings::operator!= | ( | usTransducerSettings const & | other | ) |
Compare two probe transducer settings.
Definition at line 125 of file usTransducerSettings.cpp.
References operator==().
usTransducerSettings & usTransducerSettings::operator= | ( | const usTransducerSettings & | other | ) |
Assignment operator.
other | Settings you want to copy. |
Definition at line 93 of file usTransducerSettings.cpp.
References getDepth(), getSamplingFrequency(), getScanLineNumber(), getScanLinePitch(), getTransducerRadius(), getTransmitFrequency(), isTransducerConvex(), and scanLineNumberIsSet().
Referenced by usImagePostScan2D< Type >::operator=(), usImagePostScan3D< Type >::operator=(), and usImagePreScanSettings::operator=().
bool usTransducerSettings::operator== | ( | usTransducerSettings const & | other | ) |
Compare two probe transducer settings.
Definition at line 111 of file usTransducerSettings.cpp.
References getSamplingFrequency(), getScanLineNumber(), getScanLinePitch(), getTransducerRadius(), getTransmitFrequency(), and isTransducerConvex().
Referenced by operator!=(), and usImagePostScan3D< Type >::operator==().
bool usTransducerSettings::scanLineNumberIsSet | ( | ) | const |
Getter to know if the scan line number is set (usefull in case of field of view setter call).
Definition at line 277 of file usTransducerSettings.cpp.
Referenced by operator=().
void usTransducerSettings::setDepth | ( | double | depth | ) |
Setter for depth : distance in meters between first and last pixel in a scan line.
depth | Distance in meters. |
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().
void usTransducerSettings::setFieldOfView | ( | double | fieldOfView | ) |
Setter for the transducer field of view (updates the scan line pitch).
fieldOfView | The transducer field of view in radians if the transducer is convex, in meters if the transducer is linear. |
Definition at line 265 of file usTransducerSettings.cpp.
Referenced by usPostScanToPreScan2DConverter::convert().
void usTransducerSettings::setProbeName | ( | std::string | probeName | ) |
Setter for the probe name.
probeName | Name of the probe. |
Definition at line 238 of file usTransducerSettings.cpp.
void usTransducerSettings::setSamplingFrequency | ( | const int | samplingFrequency | ) |
Setter for sampling frequency : frequency used to sample the echo of the ultrasound wave.
samplingFrequency | Frequency in Hz. |
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().
void usTransducerSettings::setScanLineNumber | ( | unsigned int | scanLineNumber | ) |
Setter for the scan line number.
scanLineNumber | Number of scan lines acquired by the probe transducer. |
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().
void usTransducerSettings::setScanLinePitch | ( | const double | scanLinePitch | ) |
Set the scan line pitch.
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. |
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().
void usTransducerSettings::setTransducerConvexity | ( | const bool | isTransducerConvex | ) |
Set the probe transducer type.
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. |
Definition at line 189 of file usTransducerSettings.cpp.
References isTransducerConvex().
Referenced by usMHDSequenceReader::acquire(), usPostScanToPreScan2DConverter::convert(), usPreScanToPostScan2DConverter::convert(), usNetworkGrabberPreScan2D::dataArrived(), usNetworkGrabberPreScan3D::dataArrived(), usNetworkGrabberRF3D::dataArrived(), usMHDSequenceReader::getImage(), usImageIo::read(), usImageSettingsXmlParser::readMainClass(), and usImageSettingsXmlParser::setImageSettings().
void usTransducerSettings::setTransducerRadius | ( | const double | transducerRadius | ) |
Set the probe transducer radius (m).
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. |
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().
void usTransducerSettings::setTransducerSettings | ( | const usTransducerSettings & | other | ) |
Assignment operator.
other | Settings you want to assign. |
Definition at line 210 of file usTransducerSettings.cpp.
Referenced by usPreScanToPostScan3DConverter::convert().
void usTransducerSettings::setTransmitFrequency | ( | const int | transmitFrequency | ) |
Setter for transmit frequency : frequency of the ultrasound wave used.
transmitFrequency | Frequency in Hz. |
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().
|
friend |
Print transducer information in a ostream. Usage example:
Definition at line 135 of file usTransducerSettings.cpp.