 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/Seg/HistogramIntensityClusteringAlgorithm.h>
HistogramIntensityClusteringAlgorithm. More...
Inheritance diagram for HistogramIntensityClusteringAlgorithm:HistogramIntensityClusteringAlgorithm.
This algorithm computes a segmentation of the input image based on a intensity clustering. In order to perform this the histogram of the image is computed and local minima in the histogram are used to split the intensity clusters. Before the detection the histogram is smoothed and downsampled in order to make the detection more robust w.r.t. outliers. The labels are sorted in ascending order w.r.t. the intensities, i.e. the label 0 corresponds to the cluster with the lowest intensities. In addition the algorithm also provides a getter for the label indices sorted ascending w.r.t. the label size.
Public Member Functions | |
| HistogramIntensityClusteringAlgorithm (SharedImageSet &img) | |
| 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(). | |
| const std::vector< int > & | orderAscBySize () const |
| 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 bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| 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< bool > | p_debugOutput = {"debugOutput", false, this} |
| If set to true the processed histograms will be provided as output. | |
| Parameter< double > | p_minValHisto = {"minValHisto", 0.0, this} |
| min intensity for histogram | |
| Parameter< double > | p_maxValHisto = {"maxValHisto", 0.0, this} |
| Max intensity for histogram. | |
| Parameter< int > | p_smoothRadius = {"smoothRadius", 5, this} |
| Window radius for a smoothing filter applied to the histogram. | |
| Parameter< int > | p_underSamplingSkip = {"underSamplingSkip", 10, this} |
| The smoothed histogram will be undersampled and represented via a spline. | |
| Parameter< double > | p_clusterSizeRatio = {"clusterSizeRatio", 0.001, this} |
| Cluster size ratio. A detected cluster needs to have at least p_clusterSizeRatio * img.size() pixel/voxel to be considered. | |
| Parameter< double > | p_binSizeRatio = {"binSizeRatio", 0.00001, this} |
| Bin size ratio. A bin of the histogram gets ignored if it contains less than p_binSizeRatio * img.size() pixel/voxel. | |
| Parameter< double > | p_minMaxRatio = {"minMaxRatio", 1.3, this} |
| Minima to maxima ratio. | |
| 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. | |
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... | |
| 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. | |
|
overridevirtual |
Execute the algorithm.
Implements Algorithm.
|
overridevirtual |
| Parameter<double> p_minMaxRatio = {"minMaxRatio", 1.3, this} |
Minima to maxima ratio.
Ratio based on the count of the last maxima and the current minima If the ratio is bigger the minima is accepted
