Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::FilterIndices< pcl::PCLPointCloud2 > Class Template Reference

FilterIndices represents the base class for filters that are about binary point removal.
All derived classes have to implement the filter (PointCloud &output) and the filter (std::vector<int> &indices) methods. Ideally they also make use of the negative_, keep_organized_ and extract_removed_indices_ systems. The distinguishment between the negative_ and extract_removed_indices_ systems only makes sense if the class automatically filters non-finite entries in the filtering methods (recommended). More...

#include <filter_indices.h>

Inheritance diagram for pcl::FilterIndices< pcl::PCLPointCloud2 >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef pcl::PCLPointCloud2 PCLPointCloud2

Public Member Functions

virtual void filter (PCLPointCloud2 &output)
 Calls the filtering method and returns the filtered dataset in output.
void filter (std::vector< int > &indices)
 Calls the filtering method and returns the filtered point cloud indices.
 FilterIndices (bool extract_removed_indices=false)
 Constructor.
bool getKeepOrganized ()
 Get whether the filtered points should be kept and set to the value given through setUserFilterValue (default = NaN), or removed from the PointCloud, thus potentially breaking its organized structure.
bool getNegative ()
 Get whether the regular conditions for points filtering should apply, or the inverted conditions.
void setKeepOrganized (bool keep_organized)
 Set whether the filtered points should be kept and set to the value given through setUserFilterValue (default: NaN), or removed from the PointCloud, thus potentially breaking its organized structure.
void setNegative (bool negative)
 Set whether the regular conditions for points filtering should apply, or the inverted conditions.
void setUserFilterValue (float value)
 Provide a value that the filtered points should be set to instead of removing them. Used in conjunction with setKeepOrganized ().
virtual ~FilterIndices ()
 Empty virtual destructor.

Protected Member Functions

virtual void applyFilter (std::vector< int > &indices)=0
 Abstract filter method for point cloud indices.

Protected Attributes

bool keep_organized_
 False = remove points (default), true = redefine points, keep structure.
bool negative_
 False = normal filter behavior (default), true = inverted behavior.
float user_filter_value_
 The user given value that the filtered point dimensions should be set to (default = NaN).

Detailed Description

template<>
class pcl::FilterIndices< pcl::PCLPointCloud2 >

FilterIndices represents the base class for filters that are about binary point removal.
All derived classes have to implement the filter (PointCloud &output) and the filter (std::vector<int> &indices) methods. Ideally they also make use of the negative_, keep_organized_ and extract_removed_indices_ systems. The distinguishment between the negative_ and extract_removed_indices_ systems only makes sense if the class automatically filters non-finite entries in the filtering methods (recommended).

Author:
Justin Rosen

Definition at line 193 of file filter_indices.h.


Member Typedef Documentation


Constructor & Destructor Documentation

pcl::FilterIndices< pcl::PCLPointCloud2 >::FilterIndices ( bool  extract_removed_indices = false) [inline]

Constructor.

Parameters:
[in]extract_removed_indicesSet to true if you want to extract the indices of points being removed (default = false).

Definition at line 201 of file filter_indices.h.

virtual pcl::FilterIndices< pcl::PCLPointCloud2 >::~FilterIndices ( ) [inline, virtual]

Empty virtual destructor.

Definition at line 211 of file filter_indices.h.


Member Function Documentation

virtual void pcl::FilterIndices< pcl::PCLPointCloud2 >::applyFilter ( std::vector< int > &  indices) [protected, pure virtual]
virtual void pcl::FilterIndices< pcl::PCLPointCloud2 >::filter ( PCLPointCloud2 output) [inline, virtual]

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

Base method for feature estimation for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod ()

Parameters:
[out]outputthe resultant filtered point cloud dataset
outputthe resultant filtered point cloud dataset

Reimplemented from pcl::Filter< pcl::PCLPointCloud2 >.

Definition at line 216 of file filter_indices.h.

void pcl::FilterIndices< pcl::PCLPointCloud2 >::filter ( std::vector< int > &  indices)

Calls the filtering method and returns the filtered point cloud indices.

Base method for feature estimation for all points given in <setInputCloud (), setIndices ()> using the surface in setSearchSurface () and the spatial locator in setSearchMethod ()

Parameters:
[out]indicesthe resultant filtered point cloud indices
outputthe resultant filtered point cloud dataset

Definition at line 48 of file filter_indices.cpp.

Get whether the filtered points should be kept and set to the value given through setUserFilterValue (default = NaN), or removed from the PointCloud, thus potentially breaking its organized structure.

Returns:
The value of the internal keep_organized_ parameter; false = remove points (default), true = redefine points, keep structure.

Definition at line 260 of file filter_indices.h.

Get whether the regular conditions for points filtering should apply, or the inverted conditions.

Returns:
The value of the internal negative_ parameter; false = normal filter behavior (default), true = inverted behavior.

Definition at line 240 of file filter_indices.h.

void pcl::FilterIndices< pcl::PCLPointCloud2 >::setKeepOrganized ( bool  keep_organized) [inline]

Set whether the filtered points should be kept and set to the value given through setUserFilterValue (default: NaN), or removed from the PointCloud, thus potentially breaking its organized structure.

Parameters:
[in]keep_organizedfalse = remove points (default), true = redefine points, keep structure.

Definition at line 250 of file filter_indices.h.

void pcl::FilterIndices< pcl::PCLPointCloud2 >::setNegative ( bool  negative) [inline]

Set whether the regular conditions for points filtering should apply, or the inverted conditions.

Parameters:
[in]negativefalse = normal filter behavior (default), true = inverted behavior.

Definition at line 231 of file filter_indices.h.

void pcl::FilterIndices< pcl::PCLPointCloud2 >::setUserFilterValue ( float  value) [inline]

Provide a value that the filtered points should be set to instead of removing them. Used in conjunction with setKeepOrganized ().

Parameters:
[in]valuethe user given value that the filtered point dimensions should be set to (default = NaN).

Definition at line 270 of file filter_indices.h.


Member Data Documentation

False = remove points (default), true = redefine points, keep structure.

Definition at line 280 of file filter_indices.h.

False = normal filter behavior (default), true = inverted behavior.

Definition at line 277 of file filter_indices.h.

The user given value that the filtered point dimensions should be set to (default = NaN).

Definition at line 283 of file filter_indices.h.


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


pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:40:56