Detailed Description

Algorithm to extract depth images, color images, point clouds, and sequences from RGBDPlayback.

This algorithm enables extraction of various data types from an RGBDPlayback instance, including depth and color images, point clouds, and playback sequences. It supports configuration of export options, frame ranges, and sensor selection. To figure out the options, please check out the properties retrieved by configuration().

Usage:

Construct with a pointer to an RGBDPlayback instance.
Configure export options and frame ranges as needed.
Call compute() to perform extraction.
Retrieve results via takeOutput().

Important aspects:

Supports extraction of color and depth images, point clouds, and playback sequences.
Export options and frame ranges can be configured.
Sensor selection and frame step are supported.
Not thread-safe.

Example:

RGBDPlaybackExtractionAlgorithm algo(playback);
algo.configure(properties);
algo.compute();
auto output = algo.takeOutput();

Public Member Functions
	RGBDPlaybackExtractionAlgorithm (RGBDPlayback *playback)
	Constructor.

virtual	~RGBDPlaybackExtractionAlgorithm ()
	Destructor.

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

Protected Attributes
RGBDPlayback *	m_playback = nullptr
	Source playback object.

std::vector< std::unique_ptr< SharedImageSet > >	m_colorImages
	Extracted color images.

std::vector< std::unique_ptr< SharedImageSet > >	m_depthImages
	Extracted depth images.

std::vector< std::vector< std::unique_ptr< PointCloud > > >	m_pointClouds
	Extracted point clouds.

bool	m_exportColor = false
	If true, export color images.

bool	m_exportDepth = false
	If true, export depth images.

bool	m_exportPointCloud = true
	If true, export point clouds.

bool	m_exportPlayback = false
	If true, export playback sequences.

bool	m_includeColorInPointCloud = true
	If true, include color in point clouds.

double	m_depthCutoff = 1000.0
	Maximum depth value for point cloud extraction.

std::vector< int >	m_exportSensors
	Indices of sensors to export.

int	m_exportFrameStep = 1
	Step size between exported frames.

vec2i	m_exportFrameRange = vec2i(0, -1)
	Range of frames to export.

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.

Algorithm interface
OwningDataList	takeOutput () override
	Returns the output data created by the algorithm.

void	compute () override
	Executes the extraction algorithm.

static bool	createCompatible (const DataList &data, Algorithm **a=0)

Configurable interface
void	configure (const Properties *p) override

void	configuration (Properties *p) const override
	Retrieves the current properties of the algorithm.

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

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

Member Function Documentation

◆ createCompatible()

static bool createCompatible	(	const DataList &	data,
		Algorithm **	a = 0 )

static

Checks if input data is compatible and optionally creates an algorithm instance.

◆ takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Returns the output data created by the algorithm.

Reimplemented from Algorithm.

◆ compute()

void compute ( )

overridevirtual

Executes the extraction algorithm.

Implements Algorithm.

◆ configure()

void configure ( const Properties * p )

overridevirtual

Sets properties for the algorithm.

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p ) const

overridevirtual

Retrieves the current properties of the algorithm.

Reimplemented from Configurable.

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

RGBD/Include/ImFusion/RGBD/RGBDPlaybackExtractionAlgorithm.h

Detailed Description

Public Member Functions

Protected Attributes

Algorithm interface

Configurable interface

Additional Inherited Members

Member Function Documentation

◆ createCompatible()

◆ takeOutput()

◆ compute()

◆ configure()

◆ configuration()