#include <ImFusion/Graph/ComputeCommonGraphFeaturesAlgorithm.h>

Algorithm for computing different edge features such as length, diameter, cross-section, and node degree in a graph. More...

Inheritance diagram for ImFusion::ComputeCommonGraphFeaturesAlgorithm:

Detailed Description

Algorithm for computing different edge features such as length, diameter, cross-section, and node degree in a graph.

Supports vessel diameter estimation from label maps, with optional smoothing and clamping of extreme values.

Public Types
enum class	Mode : int { EdgeLength = 0 , EdgeDiameter = 1 , EdgeCrossSection = 2 , NodeDegree = 3 , VesselDiameter = 4 }
	Operation modes for edge feature computation. 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
	ComputeCommonGraphFeaturesAlgorithm (Graph &graph, SharedImageSet *label=nullptr)
void	compute () override
	Execute the algorithm.
OwningDataList	takeOutput () override
	Return any new Data that was created by the Algorithm during the last call to compute().
Public Member Functions inherited from ImFusion::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 ImFusion::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 int	computeDiameters (Graph &graph, const SharedImage &labelMap, bool averageZeroEdges=true, double threshold=0.5)
	Computes diameters of edges in a graph using a label map.
static int	computeVesselDiameters (Graph &graph, const SharedImage &labelMap, bool clampEdges, std::optional< int > slidingAverage, bool averageZeroEdges=true, double threshold=0.5)
	Computes vessel diameters of edges in a graph using a label map, with optional smoothing and clamping.
static int	computeEdgeLengths (Graph &graph)
	Computes edge lengths and stores them as edge features.
static int	computeCrossSections (Graph &graph)
	Computes cross sections based on diameters and stores them as edge features.
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
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.

Public Attributes
Parameter< Mode >	p_mode = {"mode", Mode::EdgeLength, this}
	Operation mode for feature computation.
Parameter< bool >	p_averageZeroEdges = {"averageZeroEdges", false, this}
	Assign all empty edges (value 0.0) an average value of neighbors.
Parameter< double >	p_threshold = {"threshold", 0.5, this}
	Pixel values below this threshold are considered outside in the corresponding label.
Parameter< std::optional< int > >	p_slidingAverage = {"slidingAverage", 3, this}
	Size of the sliding window for median smoothing of computed diameters (in edges).
Parameter< bool >	p_clampEdges = {"clampEdges", true, this}
	Enable one-sided clamping of segment edge diameters to limit extreme values at segment ends or short branches.
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.

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

◆ Mode

enum class ImFusion::ComputeCommonGraphFeaturesAlgorithm::Mode : int

strong

Operation modes for edge feature computation.

Enumerator
EdgeLength	Compute edge lengths.
EdgeDiameter	Compute edge diameters from label map.
EdgeCrossSection	Compute edge cross-sections from diameters.
NodeDegree	Compute node degrees.
VesselDiameter	Compute vessel diameters with smoothing/clamping.

Member Function Documentation

◆ computeDiameters()

int ImFusion::ComputeCommonGraphFeaturesAlgorithm::computeDiameters	(	Graph &	graph,
		const SharedImage &	labelMap,
		bool	averageZeroEdges = true,
		double	threshold = 0.5 )

static

Computes diameters of edges in a graph using a label map.

The diameter is chosen so that a (filled) circle normal to the edge contains only nonzero label values.

Parameters

graph	Graph to process.
labelMap	Label map image (binary or probabilistic).
averageZeroEdges	If true, assigns average neighbor value to edges with zero diameter.
threshold	Minimum label value to consider as inside (default: 0.5).

Returns: Index of the diameter feature in the edge feature vector.

◆ computeVesselDiameters()

int ImFusion::ComputeCommonGraphFeaturesAlgorithm::computeVesselDiameters	(	Graph &	graph,
		const SharedImage &	labelMap,
		bool	clampEdges,
		std::optional< int >	slidingAverage,
		bool	averageZeroEdges = true,
		double	threshold = 0.5 )

static

Computes vessel diameters of edges in a graph using a label map, with optional smoothing and clamping.

The diameter is chosen so that a (filled) circle normal to the edge contains only nonzero label values.

Parameters

graph	Graph to process.
labelMap	Label map image (binary or probabilistic).
clampEdges	If true, applies one-sided clamping at segment ends (see clampFactor in GraphUtils).
slidingAverage	Size of sliding window for median smoothing (in edges).
averageZeroEdges	If true, assigns average neighbor value to edges with zero diameter.
threshold	Minimum label value to consider as inside (default: 0.5).

Returns: Index of the diameter feature in the edge feature vector.

◆ computeEdgeLengths()

int ImFusion::ComputeCommonGraphFeaturesAlgorithm::computeEdgeLengths ( Graph & graph )

static

Computes edge lengths and stores them as edge features.

Parameters

graph Graph to process.

Returns: Index of the length feature in the edge feature vector.

◆ computeCrossSections()

int ImFusion::ComputeCommonGraphFeaturesAlgorithm::computeCrossSections ( Graph & graph )

static

Computes cross sections based on diameters and stores them as edge features.

Parameters

graph Graph to process.

Returns: Index of the cross-section feature in the edge feature vector.

◆ compute()

void ImFusion::ComputeCommonGraphFeaturesAlgorithm::compute ( )

overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::ComputeCommonGraphFeaturesAlgorithm::takeOutput ( )

overridevirtual

Return any new Data that was created by the Algorithm during the last call to compute().

The default implementation will return an empty list.

Note: Since ownership of the data is transferred, you can call this method only once between calls to compute().

Reimplemented from ImFusion::Algorithm.

Member Data Documentation

◆ p_clampEdges

Parameter<bool> ImFusion::ComputeCommonGraphFeaturesAlgorithm::p_clampEdges = {"clampEdges", true, this}

Enable one-sided clamping of segment edge diameters to limit extreme values at segment ends or short branches.

Only values above the threshold are clamped (see clampFactor in GraphUtils).

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

ImFusion/Graph/ComputeCommonGraphFeaturesAlgorithm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ Mode

Member Function Documentation

◆ computeDiameters()

◆ computeVesselDiameters()

◆ computeEdgeLengths()

◆ computeCrossSections()

◆ compute()

◆ takeOutput()

Member Data Documentation

◆ p_clampEdges