UltrasoundSimulationHybrid Class Reference

#include <ImFusion/US/UltrasoundSimulationHybrid.h>

Hybrid ultrasound simulation method. More...

Inheritance diagram for UltrasoundSimulationHybrid:

Detailed Description

Hybrid ultrasound simulation method.

Public Member Functions
	UltrasoundSimulationHybrid (SharedImageSet *volLabel, UltrasoundSweep *sweep=nullptr)
	Constructor with volume to simulate from, and optional ultrasound sweep.
	~UltrasoundSimulationHybrid () override
	Destructor.
void	computeSlice (const Slice &slice, const FrameGeometry *geometry=nullptr)
	Computes the simulation for a single slice If the geometry is not specified it will be calculated based on the parameters of the controller.
void	computeSlice (int idx)
void	parametersChanged ()
	Calls listeners to update their parameters.
std::shared_ptr< SharedImage >	result ()
	Returns one simulated slice.
void	setSimulationParams (double elementsHeight, double signalFreq, int gain, double soundSpeed, double m_focusDepth)
	Set the simulation parameters.
void	setRayTracingParams (int scanLines, int elevationRayCount, int axialSamplePoints, int multReflection, float intensityThreshold, float reflectFactor)
	Set the ray tracing related parameters.
void	setConvolutionParams (double waveWidth, double wavePerPulse, double noiseSizeScale, double noiseIntensityScale, double SxFactor, double SyFactor, double attenuation, double beamSmoothness, int convolutionParallelRuns)
	Set the convolution parameters.
void	setPostProcessingParams (double RFNoise, double TGCScale, double TGCAlpha, double rejectThreshold, double exp1, double exp2)
	Set the post-processing parameters.
void	setFlip (bool sx, bool sy, bool dx, bool dy)
	Flips the frame.
void	setProgress (Progress *p) override
	Set an optional progress update callback.
void	setTissueProperties (Medium type, float c, float z, float a, float m0, float m1, float s0)
	Set properties of a tissue type.
const UltrasoundMedium *	tissueProperties (Medium type) const
	Get the properties of a tissue type.
void	reinitTissues ()
	Re-initialize tissue properties.
bool	sliceChanged (const Slice &slice) const
	Return if the slice pose or size has changed since the last computation.
SyntheticUltrasoundSweepAlgorithm *	syntheticSweepAlgorithm ()
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
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	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

Protected Member Functions
ClImage &	getClImage (const SharedImage &img)
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.

Protected Attributes
std::unique_ptr< SharedImageSet >	m_scatterTextures
	Random scatter textures used to create the speckled pattern (can be overwritten in the test to ensure reproducibility)
std::unordered_map< const SharedImage *, std::unique_ptr< ClImage > >	m_clImages
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.

Algorithm interface methods
void	compute () override
	Executes the simulation.
OwningDataList	takeOutput () override
	Output the simulated UltrasoundSweep.
static bool	createCompatible (const DataList &data, Algorithm **a=0)

Methods implementing the Configurable interface
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.
void	configureTissues (const Properties *p)
	Loads tissue acoustic properties from p.
void	configurationTissues (Properties *p) const
	Saves tissue acoustic properties to p.

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

Member Function Documentation

createCompatible()

static bool createCompatible ( const DataList & data, Algorithm ** a = 0 )

static

Check whether input data fits and create algorithm if asked to

compute()

void compute ( )

overridevirtual

Executes the simulation.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Output the simulated UltrasoundSweep.

Reimplemented from Algorithm.

setProgress()

void setProgress ( Progress * p )

inlineoverridevirtual

Set an optional progress update callback.

Reimplemented from Algorithm.

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.

---

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

• ImFusion/US/UltrasoundSimulationHybrid.h