UltrasoundMetadata Class Reference

#include <ImFusion/US/UltrasoundMetadata.h>

Metadata for a medical ultrasound image. More...

Inheritance diagram for UltrasoundMetadata:

Detailed Description

Metadata for a medical ultrasound image.

See FrameGeometryMetadata for the description of a frame's (fan) geometry.

Public Types
enum	ScanMode {   BMODE = 0 , PDI = 1 , PWD = 2 , CFM = 3 ,   THI = 4 , MMODE = 5 , OTHER = 6 }
	Principal ultrasound imaging mode. More...

Public Member Functions
bool	operator== (const UltrasoundMetadata &other) const
bool	operator!= (const UltrasoundMetadata &other) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
double	depth () const
	Returns the difference between end and start depth.
Public Member Functions inherited from DataComponent< UltrasoundMetadata >
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
std::unique_ptr< Subclass >	cloneDerived () const
bool	assign (const DataComponentBase &other) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &other) const override
	Compares this data component to other for equality.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Public Attributes
ScanMode	m_scanMode = BMODE
	Principal imaging mode.
std::string	m_device
	Manufacturer and device description.
std::string	m_probe
	Probe model used for imaging.
std::string	m_preset
	Name of the imaging preset used.
bool	m_scanConverted = true
	True if image is scan-converted.
bool	m_imageEnhanced = false
	Filtering or image enhancement is applied.
int	m_numberOfBeams = 0
	Number of scanline beams used in forming the image.
int	m_samplesPerBeam = 0
	Number of samples used per beam.
double	m_startDepth = 0.0
	Start depth in [mm].
double	m_endDepth = 0.0
	End depth in [mm].
double	m_focalDepth = 0.0
	Focal depth if applicable.
double	m_brightness = 0.0
	Brightness setting.
double	m_dynamicRange = 0.0
	Dynamic range setting.
double	m_frequency = 0.0
	Transducer frequency in MHz.
double	m_speedOfSound = 0.0
	Assumed speed of sound during recording [m/s].
std::vector< double >	m_roi
	Region of interest or frame geometry.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

ScanMode

enum ScanMode

Principal ultrasound imaging mode.

Enumerator
BMODE	Standard B-Mode ultrasound.
PDI	Power Doppler Imaging.
PWD	Pulsed Wave Doppler Imaging.
CFM	Color Flow Mapping.
THI	Tissue Harmonic Imaging.
MMODE	M-Mode ultrasound imaging.
OTHER	Other or undefined mode.

Member Function Documentation

id()

std::string id ( ) const

overridevirtual

Returns a unique string identifier for this type of data component.

Note

To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements DataComponentBase.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

Member Data Documentation

m_roi

std::vector<double> m_roi

Region of interest or frame geometry.

Must contain even number of coordinates, as consecutive (x,y) pairs of image space coordinates. GlUltrasoundRuler will highlight this area with a dashed line.

Note

This feature is about to be deprecated. Use a FrameGeometryMetadata instead.

---

The documentation for this class was generated from the following file:

• ImFusion/US/UltrasoundMetadata.h