Point Cloud Library (PCL)  1.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
pcl::FieldComparison< PointT > Class Template Reference

The field-based specialization of the comparison object. More...

#include <pcl/filters/conditional_removal.h>

Inheritance diagram for pcl::FieldComparison< PointT >:
Inheritance graph
[legend]
Collaboration diagram for pcl::FieldComparison< PointT >:
Collaboration graph
[legend]

Public Types

typedef boost::shared_ptr
< FieldComparison< PointT > > 
Ptr
 
typedef boost::shared_ptr
< const FieldComparison
< PointT > > 
ConstPtr
 

Public Member Functions

 FieldComparison (std::string field_name, ComparisonOps::CompareOp op, double compare_val)
 Construct a FieldComparison. More...
 
 FieldComparison (const FieldComparison &src)
 Copy constructor. More...
 
FieldComparisonoperator= (const FieldComparison &src)
 Copy operator. More...
 
virtual ~FieldComparison ()
 Destructor. More...
 
virtual bool evaluate (const PointT &point) const
 Determine the result of this comparison. More...
 
bool isCapable () const
 Return if the comparison is capable. More...
 

Detailed Description

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

The field-based specialization of the comparison object.

Definition at line 128 of file conditional_removal.h.

Member Typedef Documentation

template<typename PointT >
typedef boost::shared_ptr<const FieldComparison<PointT> > pcl::FieldComparison< PointT >::ConstPtr

Definition at line 136 of file conditional_removal.h.

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

Definition at line 135 of file conditional_removal.h.

Constructor & Destructor Documentation

template<typename PointT >
pcl::FieldComparison< PointT >::FieldComparison ( std::string  field_name,
ComparisonOps::CompareOp  op,
double  compare_val 
)

Construct a FieldComparison.

Parameters
field_namethe name of the field that contains the data we want to compare
opthe operator to use when making the comparison
compare_valthe constant value to compare the field value too

Definition at line 50 of file conditional_removal.hpp.

template<typename PointT >
pcl::FieldComparison< PointT >::FieldComparison ( const FieldComparison< PointT > &  src)
inline

Copy constructor.

Parameters
[in]srcthe field comparison object to copy into this

Definition at line 148 of file conditional_removal.h.

template<typename PointT >
pcl::FieldComparison< PointT >::~FieldComparison ( )
virtual

Destructor.

Definition at line 94 of file conditional_removal.hpp.

Member Function Documentation

template<typename PointT >
bool pcl::FieldComparison< PointT >::evaluate ( const PointT point) const
virtual

Determine the result of this comparison.

Parameters
pointthe point to evaluate
Returns
the result of this comparison.

Implements pcl::ComparisonBase< PointT >.

Definition at line 105 of file conditional_removal.hpp.

template<typename PointT >
bool pcl::ComparisonBase< PointT >::isCapable ( ) const
inlineinherited

Return if the comparison is capable.

Definition at line 102 of file conditional_removal.h.

template<typename PointT >
FieldComparison& pcl::FieldComparison< PointT >::operator= ( const FieldComparison< PointT > &  src)
inline

Copy operator.

Parameters
[in]srcthe field comparison object to copy into this

Definition at line 157 of file conditional_removal.h.


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