Point Cloud Library (PCL)  1.3.1
Public Types | Public Member Functions
pcl::ExtractIndices< sensor_msgs::PointCloud2 > Class 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< sensor_msgs::PointCloud2 >:
Inheritance graph
[legend]
Collaboration diagram for pcl::ExtractIndices< sensor_msgs::PointCloud2 >:
Collaboration graph
[legend]

List of all members.

Public Types

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 setFilterFieldName (const std::string &field_name)
 Provide the name of the field to be used for filtering data.
std::string const getFilterFieldName ()
 Get the name of the field used for filtering.
void setFilterLimits (const double &limit_min, const double &limit_max)
 Set the field filter limits.
void getFilterLimits (double &limit_min, double &limit_max)
 Get the field filter limits (min/max) set by the user.
void setFilterLimitsNegative (const bool limit_negative)
 Set to true if we want to return the data outside the interval specified by setFilterLimits (min, max).
void getFilterLimitsNegative (bool &limit_negative)
 Get whether the data outside the interval (min/max) is to be returned (true) or inside (false).
bool getFilterLimitsNegative ()
void filter (PointCloud2 &output)
 Calls the filtering method and returns the filtered dataset in output.
void setInputCloud (const PointCloud2ConstPtr &cloud)
 Provide a pointer to the input dataset.
PointCloud2ConstPtr 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 PointIndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data.
IndicesPtr const getIndices ()
 Get a pointer to the vector of indices used.

Detailed Description

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

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

Member Typedef Documentation

Definition at line 264 of file pcl_base.h.

Definition at line 263 of file pcl_base.h.


Constructor & Destructor Documentation

Empty constructor.

Definition at line 119 of file extract_indices.h.


Member Function Documentation

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

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

Parameters:
outputthe resultant filtered point cloud dataset

Reimplemented in pcl::FilterIndices< sensor_msgs::PointCloud2 >.

std::string const pcl::Filter< sensor_msgs::PointCloud2 >::getFilterFieldName ( ) [inline, inherited]

Get the name of the field used for filtering.

Definition at line 262 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::getFilterLimits ( double &  limit_min,
double &  limit_max 
) [inline, inherited]

Get the field filter limits (min/max) set by the user.

The default values are -FLT_MAX, FLT_MAX.

Definition at line 280 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::getFilterLimitsNegative ( bool &  limit_negative) [inline, inherited]

Get whether the data outside the interval (min/max) is to be returned (true) or inside (false).

Definition at line 298 of file filter.h.

bool pcl::Filter< sensor_msgs::PointCloud2 >::getFilterLimitsNegative ( ) [inline, inherited]

Definition at line 303 of file filter.h.

IndicesPtr const pcl::PCLBase< sensor_msgs::PointCloud2 >::getIndices ( ) [inline, inherited]

Get a pointer to the vector of indices used.

Definition at line 312 of file pcl_base.h.

PointCloud2ConstPtr const pcl::PCLBase< sensor_msgs::PointCloud2 >::getInputCloud ( ) [inline, inherited]

Get a pointer to the input point cloud dataset.

Definition at line 286 of file pcl_base.h.

bool pcl::ExtractIndices< sensor_msgs::PointCloud2 >::getNegative ( ) [inline]

Get the value of the internal negative parameter.

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

Definition at line 138 of file extract_indices.h.

IndicesConstPtr const pcl::Filter< sensor_msgs::PointCloud2 >::getRemovedIndices ( ) [inline, inherited]

Get the point indices being removed.

Definition at line 245 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::setFilterFieldName ( const std::string &  field_name) [inline, inherited]

Provide the name of the field to be used for filtering data.

In conjunction with setFilterLimits, points having values outside this interval will be discarded.

Parameters:
field_namethe name of the field that contains values used for filtering

Definition at line 255 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::setFilterLimits ( const double &  limit_min,
const double &  limit_max 
) [inline, inherited]

Set the field filter limits.

All points having field values outside this interval will be discarded.

Parameters:
limit_minthe minimum allowed field value
limit_maxthe maximum allowed field value

Definition at line 272 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::setFilterLimitsNegative ( const bool  limit_negative) [inline, inherited]

Set to true if we want to return the data outside the interval specified by setFilterLimits (min, max).

Default: false.

Parameters:
limit_negativereturn data inside the interval (false) or outside (true)

Definition at line 291 of file filter.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::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 292 of file pcl_base.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::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 303 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
void pcl::ExtractIndices< sensor_msgs::PointCloud2 >::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 129 of file extract_indices.h.


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