 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Base/SuperpixelsAlgorithm.h>
Algorithm for computing superpixels (SLIC method) More...
Inheritance diagram for SuperpixelsAlgorithm:Algorithm for computing superpixels (SLIC method)
Public Member Functions | |
| SuperpixelsAlgorithm (SharedImage *imgIn) | |
| Creates the spline. | |
| ~SuperpixelsAlgorithm () override | |
| Destroy the spline. | |
| void | configure (const Properties *p) override |
| Set one or multiple properties. | |
| void | configuration (Properties *p) const override |
| Retrieve the properties of this object. | |
| void | compute () override |
| Compute the result. | |
| OwningDataList | takeOutput () override |
| If the algorithm creates new image data, it has to be transferred here. | |
| Superpixel | getSuperpixel (int k) const |
| Get info on a particular superpixel. | |
| const std::vector< Superpixel > & | getSuperpixels () const |
| Get all superpixels. | |
| int | nbSuperpixels () const |
| Get actual number of superpixels. | |
| void | updateSuperpixelsStats () |
| Compute the additional superpixels statistics. | |
| 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 | 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) |
| If data is compatible with algorithm return true. If a is not zero, create algorithm with input data. | |
| 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. | |
Protected Member Functions | |
| void | initSuperpixels () |
| void | assignLabelsToSuperpixels () |
| double | updateSuperpixels () |
| int | enforceLabelConnectivity2D () |
| int | enforceLabelConnectivity3D () |
| void | assignUnlabelledPixels () |
| void | removeEmptySuperpixels () |
| void | finalizeLabels () |
| bool | checkParameters () const |
| 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 | |
| SharedImage * | m_imgIn |
| std::unique_ptr< TypedImage< float > > | m_img |
| std::unique_ptr< TypedImage< float > > | m_minDist |
| std::unique_ptr< TypedImage< float > > | m_imageDist |
| std::unique_ptr< TypedImage< int > > | m_labels |
| std::unique_ptr< TypedImage< float > > | m_imageSimplified |
| std::vector< Superpixel > | m_superpixels |
| bool | m_verbose |
| size_t | m_workingSize |
| bool | m_skipRefinement |
| bool | m_randomInit |
| int | m_numberSp |
| int | m_maxSizeSpTarget |
| float | m_adaptiveness |
| int | m_maxIter |
| bool | m_randomIndices |
| bool | m_exportSimplifiedImage |
| int | m_maxSizeSp |
| 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. | |
Additional Inherited Members | |
| 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 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. | |
|
overridevirtual |
Set one or multiple properties.
Reimplemented from Configurable.
|
overridevirtual |
Retrieve the properties of this object.
Reimplemented from Configurable.
|
overridevirtual |
Compute the result.
Implements Algorithm.
|
overridevirtual |
If the algorithm creates new image data, it has to be transferred here.
Reimplemented from Algorithm.
