#include <ImFusion/USImgFormation/BeamformingRois.h>

DataComponent that describes the spatial regions of interest (ROIs) for beamforming for each pulse-echo event. More...

Inheritance diagram for ImFusion::US::BeamformingRois:

Detailed Description

DataComponent that describes the spatial regions of interest (ROIs) for beamforming for each pulse-echo event.

The ROI defines which region to beamform in; the grid to sample on is given by the FrameGeometry's GeometricTransform. There is one ROI per event.

For scanline (focused) imaging, each ROI is represented as a line segment (two points: start and end of the scanline). For ultrafast imaging, each ROI is typically a polygon describing the insonified region.

ROIs are defined in the image coordinate system of the ultrasound data.

Public Member Functions
	BeamformingRois (const BeamformingRois &)
	BeamformingRois (BeamformingRois &&)
BeamformingRois &	operator= (const BeamformingRois &)
BeamformingRois &	operator= (BeamformingRois &&)
int	size () const
	Returns the number of ROIs.
const Geometry::Polygon2D &	roi (int index) const
	Returns the ROI at the given index, corresponding to the event index.
Geometry::Polygon2D &	roi (int index)
	Returns the ROI at the given index, corresponding to the event index.
void	add (const Geometry::Polygon2D &roi)
	Adds a new ROI to the end of the list.
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.
bool	operator== (const BeamformingRois &other) const
bool	operator!= (const BeamformingRois &other) const
Public Member Functions inherited from ImFusion::DataComponent< BeamformingRois >
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

◆ id()

std::string ImFusion::US::BeamformingRois::id ( ) const

nodiscardoverridevirtual

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::BeamformingRois::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::BeamformingRois::configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.