#include <ImFusion/USImgFormation/BeamformingAlgorithm.h>

Algorithm to perform beamforming (and optionally coherent compounding) on RF or IQ ultrasound channel data. More...

Inheritance diagram for ImFusion::US::BeamformingAlgorithm:

Detailed Description

Algorithm to perform beamforming (and optionally coherent compounding) on RF or IQ ultrasound channel data.

The output is pre-scan converted.

This algorithm is used to beamform RF or IQ ultrasound channel data. The output is a single image with the same type as the input data. It uses the FrameAcquisition of the input data to determine the beamforming parameters. The ChannelDataLayout determines the semantics of the input data. For focused imaging, the output is a 2D image for each frame in the input data. For ultrafast imaging with coherent compounding active, the output is also a 2D image for each frame in the input data, Without coherent compounding, the output is a 3D image with the third dimension being the number of frames in the input data. Each slice of the 3D image then corresponds to a single PulseEchoEvent in the input data.

The algorithm uses a FrameGeometry to determine the overall geometry of the output image as well as the spatial sampling of the pre-scan data. (FrameGeometry::transformPoint and FrameGeometry::glGeometricTransform). If the input data does not contain an explicitly set FrameGeometry, the algorithm will use a default geometry derived from the FrameAcquisition.

The spatial region to beamform each event is defined by BeamformingRois. For scanline (focused) imaging, ROIs are lines (two points per event). For ultrafast imaging, ROIs are polygons (default is the insonified region per event). If BeamformingRois is not present in the input DataComponents, the algorithm uses the default ROIs from the FrameAcquisition.

Note: In focused mode, the modifications that can be made with an explicitly set FrameGeometry or BeamformingRois compared to the default geometry or ROIs are limited. This is required to ensure the spatial sampling is consistent with the insonified regions: With a FrameGeometry, only the depth can be modified, any other modifications are not supported. With a BeamformingRois, the start and end-point of the line segment can be moved along the scanline, but the resulting segment must be a subset of the default line segment. If either of these conditions is violated, BeamformingAlgorithm::compute will set an error status.; In ultrafast mode, the modifications that can be made with an explicitly set FrameGeometry or BeamformingRois compared to the default geometry or ROIs are not limited.

Public Types
enum class	BeamformerType { UnweightedDas , HammingDas , TukeyDas , Debug_ApertureSize , Debug_ApertureStart , Debug_ApertureEnd }
Public Types inherited from ImFusion::Algorithm
enum	Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...

Public Member Functions
	BeamformingAlgorithm (const SharedImageSet *inImages)
void	compute () override
	Execute the algorithm.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
std::pair< std::shared_ptr< SharedImage >, DataComponentList >	processImage (const SharedImage &image, const DataComponentList &components) const override
	Beamform one frame.
Public Member Functions inherited from ImFusion::Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from ImFusion::Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
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 Member Functions inherited from ImFusion::SequentialImageProcessor
virtual void	setSequentialMode (bool b)
	This method should be called to let the algorithm know that it should only run in sequential mode.
virtual bool	isSequentialMode () const
	Returns of the algorithm should only run in sequential mode.
Public Member Functions inherited from ImFusion::SignalReceiver
	SignalReceiver ()=default
	Default constructor.
	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.
SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a)
Static Public Member Functions inherited from ImFusion::Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Public Attributes
Parameter< double >	p_fNumber = {"fNumber", 1.0, this}
	F-number of the transducer.
Parameter< bool >	p_coherentCompounding = {"coherentCompounding", true, this}
	Whether to perform coherent compounding during beamforming.
Parameter< vec2i >	p_outputSize = {"outputSize", vec2i{512, 512}, this}
	Desired output size in x and y direction. Overridden in x-direction for focused imaging.
Parameter< double >	p_outputValueScaling = {"outputValueScaling", 1.0, this}
	Scaling factor for the output values. Can be used to avoid saturation for integer output types.
Parameter< BeamformerType >	p_beamformerType = {"beamformerType", BeamformerType::UnweightedDas, this}
	Type of beamformer to use.
Public Attributes inherited from ImFusion::Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from ImFusion::Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.
Protected Member Functions inherited from ImFusion::SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Attributes inherited from ImFusion::Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute().
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.
Protected Attributes inherited from ImFusion::SequentialImageProcessor
bool	m_isSequentialMode = false
	Flag to determine if algorithm is running in sequential mode.

Member Enumeration Documentation

◆ BeamformerType

enum class ImFusion::US::BeamformingAlgorithm::BeamformerType

strong

Enumerator
UnweightedDas	Unweighted sum of the channel data.
HammingDas	Hamming weighted sum of the channel data (Hamming apodization).
TukeyDas	Tukey weighted sum of the channel data (Tukey apodization).
Debug_ApertureSize	Debug option: Output the effective receiver aperture size (Note: As a debug option, this option is not supported and may be removed or modified in future versions).
Debug_ApertureStart	Debug option: Output the start index of the effective receiver aperture (Note: As a debug option, this option is not supported and may be removed or modified in future versions).
Debug_ApertureEnd	Debug option: Output the end index of the effective receiver aperture (Note: As a debug option, this option is not supported and may be removed or modified in future versions).

Member Function Documentation

◆ compute()

void ImFusion::US::BeamformingAlgorithm::compute ( )

overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::US::BeamformingAlgorithm::takeOutput ( )

overridevirtual

Return any new Data that was created by the Algorithm during the last call to compute().

The default implementation will return an empty list.

Note: Since ownership of the data is transferred, you can call this method only once between calls to compute().

Reimplemented from ImFusion::Algorithm.

◆ processImage()

std::pair< std::shared_ptr< SharedImage >, DataComponentList > ImFusion::US::BeamformingAlgorithm::processImage	(	const SharedImage &	image,
		const DataComponentList &	components ) const

overridevirtual

Beamform one frame.

Implements ImFusion::SequentialImageProcessor.

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

ImFusion/USImgFormation/BeamformingAlgorithm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ BeamformerType

Member Function Documentation

◆ compute()

◆ takeOutput()

◆ processImage()