pcl::PlanarPolygon< PointT > Class Template Reference

PlanarPolygon represents a planar (2D) polygon, potentially in a 3D space. More...

#include <planar_polygon.h>

Inheritance diagram for pcl::PlanarPolygon< PointT >:

List of all members.

Public Types
typedef boost::shared_ptr < const PlanarPolygon< PointT > >	ConstPtr
typedef boost::shared_ptr < PlanarPolygon< PointT > >	Ptr
Public Member Functions
Eigen::Vector4f &	getCoefficients ()
	Getter for the coefficients.
const Eigen::Vector4f &	getCoefficients () const
	Getter for the coefficients.
pcl::PointCloud< PointT > ::VectorType &	getContour ()
	Getter for the contour / boundary.
const pcl::PointCloud< PointT > ::VectorType &	getContour () const
	Getter for the contour / boundary.
	PlanarPolygon ()
	Empty constructor for PlanarPolygon.
	PlanarPolygon (typename pcl::PointCloud< PointT >::VectorType &contour, Eigen::Vector4f &coefficients)
	Constructor for PlanarPolygon.
void	setCoefficients (const Eigen::Vector4f &coefficients)
	Setr the internal coefficients.
void	setCoefficients (const pcl::ModelCoefficients &coefficients)
	Set the internal coefficients.
void	setContour (const pcl::PointCloud< PointT > &contour)
	Set the internal contour.
virtual	~PlanarPolygon ()
	Destructor.
Protected Attributes
Eigen::Vector4f	coefficients_
	A list of model coefficients (a,b,c,d).
pcl::PointCloud< PointT > ::VectorType	contour_
	A list of points on the boundary/contour of the planar region.

---

Detailed Description

template<typename PointT>
class pcl::PlanarPolygon< PointT >

PlanarPolygon represents a planar (2D) polygon, potentially in a 3D space.

Author:

Alex Trevor

Definition at line 54 of file planar_polygon.h.

---

Member Typedef Documentation

template<typename PointT>

typedef boost::shared_ptr<const PlanarPolygon<PointT> > pcl::PlanarPolygon< PointT >::ConstPtr

Definition at line 58 of file planar_polygon.h.

template<typename PointT>

typedef boost::shared_ptr<PlanarPolygon<PointT> > pcl::PlanarPolygon< PointT >::Ptr

Definition at line 57 of file planar_polygon.h.

---

Constructor & Destructor Documentation

template<typename PointT>

pcl::PlanarPolygon< PointT >::PlanarPolygon

(

)

[inline]

Empty constructor for PlanarPolygon.

Definition at line 61 of file planar_polygon.h.

template<typename PointT>

pcl::PlanarPolygon< PointT >::PlanarPolygon	(	typename pcl::PointCloud< PointT >::VectorType &	contour,
		Eigen::Vector4f &	coefficients
	)		[inline]

Constructor for PlanarPolygon.

Parameters:

[in]	contour	a vector of points bounding the polygon
[in]	coefficients	a vector of the plane's coefficients (a,b,c,d)

Definition at line 68 of file planar_polygon.h.

template<typename PointT>

virtual pcl::PlanarPolygon< PointT >::~PlanarPolygon

(

)

[inline, virtual]

Destructor.

Definition at line 74 of file planar_polygon.h.

---

Member Function Documentation

template<typename PointT>

Eigen::Vector4f& pcl::PlanarPolygon< PointT >::getCoefficients

(

)

[inline]

Getter for the coefficients.

Definition at line 120 of file planar_polygon.h.

template<typename PointT>

const Eigen::Vector4f& pcl::PlanarPolygon< PointT >::getCoefficients

(

)

const [inline]

Getter for the coefficients.

Definition at line 127 of file planar_polygon.h.

template<typename PointT>

pcl::PointCloud<PointT>::VectorType& pcl::PlanarPolygon< PointT >::getContour

(

)

[inline]

Getter for the contour / boundary.

Definition at line 87 of file planar_polygon.h.

template<typename PointT>

const pcl::PointCloud<PointT>::VectorType& pcl::PlanarPolygon< PointT >::getContour

(

)

const [inline]

Getter for the contour / boundary.

Definition at line 94 of file planar_polygon.h.

template<typename PointT>

void pcl::PlanarPolygon< PointT >::setCoefficients

(

const Eigen::Vector4f &

coefficients

)

[inline]

Setr the internal coefficients.

Parameters:

[in]

coefficients

the new coefficients to be set

Definition at line 103 of file planar_polygon.h.

template<typename PointT>

void pcl::PlanarPolygon< PointT >::setCoefficients

(

const pcl::ModelCoefficients &

coefficients

)

[inline]

Set the internal coefficients.

Parameters:

[in]

coefficients

the new coefficients to be set

Definition at line 112 of file planar_polygon.h.

template<typename PointT>

void pcl::PlanarPolygon< PointT >::setContour

(

const pcl::PointCloud< PointT > &

contour

)

[inline]

Set the internal contour.

Parameters:

[in]

contour

the new planar polygonal contour

Definition at line 80 of file planar_polygon.h.

---

Member Data Documentation

template<typename PointT>

Eigen::Vector4f pcl::PlanarPolygon< PointT >::coefficients_ [protected]

A list of model coefficients (a,b,c,d).

Definition at line 137 of file planar_polygon.h.

template<typename PointT>

pcl::PointCloud<PointT>::VectorType pcl::PlanarPolygon< PointT >::contour_ [protected]

A list of points on the boundary/contour of the planar region.

Definition at line 134 of file planar_polygon.h.

---

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

• planar_polygon.h