RawDataComponent Class Reference

#include <ImFusion/US/RawDataComponent.h>

This data component holds SharedImageSets that relate to the one they are attached to, holding their associated raw ultrasound data. More...

Inheritance diagram for RawDataComponent:

Detailed Description

This data component holds SharedImageSets that relate to the one they are attached to, holding their associated raw ultrasound data.

These raw images can be, for example:

• IQ data In-phase (I) and quadrature-phase (Q) components of the raw ultrasound signal (radio-frequency 'RF' data) received by the transducer. These components are obtained through demodulation, or "quadrature detection", of the received signal, and they represent the amplitude and phase of the signal. Type: IQ
• IQ magnitude This is the magnitude of the complex IQ data and is an intermediate image in the process of conversion from IQ data (which came from the original RF data), to B-mode images. These images may contain the signal envelope. Type: IQMag
• IQ phase The phase of the complex IQ data. Type: IQPhase
• The pre-scan converted images Type: Tissue

Vendor-specific US modules load such raw data from DICOM files that contain it. The data controller RawDataController can be used to explore the images in the component. These images can be scan converted to the geometry of the B-mode image, and the B-mode image can be converted to their geometry. The algorithm also calculates the IQ Phase and Magnitude from the IQ data.

See also

RawDataController

Public Types
enum class	Type {   Unknown = 0 , Tissue = 1 , ColorFlow = 2 , IQ = 3 ,   IQMag = 4 , IQPhase = 5 , Segmentation = 6 }

Public Member Functions
	RawDataComponent (const RawDataComponent &other)
	RawDataComponent (RawDataComponent &&other)=default
RawDataComponent &	operator= (const RawDataComponent &other)
bool	operator== (const RawDataComponent &rhs) const
	Performs comparison of all the raw data images contained within the RawDataComponents.
std::string	id () const override
	Returns a unique string identifier for this type of data component.
void	configure (const Properties *) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *) const override
	Serialize the current object configuration into the given Properties object.
SharedImageSet &	operator[] (size_t which)
	Returns a reference to the image at the given index.
const SharedImageSet &	operator[] (size_t which) const
	Returns a const reference to the image at the given index.
size_t	size () const
std::vector< std::unique_ptr< SharedImageSet > >::const_iterator	begin () const
std::vector< std::unique_ptr< SharedImageSet > >::const_iterator	end () const
std::vector< std::unique_ptr< SharedImageSet > >::iterator	begin ()
std::vector< std::unique_ptr< SharedImageSet > >::iterator	end ()
void	addRawData (std::unique_ptr< SharedImageSet > image, Type type)
	A function to add additional raw data images to the data component.
std::vector< std::string >	getNames () const
	Return a list of the names of the images stored in the data component.
const SharedImageSet *	getImage (const std::string &name) const
	Returns a raw data image having the corresponding name or nullptr if such does not exist.
Public Member Functions inherited from DataComponent< RawDataComponent >
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 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 Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

operator==()

bool operator==

(

const RawDataComponent &

rhs

)

const

Performs comparison of all the raw data images contained within the RawDataComponents.

This is done naively, RawDataComponents with the same images sorted in a different way will return false. Comparison happens in three steps to avoid expensive computation:

• Check the number of images match
• Check that the size of every image inthis matches its counterpart in rhs.
• Lastly, check the actual images for equality.

id()

std::string 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 DataComponentBase.

configure()

void 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 Configurable.

configuration()

void 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 Configurable.

addRawData()

void addRawData	(	std::unique_ptr< SharedImageSet >	image,
		Type	type )

A function to add additional raw data images to the data component.

Parameters

image	A unique_ptr of the shared image set to be added
type	The type of the added image

getNames()

std::vector< std::string > getNames

(

)

const

Return a list of the names of the images stored in the data component.

Returns

The vector of images' names

getImage()

const SharedImageSet * getImage

(

const std::string &

name

)

const

Returns a raw data image having the corresponding name or nullptr if such does not exist.

Parameters

name	The name to search by

Returns

A pointer to the image with the given name

---

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

• ImFusion/US/RawDataComponent.h