Point Cloud Library (PCL)  1.7.1
List of all members | Public Types | Public Member Functions | Protected Attributes
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 >:

Public Types

typedef boost::shared_ptr
< FieldComparison< PointT > > 
Ptr
 
typedef boost::shared_ptr
< const FieldComparison
< PointT > > 
ConstPtr
 
- Public Types inherited from pcl::ComparisonBase< PointT >
typedef boost::shared_ptr
< ComparisonBase< PointT > > 
Ptr
 
typedef boost::shared_ptr
< const ComparisonBase< 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...
 
- Public Member Functions inherited from pcl::ComparisonBase< PointT >
 ComparisonBase ()
 Constructor. More...
 
virtual ~ComparisonBase ()
 Destructor. More...
 
bool isCapable () const
 Return if the comparison is capable. More...
 

Protected Attributes

double compare_val_
 All types (that we care about) can be represented as a double. More...
 
PointDataAtOffset< PointT > * point_data_
 The point data to compare. More...
 
- Protected Attributes inherited from pcl::ComparisonBase< PointT >
bool capable_
 True if capable. More...
 
std::string field_name_
 Field name to compare data on. More...
 
uint32_t offset_
 The data offset. More...
 
ComparisonOps::CompareOp op_
 The comparison operator type. 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 48 of file conditional_removal.hpp.

References pcl::ComparisonBase< PointT >::capable_, pcl::ComparisonBase< PointT >::field_name_, pcl::getFields(), pcl::ComparisonBase< PointT >::op_, and pcl::FieldComparison< PointT >::point_data_.

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 149 of file conditional_removal.h.

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

Destructor.

Definition at line 93 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 104 of file conditional_removal.hpp.

References pcl::ComparisonOps::EQ, pcl::ComparisonOps::GE, pcl::ComparisonOps::GT, pcl::ComparisonOps::LE, and pcl::ComparisonOps::LT.

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 159 of file conditional_removal.h.

References pcl::FieldComparison< PointT >::compare_val_, and pcl::FieldComparison< PointT >::point_data_.

Member Data Documentation

template<typename PointT >
double pcl::FieldComparison< PointT >::compare_val_
protected

All types (that we care about) can be represented as a double.

Definition at line 178 of file conditional_removal.h.

Referenced by pcl::FieldComparison< PointT >::operator=().

template<typename PointT >
PointDataAtOffset<PointT>* pcl::FieldComparison< PointT >::point_data_
protected

The point data to compare.

Definition at line 181 of file conditional_removal.h.

Referenced by pcl::FieldComparison< PointT >::FieldComparison(), and pcl::FieldComparison< PointT >::operator=().


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