 |
ImFusion C++ SDK 4.4.0
|
|
ImFusion C++ SDK 4.4.0
|
#include <ImFusion/Stream/TrackingStreamVisualizationAlgorithm.h>
Algorithm for real-time visualization of tracking data from a TrackingStream (deprecated). More...
Algorithm for real-time visualization of tracking data from a TrackingStream (deprecated).
This algorithm processes incoming tracking data and accumulates it into a live TrackedSharedImageSet container for visualization. It provides frame rate control and buffer size management to balance performance and visualization quality.
Key features:
The algorithm creates and maintains a TrackedSharedImageSet accessible via liveContainer(), which can be displayed in the GUI. All updates from the tracking stream are marshalled to the main thread for safe access to the live container.
Public Member Functions | |
| TrackingStreamVisualizationAlgorithm (TrackingStream *stream) | |
| Constructs the visualization algorithm for the given tracking stream. | |
| void | compute () override |
| Does not perform any work; tracking visualization happens automatically when new data arrives from the stream via callbacks. | |
| void | setTrackingUpdateFPS (int fps) |
| Sets the maximum update rate for tracking visualization in Hz. | |
| int | trackingUpdateFPS () |
| Returns the configured tracking update rate in Hz. | |
| void | setTrackingBufferSize (int bufferSize) |
| Sets the maximum number of tracking samples retained in the visualization buffer. | |
| int | trackingBufferSize () |
| Returns the configured tracking buffer size. | |
| void | setTrackingChangedClearsLive (bool flag) |
| Configures whether to clear tracking history when the instrument list changes. | |
| bool | trackingChangedClearsLive () |
| Returns whether tracking history is cleared on instrument list changes. | |
| TrackedSharedImageSet * | liveContainer () |
| Returns the live tracking container for visualization. | |
| void | configure (const Properties *p) override |
| Configure this object instance by de-serializing the given Properties. | |
| void | configuration (Properties *p) const override |
| Serialize the current object configuration into the given Properties object. | |
| Public Member Functions inherited from ImFusion::LiveStreamProcessingAlgorithm | |
| LiveStreamProcessingAlgorithm (std::vector< Stream * > inputStreams, bool hasBackgroundThread=false) | |
| void | onNewStreamData (std::shared_ptr< const StreamData > streamData) |
| Temporarily buffers copies of the streamData in internal queues. | |
| OwningDataList | takeOutput () override |
| Transfers the live container and sets m_ownLiveContainer to false. | |
| virtual void | createLiveContainer () |
| Fills m_liveContainer with a suitable container, default implementation creates a new TrackedSharedImageSet. | |
| virtual void | start () |
| Sets m_isRunning is true. | |
| virtual void | stop () |
| Sets m_isRunning to false. | |
| bool | isRunning () const |
| Returns m_isRunning. | |
| 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. | |
| 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 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. | |
| SignalReceiver & | operator= (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. | |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a=0) |
| Static Public Member Functions inherited from ImFusion::LiveStreamProcessingAlgorithm | |
| static bool | createCompatible (const DataList &inputData, std::vector< Stream * > &streams) |
| 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 | |
| Signal | signalTrackingSizeChanged |
| Emitted when the number of tracking instruments changes. | |
| Public Attributes inherited from ImFusion::LiveStreamProcessingAlgorithm | |
| Signal | signalTrackingArrived |
| Parameter< double > | p_qualityThreshold {"qualityThreshold", 0.2, this} |
| Quality threshold for matrix updates. | |
| 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::LiveStreamProcessingAlgorithm | |
| virtual void | onNewImagesArrived () |
| Announces either to the main thread (no background thread) or the background processing thread that new images have arrived. | |
| void | notifyListenersOutputChanged () |
| Issues algorithmOutputChanged to all listeners, in turn asking for a main thread update. | |
| double | extractTimestamp (const StreamData *data) |
| Extracts timestampDevice() or timestampArrival(), depending on m_useDeviceTimestamp. | |
| void | startProcessingThread () |
| Starts the processing thread, which will call backgroundThreadProcessData() after each notification. | |
| void | stopProcessingThread () |
| Stops the processing thread. | |
| virtual bool | backgroundThreadProcessData () |
| This method is called from the processing thread after each notification. To be called again without sleeping if returned true. | |
| void | moveImages (TrackedSharedImageSet *tsisSrc, TrackedSharedImageSet *tsisDst) |
| Moves all images from the source to the destination container. | |
| void | ensureSufficientTracking (TrackedSharedImageSet *tsisSrc, TrackedSharedImageSet *tsisDst) |
| Creates tracking streams as necessary for moveTracking() to be able to copy all tracking data. | |
| void | moveTracking (TrackedSharedImageSet *tsisSrc, TrackedSharedImageSet *tsisDst) |
| Moves all tracking data from the source to the destination container. | |
| void | moveImagesAndTracking (TrackedSharedImageSet *tsisSrc, TrackedSharedImageSet *tsisDst) |
| Moves all images and tracking data from the source to the destination container. | |
| virtual void | moveBufferedDataToLiveContainer () |
| Moves images and tracking data from one of the data buffers (depending on whether there is a background processing thread). | |
| void | selectAllFocusLast () |
| Helper method to select all frames of the live container and focus on the last one. | |
| 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 Member Functions inherited from ImFusion::SignalReceiver | |
| void | disconnectAll () |
| Disconnects all existing connections. | |
| Protected Attributes inherited from ImFusion::LiveStreamProcessingAlgorithm | |
| std::vector< Stream * > | m_inputStreams |
| Input streams listened to. | |
| const bool | m_hasBackgroundThread |
| Flag whether there is a background thread. | |
| TrackedSharedImageSet * | m_liveContainer = nullptr |
| bool | m_ownLiveContainer = false |
| bool | m_useDeviceTimestamp = false |
| If true, device's timestamp is recorded. false, arrival time of data is recorded. Default is false. | |
| int | m_maxImagesBuffered = -1 |
| Max. amount of buffered images, -1 is no limit. | |
| int | m_maxTrackingBuffered = -1 |
| Max. amount of buffered tracking data, -1 is no limit. | |
| std::unique_ptr< TrackedSharedImageSet > | m_dataBufferPre |
| Data buffer between onStreamData and further processing. | |
| std::mutex | m_dataBufferPreMutex |
| Mutex protecting m_dataBufferPre. | |
| std::map< std::string, mat4 > | m_lastGoodPositions |
| Cache for last matrix of each instrument with good quality. | |
| std::unique_ptr< TrackedSharedImageSet > | m_dataBufferPost |
| Data buffer filled by background thread. | |
| std::mutex | m_dataBufferPostMutex |
| Mutex protecting m_dataBufferPost. | |
| std::atomic< bool > | m_isRunning = {false} |
| Flag whether stream events are being processed. | |
| std::future< void > | m_processingThread |
| Background processing thread future. | |
| std::mutex | m_processingThreadMutex |
| Mutex protecting m_processingThread. | |
| bool | m_processingThreadStopExecution |
| Flag indicating the background thread to stop. | |
| std::condition_variable | m_processingThreadCondition |
| Cond.var. to wake up background thread. | |
| Protected Attributes inherited from ImFusion::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 ImFusion::Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
explicit |
Constructs the visualization algorithm for the given tracking stream.
Initializes live container and sets up debounced processing of tracking updates.
|
overridevirtual |
Does not perform any work; tracking visualization happens automatically when new data arrives from the stream via callbacks.
Reimplemented from ImFusion::LiveStreamProcessingAlgorithm.
| void ImFusion::TrackingStreamVisualizationAlgorithm::setTrackingUpdateFPS | ( | int | fps | ) |
Sets the maximum update rate for tracking visualization in Hz.
Higher values provide smoother visualization but increase CPU load.
| void ImFusion::TrackingStreamVisualizationAlgorithm::setTrackingBufferSize | ( | int | bufferSize | ) |
Sets the maximum number of tracking samples retained in the visualization buffer.
Determines the length of the tracking history "tail". Set to 0 for unlimited.
| void ImFusion::TrackingStreamVisualizationAlgorithm::setTrackingChangedClearsLive | ( | bool | flag | ) |
Configures whether to clear tracking history when the instrument list changes.
When true, discards old tracking data when instruments are added/removed.
|
inline |
Returns the live tracking container for visualization.
Container is automatically updated with tracking data from the stream.
|
overridevirtual |
Configure this object instance by de-serializing the given Properties.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from ImFusion::Configurable.
|
overridevirtual |
Serialize the current object configuration into the given Properties object.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from ImFusion::Configurable.
| Signal ImFusion::TrackingStreamVisualizationAlgorithm::signalTrackingSizeChanged |
Emitted when the number of tracking instruments changes.
Signal is emitted after the instrument list has been updated in the live container.