ImFusion::US::Transducer Class Reference

#include <ImFusion/USImgFormation/Transducer.h>

Low level transducer information, used for programming US firings and channel data processing. More...

Inheritance diagram for ImFusion::US::Transducer:

Detailed Description

Low level transducer information, used for programming US firings and channel data processing.

Public Member Functions
bool	operator== (const Transducer &other) const
bool	operator!= (const Transducer &other) const
std::vector< vec3 >	elementPositions () const
	Positions of the transducer element centers, relative to the probe surface center.
Spline	shape () const
	Shape of the transducer surface.
int	numElements () const
	Returns the number of elements.
double	pitch () const
	Returns the pitch of the elements (in mm).
std::optional< double >	radiusCurvature () const
	Returns the radius of curvature of the transducer (in mm), if it is convex.
bool	isLinear () const
bool	isConvex () const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
Public Member Functions inherited from ImFusion::DataComponent< Transducer >
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 ImFusion::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

Static Public Member Functions
static Transducer	createLinear (int numberElements, double pitch)
	Creates a linear transducer with the given number of elements and element pitch (in mm).
static Transducer	createConvex (int numberElements, double pitch, double radiusCurvature)
	Creates a convex transducer with the given number of elements, their pitch and the radius of curvature (both in mm).

Configurable interface
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.

Additional Inherited Members
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from ImFusion::DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

id()

std::string ImFusion::US::Transducer::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 ImFusion::DataComponentBase.

configure()

void ImFusion::US::Transducer::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 ImFusion::Configurable.

configuration()

void ImFusion::US::Transducer::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 ImFusion::Configurable.

---

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

• ImFusion/USImgFormation/Transducer.h