ImFusion C++ SDK 4.5.0
ImFusion::GraphLaplacianAlgorithm Class Reference

#include <ImFusion/Seg/GraphLaplacianAlgorithm.h>

Image segmentation in 2D or 3D using graph-based segmentation to solve a Laplacian problem. More...

Inheritance diagram for ImFusion::GraphLaplacianAlgorithm:

Detailed Description

Image segmentation in 2D or 3D using graph-based segmentation to solve a Laplacian problem.

Public Types

enum  GraphLaplacianType { IMAGE = 0 , SUPERPIXELS = 1 , ATTENUATION = 2 , SUPERPIXELS_ATTENUATION = 3 }
 Enum for the graph types.
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

 GraphLaplacianAlgorithm (SharedImage &image, SharedImage &labels, SharedImage *prior=nullptr)
 Main constructor.
 ~GraphLaplacianAlgorithm () override
 Destructor.
void compute () override
 Execute the algorithm.
OwningDataList takeOutput () override
 Output of the algorithm.
void configure (const Properties *p) override
 Set one or multiple properties.
void configuration (Properties *p) const override
 Retrieve the properties of this object.
void updateLabels (SharedImage &labels)
 Update the label map.
void reset ()
 Reset the algorithm (in particular current solution).
size_t memoryEstimation (int minLevel)
 Returns an estimation of the required memory with the current configuration.
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 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 bool createCompatible (const DataList &data, Algorithm **a=0)
 If data is compatible with algorithm return true. If a is not zero, create algorithm with input data.
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.

Additional Inherited Members

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.
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 Function Documentation

◆ compute()

void ImFusion::GraphLaplacianAlgorithm::compute ( )
overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::GraphLaplacianAlgorithm::takeOutput ( )
overridevirtual

Output of the algorithm.

Reimplemented from ImFusion::Algorithm.

◆ configure()

void ImFusion::GraphLaplacianAlgorithm::configure ( const Properties * p)
overridevirtual

Set one or multiple properties.

Reimplemented from ImFusion::Configurable.

◆ configuration()

void ImFusion::GraphLaplacianAlgorithm::configuration ( Properties * p) const
overridevirtual

Retrieve the properties of this object.

Reimplemented from ImFusion::Configurable.


The documentation for this class was generated from the following file:
  • ImFusion/Seg/GraphLaplacianAlgorithm.h
Search Tab / S to search, Esc to close