Filter represents the base filter class. More...
#include <pcl/filters/filter.h>
Inheritance diagram for pcl::Filter< pcl::PCLPointCloud2 >:
Public Types | |
| using | Ptr = shared_ptr< Filter< pcl::PCLPointCloud2 > > |
| using | ConstPtr = shared_ptr< const Filter< pcl::PCLPointCloud2 > > |
| using | PCLPointCloud2 = pcl::PCLPointCloud2 |
| using | PCLPointCloud2Ptr = PCLPointCloud2::Ptr |
| using | PCLPointCloud2ConstPtr = PCLPointCloud2::ConstPtr |
| Public Types inherited from pcl::PCLBase< pcl::PCLPointCloud2 > | |
| using | PCLPointCloud2 = pcl::PCLPointCloud2 |
| using | PCLPointCloud2Ptr = PCLPointCloud2::Ptr |
| using | PCLPointCloud2ConstPtr = PCLPointCloud2::ConstPtr |
| using | PointIndicesPtr = PointIndices::Ptr |
| using | PointIndicesConstPtr = PointIndices::ConstPtr |
Public Member Functions | |
| Filter (bool extract_removed_indices=false) | |
| Empty constructor. More... | |
| const IndicesConstPtr | getRemovedIndices () const |
| Get the point indices being removed. More... | |
| void | getRemovedIndices (PointIndices &pi) |
| Get the point indices being removed. More... | |
| void | filter (PCLPointCloud2 &output) |
| Calls the filtering method and returns the filtered dataset in output. More... | |
| Public Member Functions inherited from pcl::PCLBase< pcl::PCLPointCloud2 > | |
| PCLBase () | |
| Empty constructor. More... | |
| virtual | ~PCLBase ()=default |
| destructor. More... | |
| void | setInputCloud (const PCLPointCloud2ConstPtr &cloud) |
| Provide a pointer to the input dataset. More... | |
| const PCLPointCloud2ConstPtr | getInputCloud () const |
| Get a pointer to the input point cloud dataset. More... | |
| void | setIndices (const IndicesPtr &indices) |
| Provide a pointer to the vector of indices that represents the input data. More... | |
| void | setIndices (const PointIndicesConstPtr &indices) |
| Provide a pointer to the vector of indices that represents the input data. More... | |
| const IndicesPtr | getIndices () const |
| Get a pointer to the vector of indices used. More... | |
Protected Member Functions | |
| virtual void | applyFilter (PCLPointCloud2 &output)=0 |
| Abstract filter method. More... | |
| const std::string & | getClassName () const |
| Get a string representation of the name of this class. More... | |
| Protected Member Functions inherited from pcl::PCLBase< pcl::PCLPointCloud2 > | |
| bool | initCompute () |
| bool | deinitCompute () |
Protected Attributes | |
| IndicesPtr | removed_indices_ |
| Indices of the points that are removed. More... | |
| bool | extract_removed_indices_ |
| Set to true if we want to return the indices of the removed points. More... | |
| std::string | filter_name_ |
| The filter name. More... | |
| Protected Attributes inherited from pcl::PCLBase< pcl::PCLPointCloud2 > | |
| PCLPointCloud2ConstPtr | input_ |
| The input point cloud dataset. More... | |
| IndicesPtr | indices_ |
| A pointer to the vector of point indices to use. More... | |
| bool | use_indices_ |
| Set to true if point indices are used. More... | |
| bool | fake_indices_ |
| If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud. More... | |
| std::vector< uindex_t > | field_sizes_ |
| The size of each individual field. More... | |
| index_t | x_idx_ |
| The x-y-z fields indices. More... | |
| index_t | y_idx_ |
| index_t | z_idx_ |
| std::string | x_field_name_ |
| The desired x-y-z field names. More... | |
| std::string | y_field_name_ |
| std::string | z_field_name_ |
Detailed Description
Filter represents the base filter class.
All filters must inherit from this interface.
Member Typedef Documentation
◆ ConstPtr
| using pcl::Filter< pcl::PCLPointCloud2 >::ConstPtr = shared_ptr<const Filter<pcl::PCLPointCloud2> > |
◆ PCLPointCloud2
◆ PCLPointCloud2ConstPtr
◆ PCLPointCloud2Ptr
◆ Ptr
| using pcl::Filter< pcl::PCLPointCloud2 >::Ptr = shared_ptr<Filter<pcl::PCLPointCloud2> > |
Constructor & Destructor Documentation
◆ Filter()
|
inline |
Member Function Documentation
◆ applyFilter()
|
protectedpure virtual |
Abstract filter method.
The implementation needs to set output.{data, row_step, point_step, width, height, is_dense}.
- Parameters
-
[out] output the resultant filtered point cloud
Implemented in pcl::FilterIndices< pcl::PCLPointCloud2 >, pcl::VoxelGrid< pcl::PCLPointCloud2 >, pcl::CropBox< pcl::PCLPointCloud2 >, pcl::PassThrough< pcl::PCLPointCloud2 >, pcl::StatisticalOutlierRemoval< pcl::PCLPointCloud2 >, pcl::ProjectInliers< pcl::PCLPointCloud2 >, pcl::RadiusOutlierRemoval< pcl::PCLPointCloud2 >, pcl::RandomSample< pcl::PCLPointCloud2 >, and pcl::ExtractIndices< pcl::PCLPointCloud2 >.
◆ filter()
| void pcl::Filter< pcl::PCLPointCloud2 >::filter | ( | PCLPointCloud2 & | output | ) |
Calls the filtering method and returns the filtered dataset in output.
- Parameters
-
[out] output the resultant filtered point cloud dataset
◆ getClassName()
|
inlineprotected |
◆ getRemovedIndices() [1/2]
|
inline |
◆ getRemovedIndices() [2/2]
|
inline |
Get the point indices being removed.
- Parameters
-
[out] pi the resultant point indices that have been removed
Definition at line 217 of file filter.h.
References pcl::PointIndices::indices.
Member Data Documentation
◆ extract_removed_indices_
|
protected |
◆ filter_name_
|
protected |
◆ removed_indices_
|
protected |
The documentation for this class was generated from the following file:
- pcl/filters/filter.h