#include <ImFusion/LiveUS/VirtualImagingAlgorithm.h>

Virtual imaging in 2D or 3D through ultrasound simulation or volume slicing. More...

Inheritance diagram for ImFusion::US::VirtualImagingAlgorithm:

Detailed Description

Virtual imaging in 2D or 3D through ultrasound simulation or volume slicing.

Public Types
enum class	SimulationMode { UltrasoundOnly = 0 , LabelMapReslicingOnly = 1 , UltrasoundAndLabelMap = 2 }
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
	VirtualImagingAlgorithm (SharedImageSet *volumetricData)
	Create with the volumetric data for simulation or reslicing.
void	setProbePosition (const std::vector< mat4 > &probePosition)
	Set the position of the probe.
void	setProbeCalibration (const mat4 &probeCalibration)
	Set the calibration of the probe.
void	compute () override
	Simulates either a number of 2D images or a 3D volume, depending on p_frames > 1 or not Use setProbePosition() to set the probe position before calling this function and takeOutput() to get the result.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
bool	compute2D (const std::vector< mat4 > &probePosition, std::unique_ptr< UltrasoundSweep > outSweep, std::unique_ptr< UltrasoundSweep > outLabels=nullptr) const
	Compute one set of 2D images at the given probe position and the omniplane angles.
bool	compute3D (const std::vector< mat4 > &probePosition, std::unique_ptr< SharedImageSet > outVolume, std::unique_ptr< SharedImageSet > outLabel) const
	Compute a 3D volume at the given probe position.
void	prepareReferenceSweep (const std::vector< mat4 > &trackings) const
	Prepares m_refSweep to be used by the other classes in any of the combinations of volume-label data and number of frames.
void	resetVolumeReslicer ()
	Reset the volume reslicer.
void	setSimulationScatterTexture (std::unique_ptr< SharedImageSet > scatterTextures)
	Reset the hybrid simulation, creating it with the given scatter texture.
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::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	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=0)
	Factory method to check for applicability or to create the algorithm.
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_imageSpacing = {"imageSpacing", 0.25, this}
Parameter< int >	p_frames = {"frames", 1, this}
Parameter< double >	p_shortRadius = {"shortRadius", 0., this}
Parameter< double >	p_longRadius = {"longRadius", 120., this}
Parameter< double >	p_openingAngleInPlane = {"openingAngleInPlane", 50., this}
Parameter< double >	p_openingAngleOutOfPlane = {"openingAngleOutOfPlane", 50., this}
Parameter< SimulationMode >	p_simulationMode = {"simulationMode", SimulationMode::UltrasoundOnly, this}
Parameter< bool >	p_simulateUSAsReslicing = {"simulateUSasReslicing", false, this}
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.

Protected Member Functions
std::unique_ptr< FrameGeometryConvex >	frameGeometry () const
std::unique_ptr< UltrasoundSweep >	simulateUltrasoundFrames () const
std::unique_ptr< UltrasoundSweep >	resliceLabelMapFrames () const
std::unique_ptr< SharedImageSet >	resampleLabelVolume (SharedImageSet &referenceImage) const
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.

Additional Inherited Members
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.

Member Function Documentation

◆ compute()

void ImFusion::US::VirtualImagingAlgorithm::compute ( )

overridevirtual

Simulates either a number of 2D images or a 3D volume, depending on p_frames > 1 or not Use setProbePosition() to set the probe position before calling this function and takeOutput() to get the result.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::US::VirtualImagingAlgorithm::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.

◆ compute2D()

bool ImFusion::US::VirtualImagingAlgorithm::compute2D	(	const std::vector< mat4 > &	probePosition,
		std::unique_ptr< UltrasoundSweep > *	outSweep,
		std::unique_ptr< UltrasoundSweep > *	outLabels = nullptr ) const

Compute one set of 2D images at the given probe position and the omniplane angles.

The resulting simulated US frames are stored in outSweep (if not nullptr), and the resliced and masked label maps are stored in outLabels (if not nullptr).

◆ compute3D()

bool ImFusion::US::VirtualImagingAlgorithm::compute3D	(	const std::vector< mat4 > &	probePosition,
		std::unique_ptr< SharedImageSet > *	outVolume,
		std::unique_ptr< SharedImageSet > *	outLabel ) const

Compute a 3D volume at the given probe position.

The resulting volume is stored in outVolume (if not nullptr), and the corresponding label volume in outLabel (if not nullptr).

◆ prepareReferenceSweep()

void ImFusion::US::VirtualImagingAlgorithm::prepareReferenceSweep ( const std::vector< mat4 > & trackings ) const

Prepares m_refSweep to be used by the other classes in any of the combinations of volume-label data and number of frames.

It gives the sweep a FrameGeometryConvex and sets its tracking to be in the 'top' of this fan geometry.

◆ configure()

void ImFusion::US::VirtualImagingAlgorithm::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::VirtualImagingAlgorithm::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/LiveUS/VirtualImagingAlgorithm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ compute()

◆ takeOutput()

◆ compute2D()

◆ compute3D()

◆ prepareReferenceSweep()

◆ configure()

◆ configuration()