Docs4dev
Docs
point_cloud_library / latest / classpcl_1_1_comparator.html

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

#include <pcl/segmentation/comparator.h>

Public Types
using PointCloud = pcl::PointCloud< PointT >
using PointCloudPtr = typename PointCloud::Ptr
using PointCloudConstPtr = typename PointCloud::ConstPtr
using Ptr = shared_ptr< Comparator< PointT > >
using ConstPtr = shared_ptr< const Comparator< PointT > >

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

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 54 of file comparator.h.

Member Typedef Documentation

ConstPtr

template<typename PointT >
using pcl::Comparator< PointT >::ConstPtr = shared_ptr<const Comparator<PointT> >

Definition at line 62 of file comparator.h.

PointCloud

template<typename PointT >
using pcl::Comparator< PointT >::PointCloud = pcl::PointCloud<PointT>

Definition at line 57 of file comparator.h.

PointCloudConstPtr

template<typename PointT >
using pcl::Comparator< PointT >::PointCloudConstPtr = typename PointCloud::ConstPtr

Definition at line 59 of file comparator.h.

PointCloudPtr

template<typename PointT >
using pcl::Comparator< PointT >::PointCloudPtr = typename PointCloud::Ptr

Definition at line 58 of file comparator.h.

Ptr

template<typename PointT >
using pcl::Comparator< PointT >::Ptr = shared_ptr<Comparator<PointT> >

Definition at line 61 of file comparator.h.

Constructor & Destructor Documentation

Comparator()

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

Empty constructor for comparator.

Definition at line 65 of file comparator.h.

~Comparator()

template<typename PointT >
virtual pcl::Comparator< PointT >::~Comparator ( )
virtualdefault

Empty destructor for comparator.

Member Function Documentation

compare()

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] idx1 the index of the first point.
[in] idx2 the index of the second point.

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

getInputCloud()

template<typename PointT >
virtual PointCloudConstPtr pcl::Comparator< PointT >::getInputCloud ( ) const
inlinevirtual

Get the input cloud this comparator operates on.

Definition at line 84 of file comparator.h.

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

setInputCloud()

template<typename PointT >
virtual void pcl::Comparator< PointT >::setInputCloud ( const PointCloudConstPtr & cloud )
inlinevirtual

Set the input cloud for the comparator.

Parameters
[in] cloud the point cloud this comparator will operate on

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

Definition at line 77 of file comparator.h.

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

Member Data Documentation

input_

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

Definition at line 98 of file comparator.h.

Referenced by pcl::EuclideanClusterComparator< PointT, PointLT >::compare(), pcl::Comparator< PointT >::getInputCloud(), pcl::Comparator< PointT >::setInputCloud(), pcl::EuclideanClusterComparator< PointT, PointLT >::setInputCloud(), pcl::GroundPlaneComparator< PointT, PointNT >::setInputCloud(), and pcl::PlaneCoefficientComparator< PointT, PointNT >::setInputCloud().

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

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1_comparator.html