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

Filter represents the base filter class. More...

#include <pcl/filters/filter.h>

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

Public Types

using Ptr = shared_ptr< Filter< PointT > >
 
using ConstPtr = shared_ptr< const Filter< PointT > >
 
using PointCloud = pcl::PointCloud< PointT >
 
using PointCloudPtr = typename PointCloud::Ptr
 
using PointCloudConstPtr = typename PointCloud::ConstPtr
 
- Public Types inherited from pcl::PCLBase< PointT >
using PointCloud = pcl::PointCloud< PointT >
 
using PointCloudPtr = typename PointCloud::Ptr
 
using PointCloudConstPtr = typename PointCloud::ConstPtr
 
using PointIndicesPtr = PointIndices::Ptr
 
using PointIndicesConstPtr = PointIndices::ConstPtr
 

Public Member Functions

 Filter (bool extract_removed_indices=false)
 Empty constructor. More...
 
IndicesConstPtr const getRemovedIndices () const
 Get the point indices being removed. More...
 
void getRemovedIndices (PointIndices &pi)
 Get the point indices being removed. More...
 
void filter (PointCloud &output)
 Calls the filtering method and returns the filtered dataset in output. More...
 
- Public Member Functions inherited from pcl::PCLBase< PointT >
 PCLBase ()
 Empty constructor. More...
 
 PCLBase (const PCLBase &base)
 Copy constructor. More...
 
virtual ~PCLBase ()=default
 Destructor. More...
 
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Provide a pointer to the input dataset. More...
 
PointCloudConstPtr const getInputCloud () const
 Get a pointer to the input point cloud dataset. More...
 
virtual void setIndices (const IndicesPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (const IndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (const PointIndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (std::size_t row_start, std::size_t col_start, std::size_t nb_rows, std::size_t nb_cols)
 Set the indices for the points laying within an interest region of the point cloud. More...
 
IndicesPtr getIndices ()
 Get a pointer to the vector of indices used. More...
 
IndicesConstPtr const getIndices () const
 Get a pointer to the vector of indices used. More...
 
const PointToperator[] (std::size_t pos) const
 Override PointCloud operator[] to shorten code. More...
 

Protected Member Functions

virtual void applyFilter (PointCloud &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< PointT >
bool initCompute ()
 This method should get called before starting the actual computation. More...
 
bool deinitCompute ()
 This method should get called after finishing the actual computation. More...
 

Protected Attributes

IndicesPtr removed_indices_
 Indices of the points that are removed. More...
 
std::string filter_name_
 The filter name. More...
 
bool extract_removed_indices_
 Set to true if we want to return the indices of the removed points. More...
 
- Protected Attributes inherited from pcl::PCLBase< PointT >
PointCloudConstPtr 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...
 

Detailed Description

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

Filter represents the base filter class.

All filters must inherit from this interface.

Author
Radu B. Rusu

Definition at line 80 of file filter.h.

Member Typedef Documentation

◆ ConstPtr

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

Definition at line 84 of file filter.h.

◆ PointCloud

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

Definition at line 87 of file filter.h.

◆ PointCloudConstPtr

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

Definition at line 89 of file filter.h.

◆ PointCloudPtr

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

Definition at line 88 of file filter.h.

◆ Ptr

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

Definition at line 83 of file filter.h.

Constructor & Destructor Documentation

◆ Filter()

template<typename PointT >
pcl::Filter< PointT >::Filter ( bool  extract_removed_indices = false)
inline

Empty constructor.

Parameters
[in]extract_removed_indicesset to true if the filtered data indices should be saved in a separate list. Default: false.

Definition at line 95 of file filter.h.

Member Function Documentation

◆ applyFilter()

template<typename PointT >
virtual void pcl::Filter< PointT >::applyFilter ( PointCloud output)
protectedpure virtual

◆ filter()

template<typename PointT >
void pcl::Filter< PointT >::filter ( PointCloud output)
inline

◆ getClassName()

template<typename PointT >
const std::string& pcl::Filter< PointT >::getClassName ( ) const
inlineprotected

◆ getRemovedIndices() [1/2]

template<typename PointT >
IndicesConstPtr const pcl::Filter< PointT >::getRemovedIndices ( ) const
inline

Get the point indices being removed.

Definition at line 103 of file filter.h.

References pcl::Filter< PointT >::removed_indices_.

Referenced by pcl::kinfuLS::WorldModel< PointT >::setSliceAsNans().

◆ getRemovedIndices() [2/2]

template<typename PointT >
void pcl::Filter< PointT >::getRemovedIndices ( PointIndices pi)
inline

Get the point indices being removed.

Parameters
[out]pithe resultant point indices that have been removed

Definition at line 112 of file filter.h.

References pcl::PointIndices::indices, and pcl::Filter< PointT >::removed_indices_.

Member Data Documentation

◆ extract_removed_indices_

template<typename PointT >
bool pcl::Filter< PointT >::extract_removed_indices_
protected

Set to true if we want to return the indices of the removed points.

Definition at line 161 of file filter.h.

Referenced by pcl::experimental::advanced::FunctorFilter< PointT, FunctionObject >::applyFilter().

◆ filter_name_

template<typename PointT >
std::string pcl::Filter< PointT >::filter_name_
protected

◆ removed_indices_

template<typename PointT >
IndicesPtr pcl::Filter< PointT >::removed_indices_
protected

Indices of the points that are removed.

Definition at line 155 of file filter.h.

Referenced by pcl::experimental::advanced::FunctorFilter< PointT, FunctionObject >::applyFilter(), and pcl::Filter< PointT >::getRemovedIndices().


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