ImFusion::US::ProcessUltrasound Class Reference

#include <ImFusion/US/ProcessUltrasound.h>

Common processing functionality for ultrasound data. More...

Inheritance diagram for ImFusion::US::ProcessUltrasound:

Detailed Description

Common processing functionality for ultrasound data.

Manages the US::FrameGeometry, processes a single frame according to ProcessUltrasoundParameters and can remove duplicate frames algorithm with the algorithm RemoveDuplicateFrames.

Example for updating the processing parameters:

bool enableCropping = true;
auto updater = [&enableCropping](ProcessUltrasoundParameters& p) { p.applyCrop = enableCropping; };
processUltrasound.updateParameters(updater);

See also

• US::FrameGeometry
• ProcessUltrasoundParameters
• RemoveDuplicateFrames

Public Member Functions
ProcessUltrasoundParameters	parameters () const
void	setParameters (const ProcessUltrasoundParameters &params)
void	updateParameters (const std::function< void(ProcessUltrasoundParameters &)> &updater)
	Updates the parameters with a callback. Avoid calling other methods of this class to avoid double locks.
void	updateGeometry (std::unique_ptr< US::FrameGeometry > newGeometry, double depth=-1)
void	initGeometry (const ImageDescriptor &img)
	Init the geometry such that it can be manipulated via the GUI.
void	setGeometryToWholeImage (const ImageDescriptor &img)
std::unique_ptr< ProcessedFrame >	processFrame (const MemImage &unprocessedMemImage)
std::optional< ImageDescriptor >	lastProcessedImageDescriptor ()
std::unique_ptr< US::FrameGeometry >	frameGeometry ()
std::unique_ptr< US::FrameGeometry >	frameGeometryProcessed ()
void	setRemoveDuplicates (bool activate)
	Inits or destroys the remove duplicate frames algorithm depending on the activate flag.
const RemoveDuplicateFrames *	getRemoveDuplicates ()
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

Public Attributes
Signal	parametersChanged
	Signal emitted when the processing parameters have changed.
Signal	frameGeometryChanged
Signal	frameGeometryProcessedChanged
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Methods implementing the 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
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

configure()

void ImFusion::US::ProcessUltrasound::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::ProcessUltrasound::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/ProcessUltrasound.h