Point Cloud Library (PCL)  1.5.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions
pcl::ExtractIndices< PointT > Class Template Reference

ExtractIndices extracts a set of indices from a PointCloud as a separate PointCloud. More...

#include <pcl/filters/extract_indices.h>

Inheritance diagram for pcl::ExtractIndices< PointT >:
Inheritance graph
[legend]
Collaboration diagram for pcl::ExtractIndices< 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 PointIndices::Ptr PointIndicesPtr
typedef PointIndices::ConstPtr PointIndicesConstPtr

Public Member Functions

 ExtractIndices ()
 Empty constructor.
void setNegative (bool negative)
 Set whether the indices should be returned, or all points except the indices.
bool getNegative ()
 Get the value of the internal negative parameter.
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::ExtractIndices< PointT >

ExtractIndices extracts a set of indices from a PointCloud as a separate PointCloud.

Note:
setFilterFieldName (), setFilterLimits (), and setFilterLimitNegative () are ignored.
Author:
Radu Bogdan Rusu

Definition at line 51 of file extract_indices.h.


Member Typedef Documentation

template<typename PointT>
typedef boost::shared_ptr< const Filter<PointT> > pcl::Filter< PointT >::ConstPtr [inherited]

Definition at line 76 of file filter.h.

template<typename PointT>
typedef PointIndices::ConstPtr pcl::PCLBase< PointT >::PointIndicesConstPtr [inherited]
template<typename PointT>
typedef PointIndices::Ptr pcl::PCLBase< PointT >::PointIndicesPtr [inherited]
template<typename PointT>
typedef boost::shared_ptr< Filter<PointT> > pcl::Filter< PointT >::Ptr [inherited]

Definition at line 75 of file filter.h.


Constructor & Destructor Documentation

template<typename PointT >
pcl::ExtractIndices< PointT >::ExtractIndices ( ) [inline]

Empty constructor.

Definition at line 65 of file extract_indices.h.


Member Function Documentation

template<typename PointT>
void pcl::Filter< PointT >::filter ( PointCloud output) [inline, inherited]

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

Parameters:
[out]outputthe resultant filtered point cloud dataset

Reimplemented in pcl::FilterIndices< PointT >.

Definition at line 102 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 >
bool pcl::ExtractIndices< PointT >::getNegative ( ) [inline]

Get the value of the internal negative parameter.

If true, all points except the input indices will be returned.

Definition at line 85 of file extract_indices.h.

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

Get the point indices being removed.

Definition at line 93 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:
posposition 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:
indicesa 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:
indicesa 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:
indicesa 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_startthe offset on rows
col_startthe offset on columns
nb_rowsthe number of rows to be considered row_start included
nb_colsthe 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:
cloudthe const boost shared pointer to a PointCloud message

Reimplemented in pcl::PCA< PointT >, and pcl::GeneralizedIterativeClosestPoint< PointT, PointT >.

Definition at line 103 of file pcl_base.h.

template<typename PointT >
void pcl::ExtractIndices< PointT >::setNegative ( bool  negative) [inline]

Set whether the indices should be returned, or all points except the indices.

Parameters:
negativetrue if all points except the input indices will be returned, false otherwise

Definition at line 76 of file extract_indices.h.


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