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
typedef boost::shared_ptr < Filter< PointT > >	Ptr

typedef boost::shared_ptr < const Filter< PointT > >	ConstPtr

typedef pcl::PointCloud< PointT >	PointCloud

typedef PointCloud::Ptr	PointCloudPtr

typedef PointCloud::ConstPtr	PointCloudConstPtr

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

virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Provide a pointer to the input dataset. More...

PointCloudConstPtr 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 IndicesConstPtr &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...

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...

const PointT &	operator[] (size_t pos)
	Override PointCloud operator[] to shorten code. 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 69 of file filter.h.

Member Typedef Documentation

template<typename PointT>

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

Definition at line 76 of file filter.h.

template<typename PointT>

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

Definition at line 78 of file filter.h.

template<typename PointT>

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

Definition at line 80 of file filter.h.

template<typename PointT>

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

Definition at line 79 of file filter.h.

template<typename PointT>

typedef PointIndices::ConstPtr pcl::PCLBase< PointT >::PointIndicesConstPtr

inherited

Definition at line 79 of file pcl_base.h.

template<typename PointT>

typedef PointIndices::Ptr pcl::PCLBase< PointT >::PointIndicesPtr

inherited

Definition at line 78 of file pcl_base.h.

template<typename PointT>

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

Definition at line 75 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_indices set to true if the filtered data indices should be saved in a separate list. Default: false.

Definition at line 86 of file filter.h.

Member Function Documentation

template<typename PointT>

void pcl::Filter< PointT >::filter ( PointCloud & output)

inline

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

Parameters

[out] output the resultant filtered point cloud dataset

Definition at line 104 of file filter.h.

template<typename PointT>

IndicesPtr const pcl::PCLBase< PointT >::getIndices ( )

inlineinherited

Get a pointer to the vector of indices used.

Definition at line 190 of file pcl_base.h.

template<typename PointT>

PointCloudConstPtr const pcl::PCLBase< PointT >::getInputCloud ( )

inlineinherited

Get a pointer to the input point cloud dataset.

Definition at line 107 of file pcl_base.h.

template<typename PointT>

IndicesConstPtr const pcl::Filter< PointT >::getRemovedIndices ( )

inline

Get the point indices being removed.

Definition at line 95 of file filter.h.

template<typename PointT>

const PointT& pcl::PCLBase< PointT >::operator[] ( size_t pos)

inlineinherited

Override PointCloud operator[] to shorten code.

Note: this method can be called instead of (*input_)[(*indices_)[pos]] or input_->points[(*indices_)[pos]]

Parameters

pos	position in indices_ vector

Definition at line 197 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices ( const IndicesPtr & indices)

inlineinherited

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

Parameters

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

Definition at line 113 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices ( const IndicesConstPtr & indices)

inlineinherited

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

Parameters

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

Definition at line 124 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices ( const PointIndicesConstPtr & indices)

inlineinherited

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

Parameters

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

Definition at line 135 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices	(	size_t	row_start,
		size_t	col_start,
		size_t	nb_rows,
		size_t	nb_cols
	)

inlineinherited

Set the indices for the points laying within an interest region of the point cloud.

Note: you shouldn't call this method on unorganized point clouds!

Parameters

row_start	the offset on rows
col_start	the offset on columns
nb_rows	the number of rows to be considered row_start included
nb_cols	the number of columns to be considered col_start included

Definition at line 151 of file pcl_base.h.

template<typename PointT>

virtual void pcl::PCLBase< PointT >::setInputCloud ( const PointCloudConstPtr & cloud)

inlinevirtualinherited

Provide a pointer to the input dataset.

Parameters

cloud the const boost shared pointer to a PointCloud message

Reimplemented in pcl::PCA< PointT >.

Definition at line 103 of file pcl_base.h.

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

/builddir/build/BUILD/PCL-1.6.0-Source/filters/include/pcl/filters/filter.h

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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