GeometryDetectionAlgorithm Class Reference

#include <ImFusion/US/GeometryDetectionAlgorithm.h>

Algorithm to detect the actual image region of interest (ROI) in an ultrasound video. More...

Inheritance diagram for GeometryDetectionAlgorithm:

Detailed Description

Algorithm to detect the actual image region of interest (ROI) in an ultrasound video.

Public Member Functions
	GeometryDetectionAlgorithm (SharedImageSet *images)
void	selectionChanged ()
	Process detection when image set selection has changed.
Public Member Functions inherited from SignalReceiver
	SignalReceiver ()=default
	Default constructor.
	SignalReceiver (const SignalReceiver &other)
	Copy constructor, does not copy any existing signal connections from other.
SignalReceiver &	operator= (SignalReceiver rhs)
	Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual	~SignalReceiver ()
	Virtual destructor disconnects from all connected signals.
Public Member Functions inherited from BaseGeometryDetectionAlgorithm
const ImageDescriptor &	imageDescriptor () const
	Return the current image frame descriptor.
const US::FrameGeometry &	geometry () const
	Return the current ultrasound geometry in pixel coordinates.
bool	isGeometryAvailable () const
void	geometryBoundingBox (vec2i &offset, vec2i &extent) const
	Return the axis-aligned bounding box of the current ultrasound geometry in pixel coordinates Note that if the geometry is cropped on the left and/or the right, as happens sometimes when displaying convex or virtual convex geometries, the cropping will be incorporated into the bounding box.
SharedImageSet *	debugImage () const
	Return a debug image for visualization.
bool	mask () const
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual OwningDataList	takeOutput ()
	Return any new Data that was created by the Algorithm during the last call to compute().
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	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

Public Attributes
Parameter< bool >	p_useSelection = {"useSelection", true, this}
	Which frames to take as input: true=SharedImageSet selection, false=from focus, until max frames.
Parameter< bool >	p_applyGeometry = {"applyGeometry", false, this}
	Apply the detected geometry directly to input sweep.
Public Attributes inherited from BaseGeometryDetectionAlgorithm
Parameter< int >	p_numFramesLimit = {"numFramesLimit", 8, this}
	Maximum number of past frames to use, use all if < 2.
Parameter< bool >	p_mask = {"mask", false, this}
	Mask the stream images.
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 Member Functions
bool	topDown () const override
	Whether the images are created from ultrasound beams that travel from the top of the image to the bottom (true), or from the bottom to the top (false)
Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Member Functions inherited from BaseGeometryDetectionAlgorithm
void	computeImpl ()
void	maskImage (MemImage *img) const
	Mask provided image by setting everything outside the fan to zero.
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
SharedImageSet *	m_images = nullptr
	Image set as alternative input.
Protected Attributes inherited from BaseGeometryDetectionAlgorithm
std::unique_ptr< GeometryDetection >	m_detectionAlg
	implementation of the actual detection algorithm
std::shared_ptr< FanMask >	m_fanMask
	Allows for masking image with fan.
std::unique_ptr< SharedImageSet >	m_imgOut
	Output data for visualization.
std::deque< std::unique_ptr< const TypedImage< unsigned char > > >	m_frames
	Copy of currently used frames.
ImageDescriptor	m_imageDesc
	Image frame descriptor.
std::unique_ptr< US::FrameGeometry >	m_geometry
	Detected frame geometry.
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.

Methods implementing the algorithm 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	compute () override
	Execute the algorithm.
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)

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.

Member Function Documentation

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.

compute()

void compute ( )

overridevirtual

Execute the algorithm.

Implements Algorithm.

topDown()

bool topDown ( ) const

overrideprotectedvirtual

Whether the images are created from ultrasound beams that travel from the top of the image to the bottom (true), or from the bottom to the top (false)

Implements BaseGeometryDetectionAlgorithm.

---

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

• ImFusion/US/GeometryDetectionAlgorithm.h