PointCloudToDepthMapAlgorithm Class Reference

#include <RGBD/Include/ImFusion/RGBD/PointCloudToDepthMapAlgorithm.h>

Provides conversion of a dense point cloud to a depth map. More...

Inheritance diagram for PointCloudToDepthMapAlgorithm:

Detailed Description

Provides conversion of a dense point cloud to a depth map.

This algorithm projects 3D points from a point cloud onto a 2D image plane, generating a depth map representation, where each pixel values corresponds to the distance of the corresponding 3D point from the 2D image plane. Optionally, it can also export a color image corresponding to the point cloud colors.

Typical usage involves constructing the algorithm with a point cloud, configuring scale and export options, and calling compute() to generate the depth map and optional color image.

const PointCloud* pc; // input point cloud
PointCloudToDepthMapAlgorithm algo(pc);
algo.setExportColorImage(true);
algo.compute();
auto output = algo.takeOutput();

Note

• The input point cloud must be valid and dense. Dense means that the points are organized in a grid-like structure typically stemming from depth sensors.
• The scale parameter controls the conversion from world units to depth map values.
• If exportColorImage is enabled, a second image with point colors is generated.
• All methods are not thread-safe unless otherwise stated.

See also

PointCloud, SharedImageSet

Public Member Functions
	PointCloudToDepthMapAlgorithm (const PointCloud *pointCloud)
	Constructs the algorithm for the given point cloud.
	~PointCloudToDepthMapAlgorithm () override
	Destroys the algorithm and releases resources.
void	setScale (double scale)
	Sets the scale factor for depth values.
double	scale () const
	Returns the current scale factor for depth values.
void	setExportColorImage (bool v)
	Enables or disables export of a color image.
bool	exportColorImage () const
	Returns true if export of a color image is enabled.
void	compute () override
	Runs the conversion from point cloud to depth map.
OwningDataList	takeOutput () override
	Returns the output data list and transfers ownership.
void	configure (const Properties *p) override
	Configures the algorithm from a Properties object.
void	configuration (Properties *p) const override
	Writes the current configuration to a Properties object.
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

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=0)
	Factory method for compatibility checking and creation. See Algorithm::createCompatible().
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.

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

Constructor & Destructor Documentation

PointCloudToDepthMapAlgorithm()

PointCloudToDepthMapAlgorithm

(

const PointCloud *

pointCloud

)

Constructs the algorithm for the given point cloud.

Parameters

pointCloud

Pointer to the input point cloud.

Member Function Documentation

setScale()

void setScale ( double scale )

inline

Sets the scale factor for depth values.

Depth values are multiplied by this factor before being written to the depth map.

setExportColorImage()

void setExportColorImage ( bool v )

inline

Enables or disables export of a color image.

If enabled, a second image with point colors is generated.

compute()

void compute ( )

overridevirtual

Runs the conversion from point cloud to depth map.

Implements Algorithm.

takeOutput()

OwningDataList takeOutput ( )

overridevirtual

Returns the output data list and transfers ownership.

Reimplemented from Algorithm.

configure()

void configure ( const Properties * p )

overridevirtual

Configures the algorithm from a Properties object.

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Writes the current configuration to a Properties object.

Reimplemented from Configurable.

---

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

• RGBD/Include/ImFusion/RGBD/PointCloudToDepthMapAlgorithm.h