pcl::PlanarRegion< PointT > Class Template Reference

PlanarRegion represents a set of points that lie in a plane. More...

#include <pcl/segmentation/planar_region.h>

Inheritance diagram for pcl::PlanarRegion< PointT >:

Collaboration diagram for pcl::PlanarRegion< PointT >:

List of all members.

Public Member Functions
	PlanarRegion ()
	Empty constructor for PlanarRegion.
	PlanarRegion (const pcl::Region3D< PointT > &region, const pcl::PlanarPolygon< PointT > &polygon)
	Constructor for Planar region from a Region3D and a PlanarPolygon.
virtual	~PlanarRegion ()
	Destructor.
	PlanarRegion (const Eigen::Vector3f &centroid, const Eigen::Matrix3f &covariance, unsigned count, const typename pcl::PointCloud< PointT >::VectorType &contour, const Eigen::Vector4f &coefficients)
	Constructor for PlanarRegion.
Eigen::Vector3f	getCentroid () const
	Get the centroid of the region.
Eigen::Matrix3f	getCovariance () const
	Get the covariance of the region.
unsigned	getCount () const
	Get the number of points in the region.
pcl::PointCloud< PointT > ::VectorType &	getContour ()
	Getter for the contour / boundary.
const pcl::PointCloud< PointT > ::VectorType &	getContour () const
	Getter for the contour / boundary.
Eigen::Vector4f &	getCoefficients ()
	Getter for the coefficients.
const Eigen::Vector4f &	getCoefficients () const
	Getter for the coefficients.

---

Detailed Description

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

PlanarRegion represents a set of points that lie in a plane.

Inherits summary statistics about these points from Region3D, and summary statistics of a 3D collection of points.

Author:

Alex Trevor

Definition at line 50 of file planar_region.h.

---

Constructor & Destructor Documentation

template<typename PointT>

pcl::PlanarRegion< PointT >::PlanarRegion

(

)

[inline]

Empty constructor for PlanarRegion.

Definition at line 61 of file planar_region.h.

template<typename PointT>

pcl::PlanarRegion< PointT >::PlanarRegion	(	const pcl::Region3D< PointT > &	region,
		const pcl::PlanarPolygon< PointT > &	polygon
	)		[inline]

Constructor for Planar region from a Region3D and a PlanarPolygon.

Parameters:

[in]	region	a Region3D for the input data
[in]	polygon	a PlanarPolygon for the input region

Definition at line 68 of file planar_region.h.

template<typename PointT>

virtual pcl::PlanarRegion< PointT >::~PlanarRegion

(

)

[inline, virtual]

Destructor.

Definition at line 79 of file planar_region.h.

template<typename PointT>

pcl::PlanarRegion< PointT >::PlanarRegion	(	const Eigen::Vector3f &	centroid,
		const Eigen::Matrix3f &	covariance,
		unsigned	count,
		const typename pcl::PointCloud< PointT >::VectorType &	contour,
		const Eigen::Vector4f &	coefficients
	)		[inline]

Constructor for PlanarRegion.

Parameters:

[in]	centroid	the centroid of the region.
[in]	covariance	the covariance of the region.
[in]	count	the number of points in the region.
[in]	contour	the contour / boudnary for the region
[in]	coefficients	the model coefficients (a,b,c,d) for the plane

Definition at line 88 of file planar_region.h.

---

Member Function Documentation

template<typename PointT>

Eigen::Vector3f pcl::Region3D< PointT >::getCentroid

(

)

const [inline, inherited]

Get the centroid of the region.

Definition at line 73 of file region_3d.h.

template<typename PointT>

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

(

)

[inline, inherited]

Getter for the coefficients.

Definition at line 87 of file planar_polygon.h.

template<typename PointT>

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

(

)

const [inline, inherited]

Getter for the coefficients.

Definition at line 94 of file planar_polygon.h.

template<typename PointT>

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

(

)

[inline, inherited]

Getter for the contour / boundary.

Definition at line 73 of file planar_polygon.h.

template<typename PointT>

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

(

)

const [inline, inherited]

Getter for the contour / boundary.

Definition at line 80 of file planar_polygon.h.

template<typename PointT>

unsigned pcl::Region3D< PointT >::getCount

(

)

const [inline, inherited]

Get the number of points in the region.

Definition at line 87 of file region_3d.h.

template<typename PointT>

Eigen::Matrix3f pcl::Region3D< PointT >::getCovariance

(

)

const [inline, inherited]

Get the covariance of the region.

Definition at line 80 of file region_3d.h.

---

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

• /usr/src/RPM/BUILD/PCL-1.6.0-Source/segmentation/include/pcl/segmentation/planar_region.h