Point Cloud Library (PCL)  1.7.0
Public Types | Public Member Functions | Protected Attributes
pcl::Comparator< PointT > Class Template Reference

Comparator is the base class for comparators that compare two points given some function. More...

#include <pcl/segmentation/comparator.h>

+ Inheritance diagram for pcl::Comparator< PointT >:

List of all members.

Public Types

typedef pcl::PointCloud< PointTPointCloud
typedef PointCloud::Ptr PointCloudPtr
typedef PointCloud::ConstPtr PointCloudConstPtr
typedef boost::shared_ptr
< Comparator< PointT > > 
Ptr
typedef boost::shared_ptr
< const Comparator< PointT > > 
ConstPtr

Public Member Functions

 Comparator ()
 Empty constructor for comparator.
virtual ~Comparator ()
 Empty destructor for comparator.
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Set the input cloud for the comparator.
virtual PointCloudConstPtr getInputCloud () const
 Get the input cloud this comparator operates on.
virtual bool compare (int idx1, int idx2) const =0
 Compares the two points in the input cloud designated by these two indices.

Protected Attributes

PointCloudConstPtr input_

Detailed Description

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

Comparator is the base class for comparators that compare two points given some function.

Currently intended for use with OrganizedConnectedComponentSegmentation

Author:
Alex Trevor

Definition at line 53 of file comparator.h.


Member Typedef Documentation

template<typename PointT>
typedef boost::shared_ptr<const Comparator<PointT> > pcl::Comparator< PointT >::ConstPtr
template<typename PointT>
typedef pcl::PointCloud<PointT> pcl::Comparator< PointT >::PointCloud
template<typename PointT>
typedef PointCloud::ConstPtr pcl::Comparator< PointT >::PointCloudConstPtr
template<typename PointT>
typedef PointCloud::Ptr pcl::Comparator< PointT >::PointCloudPtr

Definition at line 57 of file comparator.h.

template<typename PointT>
typedef boost::shared_ptr<Comparator<PointT> > pcl::Comparator< PointT >::Ptr

Constructor & Destructor Documentation

template<typename PointT>
pcl::Comparator< PointT >::Comparator ( ) [inline]

Empty constructor for comparator.

Definition at line 64 of file comparator.h.

template<typename PointT>
virtual pcl::Comparator< PointT >::~Comparator ( ) [inline, virtual]

Empty destructor for comparator.

Definition at line 70 of file comparator.h.


Member Function Documentation

template<typename PointT>
virtual bool pcl::Comparator< PointT >::compare ( int  idx1,
int  idx2 
) const [pure virtual]

Compares the two points in the input cloud designated by these two indices.

This is pure virtual and must be implemented by subclasses with some comparison function.

Parameters:
[in]idx1the index of the first point.
[in]idx2the index of the second point.

Implemented in pcl::GroundPlaneComparator< PointT, PointNT >, pcl::PlaneCoefficientComparator< PointT, PointNT >, pcl::PlaneRefinementComparator< PointT, PointNT, PointLT >, pcl::EdgeAwarePlaneComparator< PointT, PointNT >, pcl::EuclideanClusterComparator< PointT, PointNT, PointLT >, pcl::RGBPlaneCoefficientComparator< PointT, PointNT >, and pcl::EuclideanPlaneCoefficientComparator< PointT, PointNT >.

template<typename PointT>
virtual PointCloudConstPtr pcl::Comparator< PointT >::getInputCloud ( ) const [inline, virtual]

Get the input cloud this comparator operates on.

Definition at line 85 of file comparator.h.

References pcl::Comparator< PointT >::input_.

template<typename PointT>
virtual void pcl::Comparator< PointT >::setInputCloud ( const PointCloudConstPtr cloud) [inline, virtual]

Set the input cloud for the comparator.

Parameters:
[in]cloudthe point cloud this comparator will operate on

Reimplemented in pcl::GroundPlaneComparator< PointT, PointNT >, pcl::PlaneCoefficientComparator< PointT, PointNT >, and pcl::EuclideanClusterComparator< PointT, PointNT, PointLT >.

Definition at line 78 of file comparator.h.

References pcl::Comparator< PointT >::input_.


Member Data Documentation

template<typename PointT>
PointCloudConstPtr pcl::Comparator< PointT >::input_ [protected]

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