Detailed Description

Describes one ultrasound pulse echo event.

Metadata for ultrasound channel data

Classes
class	Transmit
	Transmit pulse configuration. More...
class	Receive
	Channel data reception configuration. More...

Public Member Functions
bool	operator== (const PulseEchoEvent &other) const
bool	operator!= (const PulseEchoEvent &other) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
Public Member Functions inherited from ImFusion::DataComponent< PulseEchoEvent >
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 PulseEchoEvent	createFocused (const Transducer &transducer, vec3 beamStart, vec3 focalPoint, int maxTransmitAperture, int maxReceiveAperture)
	Create a PulseEchoEvent for a focused emission. Fills only aperture and transmit wave points.
static PulseEchoEvent	createPlaneWave (const Transducer &transducer, vec3 waveStart, double planeWaveAngle, int maxTransmitAperture, int maxReceiveAperture)
	Create a PulseEchoEvent for a plane wave emission. Fills only aperture and transmit wave points.
static PulseEchoEvent	createDivergingWave (const Transducer &transducer, vec3 waveStart, vec3 virtualSource, int maxTransmitAperture, int maxReceiveAperture)
	Create a PulseEchoEvent for a diverging wave emission. Fills only aperture and transmit wave points.

Configurable interface
Transmit	m_transmit
	Transmit pulse configuration.
Receive	m_receive
	Channel data reception configuration.
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

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

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

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

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