Point Cloud Library (PCL)  1.8.1-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 >:

Public Types

typedef boost::shared_ptr
< Filter< PointT > > 
Ptr
 
typedef boost::shared_ptr
< const Filter< PointT > > 
ConstPtr
 
typedef pcl::PointCloud< PointTPointCloud
 
typedef PointCloud::Ptr PointCloudPtr
 
typedef PointCloud::ConstPtr PointCloudConstPtr
 
- Public Types inherited from pcl::PCLBase< PointT >
typedef pcl::PointCloud< PointTPointCloud
 
typedef PointCloud::Ptr PointCloudPtr
 
typedef PointCloud::ConstPtr PointCloudConstPtr
 
typedef boost::shared_ptr
< PointIndices
PointIndicesPtr
 
typedef boost::shared_ptr
< PointIndices const > 
PointIndicesConstPtr
 

Public Member Functions

 Filter (bool extract_removed_indices=false)
 Empty constructor. More...
 
virtual ~Filter ()
 Empty destructor. More...
 
IndicesConstPtr const getRemovedIndices ()
 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 ()
 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 (size_t row_start, size_t col_start, size_t nb_rows, size_t nb_cols)
 Set the indices for the points laying within an interest region of the point cloud. More...
 
IndicesPtr const 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[] (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 84 of file filter.h.

Member Typedef Documentation

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

Definition at line 91 of file filter.h.

template<typename PointT>
typedef pcl::PointCloud<PointT> pcl::Filter< PointT >::PointCloud

Definition at line 94 of file filter.h.

template<typename PointT>
typedef PointCloud::ConstPtr pcl::Filter< PointT >::PointCloudConstPtr

Definition at line 96 of file filter.h.

template<typename PointT>
typedef PointCloud::Ptr pcl::Filter< PointT >::PointCloudPtr

Definition at line 95 of file filter.h.

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

Definition at line 90 of file filter.h.

Constructor & Destructor Documentation

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 102 of file filter.h.

template<typename PointT>
virtual pcl::Filter< PointT >::~Filter ( )
inlinevirtual

Empty destructor.

Definition at line 110 of file filter.h.

Member Function Documentation

template<typename PointT>
virtual void pcl::Filter< PointT >::applyFilter ( PointCloud output)
protectedpure virtual
template<typename PointT>
void pcl::Filter< PointT >::filter ( PointCloud output)
inline
template<typename PointT>
const std::string& pcl::Filter< PointT >::getClassName ( ) const
inlineprotected
template<typename PointT>
IndicesConstPtr const pcl::Filter< PointT >::getRemovedIndices ( )
inline

Get the point indices being removed.

Definition at line 114 of file filter.h.

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

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 123 of file filter.h.

Member Data Documentation

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 169 of file filter.h.

Referenced by pcl::FilterIndices< pcl::pcl::PCLPointCloud2 >::FilterIndices().

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

Indices of the points that are removed.

Definition at line 163 of file filter.h.

Referenced by pcl::Filter< pcl::PointXYZRGBL >::getRemovedIndices().


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