#include <pcl/common/generate.h>

Inheritance diagram for pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >:

Collaboration diagram for pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >:

Public Types
using	GeneratorParameters = typename GeneratorT::Parameters

using	GeneratorParameters

Public Member Functions
	CloudGenerator ()

	CloudGenerator (const GeneratorParameters &params)

	CloudGenerator (const GeneratorParameters &x_params, const GeneratorParameters &y_params)

void	setParameters (const GeneratorParameters &params)

void	setParametersForX (const GeneratorParameters &x_params)

void	setParametersForY (const GeneratorParameters &y_params)

const GeneratorParameters &	getParametersForX () const

const GeneratorParameters &	getParametersForY () const

pcl::PointXY	get ()

int	fill (pcl::PointCloud< pcl::PointXY > &cloud)

int	fill (int width, int height, pcl::PointCloud< pcl::PointXY > &cloud)

	CloudGenerator ()
	Default constructor.

	CloudGenerator (const GeneratorParameters &params)
	Constructor with single generator to ensure all X, Y and Z values are within same range.

	CloudGenerator (const GeneratorParameters &x_params, const GeneratorParameters &y_params, const GeneratorParameters &z_params)
	Constructor with independent generators per axis.

void	setParameters (const GeneratorParameters &params)
	Set parameters for x, y and z values.

void	setParametersForX (const GeneratorParameters &x_params)
	Set parameters for x values generation.

void	setParametersForY (const GeneratorParameters &y_params)
	Set parameters for y values generation.

void	setParametersForZ (const GeneratorParameters &z_params)
	Set parameters for z values generation.

const GeneratorParameters &	getParametersForX () const

const GeneratorParameters &	getParametersForY () const

const GeneratorParameters &	getParametersForZ () const

pcl::PointXY	get ()

int	fill (pcl::PointCloud< pcl::PointXY > &cloud)
	Generates a cloud with X Y Z picked within given ranges.

int	fill (int width, int height, pcl::PointCloud< pcl::PointXY > &cloud)
	Generates a cloud of specified dimensions with X Y Z picked within given ranges.

Detailed Description

template<typename GeneratorT>
class pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >

Definition at line 143 of file generate.h.

Member Typedef Documentation

◆ GeneratorParameters [1/2]

using pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::GeneratorParameters

Definition at line 61 of file generate.h.

◆ GeneratorParameters [2/2]

template<typename GeneratorT>

using pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::GeneratorParameters = typename GeneratorT::Parameters

Definition at line 146 of file generate.h.

Constructor & Destructor Documentation

◆ CloudGenerator() [1/6]

template<typename GeneratorT>

pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::CloudGenerator ( )

Definition at line 185 of file generate.hpp.

◆ CloudGenerator() [2/6]

template<typename GeneratorT>

pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::CloudGenerator ( const GeneratorParameters & params )

Definition at line 200 of file generate.hpp.

References setParameters().

◆ CloudGenerator() [3/6]

template<typename GeneratorT>

pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::CloudGenerator	(	const GeneratorParameters &	x_params,
		const GeneratorParameters &	y_params )

Definition at line 192 of file generate.hpp.

◆ CloudGenerator() [4/6]

pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::CloudGenerator ( )

Default constructor.

Definition at line 64 of file generate.hpp.

◆ CloudGenerator() [5/6]

pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::CloudGenerator ( const GeneratorParameters & params )

Constructor with single generator to ensure all X, Y and Z values are within same range.

Parameters

params parameters for X, Y and Z values generation. Uniqueness is ensured through seed incrementation

Definition at line 70 of file generate.hpp.

◆ CloudGenerator() [6/6]

pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::CloudGenerator	(	const GeneratorParameters &	x_params,
		const GeneratorParameters &	y_params,
		const GeneratorParameters &	z_params )

Constructor with independent generators per axis.

Parameters

x_params	parameters for x values generation
y_params	parameters for y values generation
z_params	parameters for z values generation

Definition at line 77 of file generate.hpp.

Member Function Documentation

◆ fill() [1/4]

int pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::fill	(	int	width,
		int	height,
		pcl::PointCloud< pcl::PointXY > &	cloud )

Generates a cloud of specified dimensions with X Y Z picked within given ranges.

Parameters

[in]	width	width of generated cloud
[in]	height	height of generated cloud
[out]	cloud	output cloud

Returns: 0 if generation went well else -1.

Definition at line 136 of file generate.hpp.

◆ fill() [2/4]

template<typename GeneratorT>

int pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::fill	(	int	width,
		int	height,
		pcl::PointCloud< pcl::PointXY > &	cloud )

Definition at line 262 of file generate.hpp.

References pcl::PointCloud< PointT >::empty(), pcl::PointCloud< PointT >::is_dense, and pcl::PointCloud< PointT >::resize().

◆ fill() [3/4]

int pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::fill ( pcl::PointCloud< pcl::PointXY > & cloud )

Generates a cloud with X Y Z picked within given ranges.

This function assumes that cloud is properly defined else it raises errors and does nothing.

Parameters

[out] cloud cloud to generate coordinates for

Returns: 0 if generation went well else -1.

Definition at line 127 of file generate.hpp.

◆ fill() [4/4]

template<typename GeneratorT>

int pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::fill ( pcl::PointCloud< pcl::PointXY > & cloud )

Definition at line 255 of file generate.hpp.

References fill(), pcl::PointCloud< PointT >::height, and pcl::PointCloud< PointT >::width.

Referenced by fill().

◆ get() [1/2]

pcl::PointXY pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::get ( )

Returns: a single random generated point

Definition at line 119 of file generate.hpp.

◆ get() [2/2]

template<typename GeneratorT>

pcl::PointXY pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::get ( )

Definition at line 245 of file generate.hpp.

References pcl::PointXY::x, and pcl::PointXY::y.

◆ getParametersForX() [1/2]

const CloudGenerator< pcl::PointXY, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::getParametersForX ( ) const

Returns: x values generation parameters

Definition at line 107 of file generate.hpp.

◆ getParametersForX() [2/2]

template<typename GeneratorT>

const CloudGenerator< pcl::PointXY, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::getParametersForX ( ) const

Definition at line 231 of file generate.hpp.

◆ getParametersForY() [1/2]

const CloudGenerator< pcl::PointXY, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::getParametersForY ( ) const

Returns: y values generation parameters

Definition at line 111 of file generate.hpp.

◆ getParametersForY() [2/2]

template<typename GeneratorT>

const CloudGenerator< pcl::PointXY, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::getParametersForY ( ) const

Definition at line 238 of file generate.hpp.

◆ getParametersForZ()

const CloudGenerator< pcl::PointXY, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::getParametersForZ ( ) const

Returns: z values generation parameters

Definition at line 115 of file generate.hpp.

◆ setParameters() [1/2]

void pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::setParameters ( const GeneratorParameters & params )

Set parameters for x, y and z values.

Uniqueness is ensured through seed incrementation.

Parameters

params parameters for X, Y and Z values generation.

Definition at line 85 of file generate.hpp.

◆ setParameters() [2/2]

template<typename GeneratorT>

void pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::setParameters ( const GeneratorParameters & params )

Definition at line 207 of file generate.hpp.

Referenced by CloudGenerator().

◆ setParametersForX() [1/2]

void pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::setParametersForX ( const GeneratorParameters & x_params )

Set parameters for x values generation.

Parameters

x_params parameters for x values generation

Definition at line 91 of file generate.hpp.

◆ setParametersForX() [2/2]

template<typename GeneratorT>

void pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::setParametersForX ( const GeneratorParameters & x_params )

Definition at line 217 of file generate.hpp.

◆ setParametersForY() [1/2]

void pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::setParametersForY ( const GeneratorParameters & y_params )

Set parameters for y values generation.

Parameters

y_params parameters for y values generation

Definition at line 97 of file generate.hpp.

◆ setParametersForY() [2/2]

template<typename GeneratorT>

void pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::setParametersForY ( const GeneratorParameters & y_params )

Definition at line 224 of file generate.hpp.

◆ setParametersForZ()

void pcl::common::CloudGenerator< pcl::PointXY, GeneratorT >::setParametersForZ ( const GeneratorParameters & z_params )

Set parameters for z values generation.

Parameters

z_params parameters for z values generation

Definition at line 103 of file generate.hpp.

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

pcl/common/generate.h
pcl/common/impl/generate.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ GeneratorParameters [1/2]

◆ GeneratorParameters [2/2]

Constructor & Destructor Documentation

◆ CloudGenerator() [1/6]

◆ CloudGenerator() [2/6]

◆ CloudGenerator() [3/6]

◆ CloudGenerator() [4/6]

◆ CloudGenerator() [5/6]

◆ CloudGenerator() [6/6]

Member Function Documentation

◆ fill() [1/4]

◆ fill() [2/4]

◆ fill() [3/4]

◆ fill() [4/4]

◆ get() [1/2]

◆ get() [2/2]

◆ getParametersForX() [1/2]

◆ getParametersForX() [2/2]

◆ getParametersForY() [1/2]

◆ getParametersForY() [2/2]

◆ getParametersForZ()

◆ setParameters() [1/2]

◆ setParameters() [2/2]

◆ setParametersForX() [1/2]

◆ setParametersForX() [2/2]

◆ setParametersForY() [1/2]

◆ setParametersForY() [2/2]

◆ setParametersForZ()