#include <ImFusion/Vision/PlaybackStereoImageStreamAlgorithm.h>

Creates a PlaybackStereoImageStream from a StereoSharedImageSet. More...

Inheritance diagram for ImFusion::PlaybackStereoImageStreamAlgorithm:

Detailed Description

Creates a PlaybackStereoImageStream from a StereoSharedImageSet.

Inherits playback controls from PlaybackAlgorithmBase (speed factor, FPS, looping, delayed-frame skipping, and timestamp queries). See PlaybackStereoImageStream for stream behavior.

Public Member Functions
	PlaybackStereoImageStreamAlgorithm (StereoSharedImageSet *ssis)
Public Member Functions inherited from ImFusion::PlaybackAlgorithmBase
virtual double	speedFactor () const
	Return the current playback speed factor.
virtual double	fps () const
	Return the current playback FPS.
virtual bool	skipDelayedFrames () const
	Return whether delayed frames are skipped.
virtual bool	loop () const
	Return whether playback is looped.
Public Member Functions inherited from ImFusion::StreamAlgorithmBase
bool	isOutputTaken () const
virtual DataGroup *	dataGroup ()
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.
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

Algorithm interface methods
void	compute () override
	Execute the algorithm.
OwningDataList	takeOutput () override
	Returns an OwningDataList containing the stream and sets m_isOutputTaken to true.
void	configure (const Properties *p) override
	Set one or multiple properties.
void	configuration (Properties *p) const override
	Retrieve the properties of this object.
Stream *	stream () override
	Return the playback stereo stream created by compute().
void	setSpeedFactor (const double speedFactor) override
	Set the playback speed factor (delegates to PlaybackAlgorithmBase).
void	setFps (const double fps) override
	Set the playback FPS (delegates to PlaybackAlgorithmBase).
void	setSkipDelayedFrames (const bool skipDelayedFrames) override
	Configure skipping of delayed frames (delegates to PlaybackAlgorithmBase).
void	setLoop (const bool loop) override
	Enable or disable looping playback (delegates to PlaybackAlgorithmBase).
bool	timestampValid () const override
	Return whether the underlying stereo image set provides valid timestamps.
bool	timestampValidAndEquidistant () const override
	Return whether timestamps are valid and approximately equidistant.
std::optional< double >	calculatedInitialFps () const override
	Return the frame rate inferred from equidistant timestamps, if available.
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
void	resetStream () override
	Deletes the stream if m_isOutputTaken is false. In any case sets the stream to nullptr.
void	streamParametersChanged () override
	Notify listeners that playback parameters changed (delegates to the underlying stream).

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...
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 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.
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::PlaybackAlgorithmBase
bool	m_loop = true
double	m_fps = 30.0
double	m_speedFactor = 1.0
bool	m_skipDelayedFrames = false
Protected Attributes inherited from ImFusion::StreamAlgorithmBase
bool	m_isOutputTaken = false
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.

Member Function Documentation

◆ compute()

void ImFusion::PlaybackStereoImageStreamAlgorithm::compute ( )

overridevirtual

Execute the algorithm.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::PlaybackStereoImageStreamAlgorithm::takeOutput ( )

overridevirtual

Returns an OwningDataList containing the stream and sets m_isOutputTaken to true.

If m_isOutputTaken is already true then an empty list is returned.

Reimplemented from ImFusion::StreamAlgorithmBase.

◆ configure()

void ImFusion::PlaybackStereoImageStreamAlgorithm::configure ( const Properties * p )

overridevirtual

Set one or multiple properties.

Reimplemented from ImFusion::Configurable.

◆ configuration()

void ImFusion::PlaybackStereoImageStreamAlgorithm::configuration ( Properties * p ) const

overridevirtual

Retrieve the properties of this object.

Reimplemented from ImFusion::Configurable.

◆ stream()

Stream * ImFusion::PlaybackStereoImageStreamAlgorithm::stream ( )

overridevirtual

Return the playback stereo stream created by compute().

Implements ImFusion::StreamAlgorithmBase.

◆ setSpeedFactor()

void ImFusion::PlaybackStereoImageStreamAlgorithm::setSpeedFactor ( const double speedFactor )

overridevirtual

Set the playback speed factor (delegates to PlaybackAlgorithmBase).

Implements ImFusion::PlaybackAlgorithmBase.

◆ setFps()

void ImFusion::PlaybackStereoImageStreamAlgorithm::setFps ( const double fps )

overridevirtual

Set the playback FPS (delegates to PlaybackAlgorithmBase).

Implements ImFusion::PlaybackAlgorithmBase.

◆ setSkipDelayedFrames()

void ImFusion::PlaybackStereoImageStreamAlgorithm::setSkipDelayedFrames ( const bool skipDelayedFrames )

overridevirtual

Configure skipping of delayed frames (delegates to PlaybackAlgorithmBase).

Implements ImFusion::PlaybackAlgorithmBase.

◆ setLoop()

void ImFusion::PlaybackStereoImageStreamAlgorithm::setLoop ( const bool loop )

overridevirtual

Enable or disable looping playback (delegates to PlaybackAlgorithmBase).

Implements ImFusion::PlaybackAlgorithmBase.

◆ timestampValid()

bool ImFusion::PlaybackStereoImageStreamAlgorithm::timestampValid ( ) const

overridevirtual

Return whether the underlying stereo image set provides valid timestamps.

Implements ImFusion::PlaybackAlgorithmBase.

◆ timestampValidAndEquidistant()

bool ImFusion::PlaybackStereoImageStreamAlgorithm::timestampValidAndEquidistant ( ) const

overridevirtual

Return whether timestamps are valid and approximately equidistant.

Implements ImFusion::PlaybackAlgorithmBase.

◆ calculatedInitialFps()

std::optional< double > ImFusion::PlaybackStereoImageStreamAlgorithm::calculatedInitialFps ( ) const

overridevirtual

Return the frame rate inferred from equidistant timestamps, if available.

Implements ImFusion::PlaybackAlgorithmBase.

◆ resetStream()

void ImFusion::PlaybackStereoImageStreamAlgorithm::resetStream ( )

overrideprotectedvirtual

Deletes the stream if m_isOutputTaken is false. In any case sets the stream to nullptr.

Implements ImFusion::StreamAlgorithmBase.

◆ streamParametersChanged()

void ImFusion::PlaybackStereoImageStreamAlgorithm::streamParametersChanged ( )

overrideprotectedvirtual

Notify listeners that playback parameters changed (delegates to the underlying stream).

Implements ImFusion::PlaybackAlgorithmBase.

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

ImFusion/Vision/PlaybackStereoImageStreamAlgorithm.h

Detailed Description

Public Member Functions

Algorithm interface methods

Additional Inherited Members

Member Function Documentation

◆ compute()

◆ takeOutput()

◆ configure()

◆ configuration()

◆ stream()

◆ setSpeedFactor()

◆ setFps()

◆ setSkipDelayedFrames()

◆ setLoop()

◆ timestampValid()

◆ timestampValidAndEquidistant()

◆ calculatedInitialFps()

◆ resetStream()

◆ streamParametersChanged()