RawDataAlgorithm Class Reference

#include <ImFusion/US/RawDataAlgorithm.h>

Handles pairing of B-mode ultrasound images with raw data and an optional label map. More...

Inheritance diagram for RawDataAlgorithm:

Detailed Description

Handles pairing of B-mode ultrasound images with raw data and an optional label map.

Data must include a RawDataComponent for conversion to be possible. It internally uses the ScanConversion algorithm to convert from raw images to volumetric data. The raw data can be either:

• Pre-scan-converted images
• IQ (In-phase/Quadrature) images

IQ image handling:

• If p_convertIQ is true, the algorithm searches the RawDataComponent for the first floating-point image with 2 channels. This is assumed to be the IQ data. Additional images fitting these criteria are not considered.
• If found, it converts the two channels into:
  • Log magnitude image
  • Phase image
• If images already exist in RawDataComponent tagged as:
  • "IQ Phase"
  • "IQ Log Magnitude" then these are assumed to be pre-converted, and p_convertIQ is automatically set to false.

Automatic registration:

• If registration is enabled, the raw images (including IQ data) are registered to the input rendered B-mode image.

Public Member Functions
	RawDataAlgorithm (SharedImageSet &image, SharedImageSet *label=nullptr)
	Constructor, does not take ownership of the label image.
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::unique_ptr< SharedImageSet >	convert (const SharedImageSet *img, const bool toRaw) const
vec3	convert (const vec3 &point, bool toRaw) const
	Convert a point from pre-scan-converted (raw) to volumetric data.
SharedImageSet *	renderedImage ()
	Return a raw pointer to the rendered / original B-Mode image.
SharedImageSet *	labelImage ()
	Return the optional labelmap for the B-Mode image if available.
SharedImageSet *	iqImage ()
	Return a pointer to the IQ image if available.
std::vector< SharedImageSet * >	preConvImages () const
	Return vector of pre-scan-converted images.
RawDataComponent &	rawDataComponent () const
	Return a reference to the raw data component of the image set.
vec3	referencePixel () const
	Return the ultrasound ROI reference pixel as specified in the DICOM data.
Public Member Functions inherited from 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 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

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
Static Public Member Functions inherited from 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< bool >	p_fitGeometry = {"fitGeometry", false, this}
	If checked, registers the rendered frame to the raw converted one converted to the b-mode to assess quantitatively the conversion.
Parameter< std::string >	m_resultFilename = {"resultFilename", "", this}
	The filename where the registration evaluation would be saved. Has no effect if fitGeometry is set to false.
Parameter< bool >	p_convertIQ = {"convertIQ", true, this}
	If checked, log magnitude and phase are calculated from the IQ data and added to the raw data component.
Parameter< bool >	p_convertSegmentation = {"convertSegmentation", false, this}
	If checked, the given segmentation is converted from b-mode to raw space and put in the output of the algorithm.
Parameter< int >	p_extractRawData = {"extractRaw", -1, this}
	If a number between 0 and size of raw data, the specified raw data is going to be put in the output of the algorithm.
Public Attributes inherited from 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 Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Protected Attributes
SharedImageSet &	m_renderedImg
	The input render image to use as a reference for alignment.
SharedImageSet *	m_labelImg = nullptr
	The optional input accompanying label image.
SharedImageSet *	m_iqImg = nullptr
	The IQ image, if it is found.
std::vector< SharedImageSet * >	m_preConvImg
	The raw images to be converted.
OwningDataList	m_output
	List of converted images.
RawDataComponent *	m_rawDataComponent
	The RawDataComponent that comes with the input image.
Protected Attributes inherited from 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 Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...
Protected Member Functions inherited from 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.

Member Function Documentation

compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

inlineoverridevirtual

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 Algorithm.

convert()

vec3 convert	(	const vec3 &	point,
		bool	toRaw ) const

Convert a point from pre-scan-converted (raw) to volumetric data.

Note

toRaw is not implemented, this functions goes only one way.

---

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

• ImFusion/US/RawDataAlgorithm.h