Point Cloud Library (PCL)  1.14.0-dev
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::PackedHSIComparison< PointT > Class Template Reference

A packed HSI specialization of the comparison object. More...

#include <pcl/filters/conditional_removal.h>

+ Inheritance diagram for pcl::PackedHSIComparison< PointT >:
+ Collaboration diagram for pcl::PackedHSIComparison< PointT >:

Public Types

enum  ComponentId { H , S , I }
 
using Ptr = shared_ptr< PackedHSIComparison< PointT > >
 
using ConstPtr = shared_ptr< const PackedHSIComparison< PointT > >
 
- Public Types inherited from pcl::ComparisonBase< PointT >
using Ptr = shared_ptr< ComparisonBase< PointT > >
 
using ConstPtr = shared_ptr< const ComparisonBase< PointT > >
 

Public Member Functions

 PackedHSIComparison (const std::string &component_name, ComparisonOps::CompareOp op, double compare_val)
 Construct a PackedHSIComparison. More...
 
 ~PackedHSIComparison () override=default
 Destructor. More...
 
bool evaluate (const PointT &point) const override
 Determine the result of this comparison. More...
 
- Public Member Functions inherited from pcl::ComparisonBase< PointT >
 ComparisonBase ()=default
 Constructor. More...
 
virtual ~ComparisonBase ()=default
 Destructor. More...
 
bool isCapable () const
 Return if the comparison is capable. More...
 

Protected Attributes

std::string component_name_
 The name of the component. More...
 
ComponentId component_id_
 The ID of the component. More...
 
double compare_val_
 All types (that we care about) can be represented as a double. More...
 
std::uint32_t rgb_offset_
 The offset of the component. More...
 
- Protected Attributes inherited from pcl::ComparisonBase< PointT >
bool capable_ {false}
 True if capable. More...
 
std::string field_name_
 Field name to compare data on. More...
 
std::uint32_t offset_ {0}
 The data offset. More...
 
ComparisonOps::CompareOp op_ {ComparisonOps::GT}
 The comparison operator type. More...
 

Detailed Description

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

A packed HSI specialization of the comparison object.

Definition at line 241 of file conditional_removal.h.

Member Typedef Documentation

◆ ConstPtr

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

Definition at line 248 of file conditional_removal.h.

◆ Ptr

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

Definition at line 247 of file conditional_removal.h.

Member Enumeration Documentation

◆ ComponentId

template<typename PointT >
enum pcl::PackedHSIComparison::ComponentId
Enumerator

Definition at line 267 of file conditional_removal.h.

Constructor & Destructor Documentation

◆ PackedHSIComparison()

template<typename PointT >
pcl::PackedHSIComparison< PointT >::PackedHSIComparison ( const std::string &  component_name,
ComparisonOps::CompareOp  op,
double  compare_val 
)

◆ ~PackedHSIComparison()

template<typename PointT >
pcl::PackedHSIComparison< PointT >::~PackedHSIComparison ( )
overridedefault

Destructor.

Member Function Documentation

◆ evaluate()

template<typename PointT >
bool pcl::PackedHSIComparison< PointT >::evaluate ( const PointT point) const
overridevirtual

Determine the result of this comparison.


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

Implements pcl::ComparisonBase< PointT >.

Definition at line 289 of file conditional_removal.hpp.

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

Member Data Documentation

◆ compare_val_

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

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

Definition at line 282 of file conditional_removal.h.

◆ component_id_

template<typename PointT >
ComponentId pcl::PackedHSIComparison< PointT >::component_id_
protected

The ID of the component.

Definition at line 279 of file conditional_removal.h.

Referenced by pcl::PackedHSIComparison< PointT >::PackedHSIComparison().

◆ component_name_

template<typename PointT >
std::string pcl::PackedHSIComparison< PointT >::component_name_
protected

The name of the component.

Definition at line 276 of file conditional_removal.h.

◆ rgb_offset_

template<typename PointT >
std::uint32_t pcl::PackedHSIComparison< PointT >::rgb_offset_
protected

The offset of the component.

Definition at line 285 of file conditional_removal.h.

Referenced by pcl::PackedHSIComparison< PointT >::PackedHSIComparison().


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