Detailed Description

Algorithm to change properties of a FrameGeometry of a Shared Image Set.

This algorithm allows its corresponding controller to manipulate the frame geometry of the associated images from the Suite. To change this geometry from code, users should access the image frame geometry directly.

Public Types
enum class	FanMode { NONE = 0 , ADD_MASK = 1 , CROP = 2 , SET_BACKGROUND_TO_ZERO = 3 }
	Different modes how the fan geometry can be applied on a shared image set. More...
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
	FrameGeometryPropertiesAlgorithm (const std::vector< SharedImageSet * > &sis)
void	applyFan (const FanMode mode)
	Apply the fan geometry on the Shared Image Set with one of the supported modes.
const std::vector< SharedImageSet * > &	images () const
	Return vector of Shared Image Sets.
Public Member Functions inherited from ImFusion::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 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
Parameter< FanMode >	p_applyFan = {"type", FanMode::NONE, this}
	Mode of the fan.
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.

Methods implementing the Algorithm interface
void	compute () override
	The fan geometry masking/cropping is applied here, if enabled.
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.

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

◆ FanMode

enum class ImFusion::US::FrameGeometryPropertiesAlgorithm::FanMode

strong

Different modes how the fan geometry can be applied on a shared image set.

Enumerator
NONE	Nothing is done.
ADD_MASK	A mask instance is added to the image.
CROP	The image is cropped with the mask.
SET_BACKGROUND_TO_ZERO	Image is cropped and inside intensities are elevated to one.

Member Function Documentation

◆ compute()

void ImFusion::US::FrameGeometryPropertiesAlgorithm::compute ( )

overridevirtual

The fan geometry masking/cropping is applied here, if enabled.

Implements ImFusion::Algorithm.

◆ configure()

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

Detailed Description

Public Types

Public Member Functions

Public Attributes

Methods implementing the Algorithm interface

Methods implementing the Configurable interface

Additional Inherited Members

Member Enumeration Documentation

◆ FanMode

Member Function Documentation

◆ compute()

◆ configure()

◆ configuration()