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

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

Algorithm for tracking user-selected points in 2D image streams. More...

Inheritance diagram for ImFusion::Endoscopy::PointTrackingAlgorithm:

Detailed Description

Algorithm for tracking user-selected points in 2D image streams.

This algorithm allows interactive selection and tracking of points in a video/image stream. It manages user points, tracks their positions across frames, and provides visibility and confidence scores. The algorithm can be configured with grid parameters for support points and default grid size.

Public Member Functions

 PointTrackingAlgorithm (ImageStream *stream)
 Constructs the point tracking algorithm for the given image stream.
 ~PointTrackingAlgorithm ()
 Destructor.
void compute () override
 Runs the tracking algorithm on the current stream/frame.
OwningDataList takeOutput () override
 Returns the output data list containing tracking results.
void processFrame (const SharedImage &frame)
 Processes a single frame from the stream and updates tracking results.
void addTrackingPoint (const vec2f &point)
 Adds a user-selected point to track.
void removeProcessedPoint (int index)
 Removes a processed tracking point by index (for label deletion).
void clearTrackingPoints ()
 Clears all user-selected tracking points.
const std::vector< vec2f > & trackingPoints () const
 Returns the current list of user-selected tracking points.
std::vector< std::optional< std::vector< vec2f > > > coords () const
 Returns the tracked coordinates for each frame (optional per frame).
std::vector< std::optional< std::vector< float > > > viss () const
 Returns the visibility scores for each tracked point (optional per frame).
std::vector< std::optional< std::vector< float > > > confs () const
 Returns the confidence scores for each tracked point (optional per frame).
ImageStreamimageStream ()
 Returns the input image stream.
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 Member Functions inherited from ImFusion::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.
Progressprogress () 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 FactoryInfofactoryInfo () 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 ImFusion::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=0)
 Checks if the provided data is compatible and optionally creates an instance.
Static Public Member Functions inherited from ImFusion::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< size_t > p_defaultGridLen {"defaultGridLength", 16, this}
 Parameter: Default grid size for initializing tracking points.
Parameter< size_t > p_supportGridLen {"supportGridLength", 1, this}
Public Attributes inherited from ImFusion::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 ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

Public Types inherited from ImFusion::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 ImFusion::SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
Protected Member Functions inherited from ImFusion::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 ImFusion::Algorithm
std::string m_name
 Algorithm name.
Progressm_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< Actionm_actions
 Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from ImFusion::Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.

Constructor & Destructor Documentation

◆ PointTrackingAlgorithm()

ImFusion::Endoscopy::PointTrackingAlgorithm::PointTrackingAlgorithm ( ImageStream * stream)

Constructs the point tracking algorithm for the given image stream.

Parameters
streamPointer to the input ImageStream.

Member Function Documentation

◆ createCompatible()

bool ImFusion::Endoscopy::PointTrackingAlgorithm::createCompatible ( const DataList & data,
Algorithm ** a = 0 )
static

Checks if the provided data is compatible and optionally creates an instance.

Parameters
dataInput data list.
aOptional output pointer for the created algorithm instance.
Returns
True if compatible, false otherwise.

◆ compute()

void ImFusion::Endoscopy::PointTrackingAlgorithm::compute ( )
overridevirtual

Runs the tracking algorithm on the current stream/frame.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::Endoscopy::PointTrackingAlgorithm::takeOutput ( )
overridevirtual

Returns the output data list containing tracking results.

Reimplemented from ImFusion::Algorithm.

◆ processFrame()

void ImFusion::Endoscopy::PointTrackingAlgorithm::processFrame ( const SharedImage & frame)

Processes a single frame from the stream and updates tracking results.

Parameters
frameInput image frame.

◆ addTrackingPoint()

void ImFusion::Endoscopy::PointTrackingAlgorithm::addTrackingPoint ( const vec2f & point)

Adds a user-selected point to track.

Parameters
point2D coordinates in image space.

◆ removeProcessedPoint()

void ImFusion::Endoscopy::PointTrackingAlgorithm::removeProcessedPoint ( int index)

Removes a processed tracking point by index (for label deletion).

Parameters
indexIndex of the processed point to remove.

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