 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <EndoscopyPlugin/Include/ImFusion/Endoscopy/EndoscopicToolSegmentationAlgorithm.h>
Algorithm for segmenting endoscopic tools in image sequences. More...
Inheritance diagram for EndoscopicToolSegmentationAlgorithm:Algorithm for segmenting endoscopic tools in image sequences.
This algorithm supports multiple segmentation backends, selectable via the parameter "endoscopicToolSegmentationAlgorithm". It processes a 2D image set and outputs a label image with classes for "Background" and "Endoscopic Tool". The algorithm can be configured with additional properties depending on the selected backend (e.g., model path for ML models).
Public Member Functions | |
| EndoscopicToolSegmentationAlgorithm (SharedImageSet *images) | |
| Constructs the algorithm with the given image sequence. | |
| void | compute () override |
| Runs the segmentation algorithm and produces output. | |
| void | configure (const Properties *p) override |
| Configures the algorithm with the given properties. | |
| void | configuration (Properties *p) const override |
| Retrieves the current configuration of the algorithm and backend. | |
| OwningDataList | takeOutput () override |
| Returns the output data list containing the segmentation result. | |
| SharedImageSet * | imgSequence () const |
| Returns the input image sequence. | |
| 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=0) |
| Checks if the provided data is compatible and optionally creates an instance. | |
| 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< std::string > | p_toolSegName = {"endoscopicToolSegmentationAlgorithm", "", this} |
| Parameter for selecting the segmentation backend. | |
| 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. | |
| EndoscopicToolSegmentationAlgorithm | ( | SharedImageSet * | images | ) |
Constructs the algorithm with the given image sequence.
| images | Pointer to the input SharedImageSet (must be 8-bit RGB, single slice per image). |
Checks if the provided data is compatible and optionally creates an instance.
| data | Input data list. |
| a | Optional output pointer for the created algorithm instance. |
|
overridevirtual |
Runs the segmentation algorithm and produces output.
Implements Algorithm.
|
overridevirtual |
Configures the algorithm with the given properties.
Passes configuration to the selected backend if available.
Reimplemented from Configurable.
|
overridevirtual |
Retrieves the current configuration of the algorithm and backend.
Reimplemented from Configurable.
|
overridevirtual |
Returns the output data list containing the segmentation result.
Reimplemented from Algorithm.
| Parameter<std::string> p_toolSegName = {"endoscopicToolSegmentationAlgorithm", "", this} |
Parameter for selecting the segmentation backend.
The value should match one of the available backend names.
