pcl::common::CloudGenerator< PointT, GeneratorT > Class Template Reference

#include <generate.h>

List of all members.

Public Types
typedef GeneratorT::Parameters	GeneratorParameters
Public Member Functions
	CloudGenerator ()
	Default constructor.
	CloudGenerator (const GeneratorParameters &params)
	CloudGenerator (const GeneratorParameters &x_params, const GeneratorParameters &y_params, const GeneratorParameters &z_params)
int	fill (pcl::PointCloud< PointT > &cloud)
int	fill (int width, int height, pcl::PointCloud< PointT > &cloud)
PointT	get ()
const GeneratorParameters &	getParametersForX () const
const GeneratorParameters &	getParametersForY () const
const GeneratorParameters &	getParametersForZ () const
void	setParameters (const GeneratorParameters &params)
void	setParametersForX (const GeneratorParameters &x_params)
void	setParametersForY (const GeneratorParameters &y_params)
void	setParametersForZ (const GeneratorParameters &z_params)
Private Attributes
GeneratorT	x_generator_
GeneratorT	y_generator_
GeneratorT	z_generator_

---

Detailed Description

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

Definition at line 59 of file generate.h.

---

Member Typedef Documentation

template<typename PointT, typename GeneratorT>

typedef GeneratorT::Parameters pcl::common::CloudGenerator< PointT, GeneratorT >::GeneratorParameters

Definition at line 62 of file generate.h.

---

Constructor & Destructor Documentation

template<typename PointT , typename GeneratorT >

pcl::common::CloudGenerator< PointT, GeneratorT >::CloudGenerator

(

)

Default constructor.

Definition at line 47 of file generate.hpp.

template<typename PointT , typename GeneratorT >

pcl::common::CloudGenerator< PointT, GeneratorT >::CloudGenerator

(

const GeneratorParameters &

params

)

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

Parameters:

params

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

Definition at line 55 of file generate.hpp.

template<typename PointT , typename GeneratorT >

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

Constructor with independant 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 63 of file generate.hpp.

---

Member Function Documentation

template<typename PointT , typename GeneratorT >

int pcl::common::CloudGenerator< PointT, GeneratorT >::fill

(

pcl::PointCloud< PointT > &

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 139 of file generate.hpp.

template<typename PointT , typename GeneratorT >

int pcl::common::CloudGenerator< PointT, GeneratorT >::fill	(	int	width,
		int	height,
		pcl::PointCloud< PointT > &	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 146 of file generate.hpp.

template<typename PointT , typename GeneratorT >

PointT pcl::common::CloudGenerator< PointT, GeneratorT >::get

(

)

Returns:

a single random generated point

Definition at line 128 of file generate.hpp.

template<typename PointT , typename GeneratorT >

const pcl::common::CloudGenerator< PointT, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< PointT, GeneratorT >::getParametersForX

(

)

const

Returns:

x values generation parameters

Definition at line 107 of file generate.hpp.

template<typename PointT , typename GeneratorT >

const pcl::common::CloudGenerator< PointT, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< PointT, GeneratorT >::getParametersForY

(

)

const

Returns:

y values generation parameters

Definition at line 114 of file generate.hpp.

template<typename PointT , typename GeneratorT >

const pcl::common::CloudGenerator< PointT, GeneratorT >::GeneratorParameters & pcl::common::CloudGenerator< PointT, GeneratorT >::getParametersForZ

(

)

const

Returns:

z values generation parameters

Definition at line 121 of file generate.hpp.

template<typename PointT , typename GeneratorT >

void pcl::common::CloudGenerator< PointT, GeneratorT >::setParameters

(

const GeneratorParameters &

params

)

Set parameters for x, y and z values. Uniqueness is ensured through seed incrementation.

Parameters:

params

parameteres for X, Y and Z values generation.

Definition at line 73 of file generate.hpp.

template<typename PointT , typename GeneratorT >

void pcl::common::CloudGenerator< PointT, GeneratorT >::setParametersForX

(

const GeneratorParameters &

x_params

)

Set parameters for x values generation

Parameters:

x_params

paramters for x values generation

Definition at line 86 of file generate.hpp.

template<typename PointT , typename GeneratorT >

void pcl::common::CloudGenerator< PointT, GeneratorT >::setParametersForY

(

const GeneratorParameters &

y_params

)

Set parameters for y values generation

Parameters:

y_params

paramters for y values generation

Definition at line 93 of file generate.hpp.

template<typename PointT , typename GeneratorT >

void pcl::common::CloudGenerator< PointT, GeneratorT >::setParametersForZ

(

const GeneratorParameters &

z_params

)

Set parameters for z values generation

Parameters:

z_params

paramters for z values generation

Definition at line 100 of file generate.hpp.

---

Member Data Documentation

template<typename PointT, typename GeneratorT>

GeneratorT pcl::common::CloudGenerator< PointT, GeneratorT >::x_generator_ [private]

Definition at line 140 of file generate.h.

template<typename PointT, typename GeneratorT>

GeneratorT pcl::common::CloudGenerator< PointT, GeneratorT >::y_generator_ [private]

Definition at line 140 of file generate.h.

template<typename PointT, typename GeneratorT>

GeneratorT pcl::common::CloudGenerator< PointT, GeneratorT >::z_generator_ [private]

Definition at line 140 of file generate.h.

---

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

• generate.h
• generate.hpp