Detailed Description

The AcousticParametersDataComponent class enables defining the acoustic properties, i.e.

speed of sound, density and acoustic attenuation of the medium segmented by a label. Basic label properties, i.e. index and name are defined by the LabelDataComponent, so it is required, that the LabelDataComponent is present.

Public Member Functions
	AcousticParametersDataComponent (const LabelDataComponent &)
	for convenience; same as calling AcousticParametersDataComponent() and updateLabels(const LabelDataComponent&)
	AcousticParametersDataComponent (const AcousticParametersDataComponent &other)=default
void	updateLabels (const LabelDataComponent &)
	updateLabels creates acousic property for each label in the LabelDataComponent
bool	operator== (const AcousticParametersDataComponent &) const
AcousticParametersDataComponent &	operator= (const AcousticParametersDataComponent &rhs)
std::optional< AcousticTissueParameters >	acousticParameters (int labelIndex) const
	Returns the AcousticTissueParameters associated with the specified labelIndex if existent.
const std::map< int, AcousticTissueParameters > &	acousticParameters () const
	Returns the map of AcousticTissueParameters keyed by label Index.
void	setAcousticParameters (int labelIndex, AcousticTissueParameters acousticParameters)
	Sets the AcousticTissueParameters associated with the specified labelIndex.
void	setAcousticParameters (std::map< int, AcousticTissueParameters > acousticParameters)
	Sets the map of AcousticTissueParameters keyed by label Index.
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.
Public Member Functions inherited from ImFusion::DataComponent< AcousticParametersDataComponent >
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

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

◆ setAcousticParameters()

void ImFusion::US::AcousticParametersDataComponent::setAcousticParameters	(	int	labelIndex,
		AcousticTissueParameters	acousticParameters )

Sets the AcousticTissueParameters associated with the specified labelIndex.

If labelIndex does not exist, it is added.

◆ id()

std::string ImFusion::US::AcousticParametersDataComponent::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::AcousticParametersDataComponent::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::AcousticParametersDataComponent::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/US/AcousticParametersDataComponent.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ setAcousticParameters()

◆ id()

◆ configure()

◆ configuration()