ImFusion SDK 4.3
EndoscopicToolSegmentationCustomModel Class Reference

#include <EndoscopyPlugin/Include/ImFusion/Endoscopy/EndoscopicToolSegmentationCustomModel.h>

Endoscopic tool segmentation using a custom machine learning model. More...

+ Inheritance diagram for EndoscopicToolSegmentationCustomModel:

Detailed Description

Endoscopic tool segmentation using a custom machine learning model.

This backend loads a machine learning model from a user-specified configuration path and applies it to the input image set to produce a segmentation label image. The model path is set via the "modelConfigurationPath" parameter. The output is a label image with classes for "Background" and "Endoscopic Tool".

Public Member Functions

 EndoscopicToolSegmentationCustomModel ()
 Constructs the custom model backend.
 
std::string name () const override
 Returns the backend name ("Custom Model").
 
std::unique_ptr< SharedImageSetprocess (const SharedImageSet &images)
 Runs the segmentation model on the input image set.
 
void configure (const Properties *p) override
 Configures the backend with the given properties (e.g., model path).
 
void configuration (Properties *p) const override
 Retrieves the current configuration of the backend.
 
bool hasValidModelPath () const
 Checks if the model path is valid and points to an existing file.
 
- 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 
- Public Member Functions inherited from SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
 
SignalReceiveroperator= (SignalReceiver rhs)
 Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
 
virtual ~SignalReceiver ()
 Virtual destructor disconnects from all connected signals.
 

Public Attributes

Parameter< Filesystem::Pathp_modelPath = {"modelConfigurationPath", "", *this}
 Parameter for specifying the model configuration file path.
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 

Additional Inherited Members

- Protected Member Functions inherited from SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ name()

std::string name ( ) const
inlineoverridevirtual

Returns the backend name ("Custom Model").

Implements EndoscopicToolSegmentation.

◆ process()

std::unique_ptr< SharedImageSet > process ( const SharedImageSet & images)
virtual

Runs the segmentation model on the input image set.

Parameters
imagesInput image set (must be compatible with the model).
Returns
Segmentation result as a label image, or nullptr on error.

Implements EndoscopicToolSegmentation.

◆ configure()

void configure ( const Properties * p)
overridevirtual

Configures the backend with the given properties (e.g., model path).

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p) const
overridevirtual

Retrieves the current configuration of the backend.

Reimplemented from Configurable.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close