ImFusion::US::FrameAcquisition Class Reference

#include <ImFusion/USImgFormation/FrameAcquisition.h>

Metadata and programming for the sequence of pulse echo events of one frame, e.g. More...

Inheritance diagram for ImFusion::US::FrameAcquisition:

Detailed Description

Metadata and programming for the sequence of pulse echo events of one frame, e.g.

x scanlines covering the region of interest.

Public Member Functions
	FrameAcquisition (Transducer transducer, FrameParameters parameters)
	Create a FrameAcquisition from high level parametrization.
	FrameAcquisition (Transducer transducer, std::vector< PulseEchoEvent > events)
	Create a FrameAcquisition from a transducer and a number of events.
	FrameAcquisition (const FrameAcquisition &other)
FrameAcquisition &	operator= (const FrameAcquisition &other)
const UltrasoundMetadata &	ultrasoundMetadata () const
	higher level metadata of this FrameAcquisition: Default generated UltrasoundMetadata
const FrameGeometryMetadata &	frameGeometry () const
	higher level metadata of this FrameAcquisition: Default generated FrameGeometryMetadata
const BeamformingRois *	rois () const
	Default generated ROIs for beamforming (one per event). Scanline ROIs are lines (two points); ultrafast ROIs are polygons.
BeamformingRois *	rois ()
void	setReceiveSamplingFrequency (double frequency)
	Sets the receive sampling frequency of all events.
std::vector< PulseEchoEvent > &	events ()
const std::vector< PulseEchoEvent > &	events () const
Transducer &	transducer ()
const Transducer &	transducer () const
bool	operator== (const FrameAcquisition &other) const
bool	operator!= (const FrameAcquisition &other) const
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< FrameAcquisition >
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.

Constructor & Destructor Documentation

FrameAcquisition()

ImFusion::US::FrameAcquisition::FrameAcquisition	(	Transducer	transducer,
		std::vector< PulseEchoEvent >	events )

Create a FrameAcquisition from a transducer and a number of events.

Compared to the constructor with FrameParameters, this allows to create a frame acquisition with bespoke events, e.g. focused transmits with different focal depths or unevenly spaced plane wave angles.

Member Function Documentation

id()

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