Point Cloud Library (PCL)  1.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
pcl::Filter< sensor_msgs::PointCloud2 > Class Template Referenceabstract

Filter represents the base filter class. More...

#include <pcl/filters/filter.h>

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

Public Types

typedef sensor_msgs::PointCloud2 PointCloud2
 
typedef PointCloud2::Ptr PointCloud2Ptr
 
typedef PointCloud2::ConstPtr PointCloud2ConstPtr
 
typedef PointIndices::Ptr PointIndicesPtr
 
typedef PointIndices::ConstPtr PointIndicesConstPtr
 

Public Member Functions

 Filter (bool extract_removed_indices=false)
 Empty constructor. More...
 
IndicesConstPtr const getRemovedIndices ()
 Get the point indices being removed. More...
 
void filter (PointCloud2 &output)
 Calls the filtering method and returns the filtered dataset in output. More...
 
void setInputCloud (const PointCloud2ConstPtr &cloud)
 Provide a pointer to the input dataset. More...
 
PointCloud2ConstPtr const getInputCloud ()
 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...
 
IndicesPtr const getIndices ()
 Get a pointer to the vector of indices used. More...
 

Detailed Description

template<>
class pcl::Filter< sensor_msgs::PointCloud2 >

Filter represents the base filter class.

All filters must inherit from this interface.

Author
Radu B. Rusu

Definition at line 161 of file filter.h.

Member Typedef Documentation

Definition at line 164 of file filter.h.

Definition at line 166 of file filter.h.

Definition at line 165 of file filter.h.

Definition at line 280 of file pcl_base.h.

Definition at line 279 of file pcl_base.h.

Constructor & Destructor Documentation

pcl::Filter< sensor_msgs::PointCloud2 >::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 172 of file filter.h.

Member Function Documentation

void pcl::Filter< sensor_msgs::PointCloud2 >::filter ( PointCloud2 output)

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

Parameters
[out]outputthe resultant filtered point cloud dataset
IndicesPtr const pcl::PCLBase< sensor_msgs::PointCloud2 >::getIndices ( )
inlineinherited

Get a pointer to the vector of indices used.

Definition at line 329 of file pcl_base.h.

PointCloud2ConstPtr const pcl::PCLBase< sensor_msgs::PointCloud2 >::getInputCloud ( )
inlineinherited

Get a pointer to the input point cloud dataset.

Definition at line 303 of file pcl_base.h.

IndicesConstPtr const pcl::Filter< sensor_msgs::PointCloud2 >::getRemovedIndices ( )
inline

Get the point indices being removed.

Definition at line 181 of file filter.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::setIndices ( const IndicesPtr indices)
inlineinherited

Provide a pointer to the vector of indices that represents the input data.

Parameters
indicesa pointer to the vector of indices that represents the input data.

Definition at line 309 of file pcl_base.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::setIndices ( const PointIndicesConstPtr indices)
inlineinherited

Provide a pointer to the vector of indices that represents the input data.

Parameters
indicesa pointer to the vector of indices that represents the input data.

Definition at line 320 of file pcl_base.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::setInputCloud ( const PointCloud2ConstPtr cloud)
inherited

Provide a pointer to the input dataset.

Parameters
cloudthe const boost shared pointer to a PointCloud message

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