ImFusion C++ SDK 4.4.0
ImFusion::Endoscopy::EndoscopicToolSegmentationCustomModel Class Reference

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

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

Inheritance diagram for ImFusion::Endoscopy::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 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
Public Member Functions inherited from ImFusion::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 ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

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

Member Function Documentation

◆ name()

std::string ImFusion::Endoscopy::EndoscopicToolSegmentationCustomModel::name ( ) const
inlineoverridevirtual

Returns the backend name ("Custom Model").

Implements ImFusion::Endoscopy::EndoscopicToolSegmentation.

◆ process()

std::unique_ptr< SharedImageSet > ImFusion::Endoscopy::EndoscopicToolSegmentationCustomModel::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 ImFusion::Endoscopy::EndoscopicToolSegmentation.

◆ configure()

void ImFusion::Endoscopy::EndoscopicToolSegmentationCustomModel::configure ( const Properties * p)
overridevirtual

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

Reimplemented from ImFusion::Configurable.

◆ configuration()

void ImFusion::Endoscopy::EndoscopicToolSegmentationCustomModel::configuration ( Properties * p) const
overridevirtual

Retrieves the current configuration of the backend.

Reimplemented from ImFusion::Configurable.


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