LiveStreamProcessingAlgorithm Class Reference

#include <ImFusion/Stream/LiveStreamProcessingAlgorithm.h>

Abstract base class for algorithms performing live stream processing without necessarily recording the data. More...

Inheritance diagram for LiveStreamProcessingAlgorithm:

Detailed Description

Abstract base class for algorithms performing live stream processing without necessarily recording the data.

Workflow: onStreamData -> Pre-Queue [ -> Background Thread Processing -> Post-Queue ] -> Main thread update

onStreamData is called from the input stream threads, data is copied into the pre-queue. Optionally, a background thread is taking care of processing data and filling the post-queue. Via the algorithmOutputChanged signal, a main thread update of the live container, which is shown in the views, is invoked, where data is eventually moved from the post-queue into this container.

Public Member Functions
	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.
void	compute () override
	Moves the data from the back buffer to the live container, accessible through the output interface.
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 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	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
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.
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 &inputData, std::vector< Stream * > &streams)
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
Signal	signalTrackingArrived
Parameter< double >	p_qualityThreshold {"qualityThreshold", 0.2, this}
	Quality threshold for matrix updates.
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.

Protected Member Functions
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 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 SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Protected Attributes
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 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.

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...

Member Function Documentation

compute()

void compute ( )

overridevirtual

Moves the data from the back buffer to the live container, accessible through the output interface.

Implements Algorithm.

Reimplemented in TrackingStreamVisualizationAlgorithm, and LiveSweepRecordingVisualizationAlgorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Transfers the live container and sets m_ownLiveContainer to false.

Reimplemented from Algorithm.

createLiveContainer()

virtual void createLiveContainer ( )

virtual

Fills m_liveContainer with a suitable container, default implementation creates a new TrackedSharedImageSet.

Reimplemented in LiveSweepRecordingVisualizationAlgorithm.

moveImages()

void moveImages ( TrackedSharedImageSet * tsisSrc, TrackedSharedImageSet * tsisDst )

protected

Moves all images from the source to the destination container.

After the operation, the source container does not contain any images.

moveTracking()

void moveTracking ( TrackedSharedImageSet * tsisSrc, TrackedSharedImageSet * tsisDst )

protected

Moves all tracking data from the source to the destination container.

Creates tracking streams as necessary. After the operation, all the source container's tracking streams still exist but are empty.

moveImagesAndTracking()

void moveImagesAndTracking ( TrackedSharedImageSet * tsisSrc, TrackedSharedImageSet * tsisDst )

protected

Moves all images and tracking data from the source to the destination container.

Creates tracking streams as necessary. After the operation, the source container does not contain any images, and all its tracking streams are empty.

moveBufferedDataToLiveContainer()

virtual void moveBufferedDataToLiveContainer ( )

protectedvirtual

Moves images and tracking data from one of the data buffers (depending on whether there is a background processing thread).

Should only be called from the main thread if the live container is already shown in any view.

Reimplemented in LiveSweepRecordingVisualizationAlgorithm.

---

The documentation for this class was generated from the following file:

• ImFusion/Stream/LiveStreamProcessingAlgorithm.h