PruneTerminalPathsAlgorithm Class Reference

#include <ImFusion/Graph/PruneTerminalPathsAlgorithm.h>

Algorithm to prune a graph, i.e. remove terminal paths or edged with lengths below a given threshold. More...

Inheritance diagram for PruneTerminalPathsAlgorithm:

Detailed Description

Algorithm to prune a graph, i.e. remove terminal paths or edged with lengths below a given threshold.

Public Types
enum	Mode { GlobalThreshold = 0 , DistanceBased = 1 }
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...

Public Member Functions
	PruneTerminalPathsAlgorithm (Graph &graph, SharedImageSet *distanceImage=nullptr)
	~PruneTerminalPathsAlgorithm () override
	Destructor.
Public Member Functions inherited from 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 Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
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 void	removeShortTerminalPaths (Graph &graph, double threshold)
	Removes terminal paths (connected edges) shorter than the length specified by threshold.
static void	removePathsDistanceBased (Graph &graph, SharedImageSet *distanceTransform, double sensitivity)
	Removes terminal paths shorter than the value given by the distImage at the respective coordinates.
static void	removeThinTerminalEdges (Graph &graph, double threshold)
	Removes connected terminal edges with diameter below a given threshold. Requires diameters to be computed and stored as edge feature.
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
Parameter< Mode >	p_pruningMode = {"mode", GlobalThreshold, this}
	operation mode
Parameter< double >	p_pruningThreshold = {"pruningThreshold", 1.0, this}
	(terminal) paths shorter than this threshold distance will be removed
Parameter< double >	p_sensitivity = {"sensitivity", 1.0, this}
	governs extent to which small paths are pruned when using distance-based pruning (more paths removed for higher sensitivity values)
Parameter< bool >	p_inPlace = {"inPlace", false, this}
	execute pruning in place
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.

Methods implementing the algorithm interface
void	compute () override
	execute algorithm
OwningDataList	takeOutput () override
	If p_inPlace is false output graph is returned here.
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)

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

Member Enumeration Documentation

Mode

enum Mode

Enumerator
GlobalThreshold	Pruning based on global threshold.
DistanceBased	Pruning based on distance image.

Member Function Documentation

createCompatible()

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

static

Factory method to check for applicability or to create the algorithm

compute()

void compute ( )

overridevirtual

execute algorithm

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

If p_inPlace is false output graph is returned here.

Reimplemented from Algorithm.

---

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

• ImFusion/Graph/PruneTerminalPathsAlgorithm.h