ImFusion::US::FrameGrabbingPresets Class Reference

#include <ImFusion/US/FrameGrabbingPresets.h>

Set of templates, geometries and depths. More...

Inheritance diagram for ImFusion::US::FrameGrabbingPresets:

Detailed Description

Set of templates, geometries and depths.

Classes
struct	ROI
struct	Preset

Public Member Functions
bool	operator== (const FrameGrabbingPresets &other) const
int	match (const MemImage *memImg, double threshold=0.0)
const US::FrameGeometry *	geometry (int index=-1) const
double	depth (int index=-1) const
std::string	name (int index=-1) const
int	size () const
double	estimateDepth (const US::FrameGeometry *newGeometry) const
	Estimates the depth of a new geometry based on stored configurations.
int	addPreset (Preset &&preset)
int	addTemplate (std::unique_ptr< ImageTemplate > &&templ, Preset &&preset)
int	addTemplate (std::unique_ptr< ImageTemplate > &&templ, std::unique_ptr< US::FrameGeometry > &&geom, double depth)
void	setPreset (int index, std::unique_ptr< US::FrameGeometry > &&geom, double depth)
void	clear ()
std::vector< std::string >	presetNames () const
void	setCurrentPreset (int presetIndex)
bool	setCurrentPreset (const std::string &presetName)
bool	removePreset (int presetIndex, bool silent=false)
bool	removePreset (const std::string &presetName, bool silent=false)
const Preset &	currentPreset () const
int	currentPresetIndex () const
std::unique_ptr< FrameGrabbingPresets >	clone () const
std::unique_ptr< SharedImageSet >	toSis () const
bool	save (const std::string &path) const
void	load (const SharedImageSet *sis)
void	load (const std::string &path)
ROI	roi () const
void	setRoi (const ROI &roi)
void	setSpeedOfSound (double speed, bool adjust=true)
double	speedOfSound () const
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::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
Signal	signalPresetsLoaded
Signal< int >	signalPresetCreated
Signal< int >	signalPresetChanged
	Signal that a preset has changed name, depth or geometry.
Signal< int, int >	signalPresetsRemoved
	Signal presets in range [start, end) have been removed.
Signal< int >	signalCurrentPresetChanged
	Signal that the currently active preset index has changed.
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from ImFusion::Utils::NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default
NotCopyable &	operator= (NotCopyable &&) noexcept=default
	NotCopyable (const NotCopyable &)=delete
NotCopyable &	operator= (const NotCopyable &)=delete
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

configure()

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