pcl::Filter< PointT > Class Template Reference

Filter represents the base filter class. More...

#include <pcl/filters/filter.h>

Inheritance diagram for pcl::Filter< PointT >:

Collaboration diagram for pcl::Filter< PointT >:

List of all members.

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.
IndicesConstPtr const	getRemovedIndices ()
	Get the point indices being removed.
void	filter (PointCloud &output)
	Calls the filtering method and returns the filtered dataset in output.
virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Provide a pointer to the input dataset.
PointCloudConstPtr const	getInputCloud ()
	Get a pointer to the input point cloud dataset.
void	setIndices (const IndicesPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
void	setIndices (const IndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
void	setIndices (const PointIndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
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.
IndicesPtr const	getIndices ()
	Get a pointer to the vector of indices used.
const PointT &	operator[] (size_t pos)
	Override PointCloud operator[] to shorten code.

---

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

Reimplemented from pcl::PCLBase< PointT >.

Reimplemented in pcl::FilterIndices< PointT >.

Definition at line 78 of file filter.h.

template<typename PointT>

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

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 80 of file filter.h.

template<typename PointT>

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

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 79 of file filter.h.

template<typename PointT>

typedef PointIndices::ConstPtr pcl::PCLBase< PointT >::PointIndicesConstPtr [inherited]

Reimplemented in pcl::EuclideanClusterExtraction< PointT >, pcl::ExtractPolygonalPrismData< PointT >, pcl::SegmentDifferences< PointT >, pcl::LabeledEuclideanClusterExtraction< PointT >, pcl::SampleConsensusInitialAlignment< PointSource, PointTarget, FeatureT >, and pcl::PCA< PointT >.

Definition at line 79 of file pcl_base.h.

template<typename PointT>

typedef PointIndices::Ptr pcl::PCLBase< PointT >::PointIndicesPtr [inherited]

Reimplemented in pcl::EuclideanClusterExtraction< PointT >, pcl::ExtractPolygonalPrismData< PointT >, pcl::SegmentDifferences< PointT >, pcl::LabeledEuclideanClusterExtraction< PointT >, pcl::SampleConsensusInitialAlignment< PointSource, PointTarget, FeatureT >, and pcl::PCA< PointT >.

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

Reimplemented in pcl::FilterIndices< PointT >.

Definition at line 104 of file filter.h.

template<typename PointT>

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

(

)

[inline, inherited]

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

(

)

[inline, inherited]

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.

Reimplemented in pcl::FilterIndices< PointT >.

Definition at line 95 of file filter.h.

template<typename PointT>

const PointT& pcl::PCLBase< PointT >::operator[]

(

size_t

pos

)

[inline, inherited]

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

)

[inline, inherited]

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

)

[inline, inherited]

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

)

[inline, inherited]

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
	)		[inline, inherited]

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

)

[inline, virtual, inherited]

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:

• /usr/src/RPM/BUILD/PCL-1.6.0-Source/filters/include/pcl/filters/filter.h