Point Cloud Library (PCL)  1.7.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::Filter< pcl::PCLPointCloud2 > Class Template Reference

Filter represents the base filter class. More...

#include <pcl/filters/filter.h>

+ Inheritance diagram for pcl::Filter< pcl::PCLPointCloud2 >:

List of all members.

Public Types

typedef boost::shared_ptr
< Filter< pcl::PCLPointCloud2 > > 
Ptr
typedef boost::shared_ptr
< const Filter
< pcl::PCLPointCloud2 > > 
ConstPtr
typedef pcl::PCLPointCloud2 PCLPointCloud2
typedef PCLPointCloud2::Ptr PCLPointCloud2Ptr
typedef PCLPointCloud2::ConstPtr PCLPointCloud2ConstPtr

Public Member Functions

 Filter (bool extract_removed_indices=false)
 Empty constructor.
virtual ~Filter ()
 Empty destructor.
IndicesConstPtr const getRemovedIndices ()
 Get the point indices being removed.
void getRemovedIndices (PointIndices &pi)
 Get the point indices being removed.
void filter (PCLPointCloud2 &output)
 Calls the filtering method and returns the filtered dataset in output.

Protected Member Functions

virtual void applyFilter (PCLPointCloud2 &output)=0
 Abstract filter method.
const std::string & getClassName () const
 Get a string representation of the name of this class.

Protected Attributes

IndicesPtr removed_indices_
 Indices of the points that are removed.
bool extract_removed_indices_
 Set to true if we want to return the indices of the removed points.
std::string filter_name_
 The filter name.

Detailed Description

template<>
class pcl::Filter< pcl::PCLPointCloud2 >

Filter represents the base filter class.

All filters must inherit from this interface.

Author:
Radu B. Rusu

Definition at line 188 of file filter.h.


Member Typedef Documentation

typedef boost::shared_ptr< const Filter<pcl::PCLPointCloud2> > pcl::Filter< pcl::PCLPointCloud2 >::ConstPtr

Reimplemented in pcl::RandomSample< pcl::PCLPointCloud2 >.

Definition at line 192 of file filter.h.

Reimplemented from pcl::PCLBase< pcl::PCLPointCloud2 >.

Reimplemented in pcl::ExtractIndices< pcl::PCLPointCloud2 >.

Definition at line 196 of file filter.h.

Reimplemented from pcl::PCLBase< pcl::PCLPointCloud2 >.

Reimplemented in pcl::ExtractIndices< pcl::PCLPointCloud2 >.

Definition at line 195 of file filter.h.

typedef boost::shared_ptr< Filter<pcl::PCLPointCloud2> > pcl::Filter< pcl::PCLPointCloud2 >::Ptr

Reimplemented in pcl::RandomSample< pcl::PCLPointCloud2 >.

Definition at line 191 of file filter.h.


Constructor & Destructor Documentation

pcl::Filter< pcl::PCLPointCloud2 >::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 202 of file filter.h.

virtual pcl::Filter< pcl::PCLPointCloud2 >::~Filter ( ) [inline, virtual]

Empty destructor.

Definition at line 210 of file filter.h.


Member Function Documentation

virtual void pcl::Filter< pcl::PCLPointCloud2 >::applyFilter ( PCLPointCloud2 output) [protected, pure virtual]

Calls the filtering method and returns the filtered dataset in output.

Parameters:
[out]outputthe resultant filtered point cloud dataset

Reimplemented in pcl::FilterIndices< pcl::PCLPointCloud2 >.

const std::string& pcl::Filter< pcl::PCLPointCloud2 >::getClassName ( ) const [inline, protected]

Get a string representation of the name of this class.

Definition at line 256 of file filter.h.

Get the point indices being removed.

Definition at line 214 of file filter.h.

Get the point indices being removed.

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

Definition at line 223 of file filter.h.

References pcl::PointIndices::indices.


Member Data Documentation

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

Definition at line 240 of file filter.h.

std::string pcl::Filter< pcl::PCLPointCloud2 >::filter_name_ [protected]

The filter name.

Definition at line 243 of file filter.h.

Indices of the points that are removed.

Definition at line 237 of file filter.h.


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