pcl::Filter< PointT > Class Template Reference
[Module filters]

Filter represents the base filter class. More...

#include <pcl/filters/filter.h>

Inheritance diagram for pcl::Filter< PointT >:
Inheritance graph
[legend]
Collaboration diagram for pcl::Filter< PointT >:
Collaboration graph
[legend]

List of all members.

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 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 (PointCloud &output)
 Calls the filtering method and returns the filtered dataset in output.

Protected Member Functions

virtual void applyFilter (PointCloud &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.
std::string filter_name_
 The filter name.
bool extract_removed_indices_
 Set to true if we want to return the indices of the removed points.

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


Member Typedef Documentation

template<typename PointT>
typedef boost::shared_ptr< const Filter<PointT> > pcl::Filter< PointT >::ConstPtr
template<typename PointT>
typedef pcl::PointCloud<PointT> pcl::Filter< PointT >::PointCloud
template<typename PointT>
typedef PointCloud::ConstPtr pcl::Filter< PointT >::PointCloudConstPtr
template<typename PointT>
typedef PointCloud::Ptr pcl::Filter< PointT >::PointCloudPtr
template<typename PointT>
typedef boost::shared_ptr< Filter<PointT> > pcl::Filter< PointT >::Ptr

Constructor & Destructor Documentation

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

Empty constructor.

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

Definition at line 101 of file filter.h.

template<typename PointT>
virtual pcl::Filter< PointT >::~Filter (  )  [inline, virtual]

Empty destructor.

Definition at line 109 of file filter.h.


Member Function Documentation

template<typename PointT>
virtual void pcl::Filter< PointT >::applyFilter ( PointCloud output  )  [protected, pure virtual]
template<typename PointT>
void pcl::Filter< PointT >::filter ( PointCloud output  )  [inline]
template<typename PointT>
const std::string& pcl::Filter< PointT >::getClassName (  )  const [inline, protected]
template<typename PointT>
void pcl::Filter< PointT >::getRemovedIndices ( PointIndices pi  )  [inline]

Get the point indices being removed.

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

Definition at line 122 of file filter.h.

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

Get the point indices being removed.

Definition at line 113 of file filter.h.


Member Data Documentation

template<typename PointT>
bool pcl::Filter< PointT >::extract_removed_indices_ [protected]
template<typename PointT>
std::string pcl::Filter< PointT >::filter_name_ [protected]
template<typename PointT>
IndicesPtr pcl::Filter< PointT >::removed_indices_ [protected]

The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends