Public Types | Public Member Functions | Protected Member Functions | Protected Attributes

pcl::Filter< sensor_msgs::PointCloud2 > Class Template Reference
[Module filters]

Filter represents the base filter class. More...

#include <pcl/filters/filter.h>

Inheritance diagram for pcl::Filter< sensor_msgs::PointCloud2 >:
Inheritance graph
[legend]
Collaboration diagram for pcl::Filter< sensor_msgs::PointCloud2 >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef sensor_msgs::PointCloud2 PointCloud2
typedef PointCloud2::Ptr PointCloud2Ptr
typedef PointCloud2::ConstPtr PointCloud2ConstPtr

Public Member Functions

 Filter (bool extract_removed_indices=false)
 Empty constructor.
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.

Protected Member Functions

virtual void applyFilter (PointCloud2 &output)=0
 Abstract filter method.
const std::string & getClassName () const
 Get a string representation of the name of this class.

Protected Attributes

IndicesPtr removed_indices_
 Indices of the points that are removed.
std::string filter_name_
 The filter name.
std::string filter_field_name_
 The desired user filter field name.
double filter_limit_min_
 The minimum allowed filter value a point will be considered from.
double filter_limit_max_
 The maximum allowed filter value a point will be considered from.
bool filter_limit_negative_
 Set to true if we want to return the data outside (filter_limit_min_;filter_limit_max_).
bool extract_removed_indices_
 Set to true if we want to return the indices of the removed points.

Detailed Description

template<>
class pcl::Filter< sensor_msgs::PointCloud2 >

Filter represents the base filter class.

Some generic 3D operations that are applicable to all filters are defined here as static methods.

Author:
Radu Bogdan Rusu

Definition at line 223 of file filter.h.


Member Typedef Documentation

Reimplemented from pcl::PCLBase< sensor_msgs::PointCloud2 >.

Definition at line 226 of file filter.h.

Reimplemented from pcl::PCLBase< sensor_msgs::PointCloud2 >.

Definition at line 228 of file filter.h.

Reimplemented from pcl::PCLBase< sensor_msgs::PointCloud2 >.

Definition at line 227 of file filter.h.


Constructor & Destructor Documentation

pcl::Filter< sensor_msgs::PointCloud2 >::Filter ( bool  extract_removed_indices = false  )  [inline]

Empty constructor.

Definition at line 231 of file filter.h.


Member Function Documentation

virtual void pcl::Filter< sensor_msgs::PointCloud2 >::applyFilter ( PointCloud2 output  )  [protected, pure virtual]
void pcl::Filter< sensor_msgs::PointCloud2 >::filter ( PointCloud2 output  ) 

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

Parameters:
output the resultant filtered point cloud dataset
const std::string& pcl::Filter< sensor_msgs::PointCloud2 >::getClassName (  )  const [inline, protected]

Get a string representation of the name of this class.

Definition at line 341 of file filter.h.

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

Get the name of the field used for filtering.

Definition at line 257 of file filter.h.

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

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

The default values are -FLT_MAX, FLT_MAX.

Definition at line 275 of file filter.h.

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

Definition at line 298 of file filter.h.

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

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

Definition at line 293 of file filter.h.

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

Get the point indices being removed.

Definition at line 240 of file filter.h.

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

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_name the name of the field that contains values used for filtering

Definition at line 250 of file filter.h.

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

Set the field filter limits.

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

Parameters:
limit_min the minimum allowed field value
limit_max the maximum allowed field value

Definition at line 267 of file filter.h.

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

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

Default: false.

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

Definition at line 286 of file filter.h.


Member Data Documentation

Set to true if we want to return the indices of the removed points.

Definition at line 330 of file filter.h.

The desired user filter field name.

Definition at line 318 of file filter.h.

The maximum allowed filter value a point will be considered from.

Definition at line 324 of file filter.h.

The minimum allowed filter value a point will be considered from.

Definition at line 321 of file filter.h.

Set to true if we want to return the data outside (filter_limit_min_;filter_limit_max_).

Default: false.

Definition at line 327 of file filter.h.

std::string pcl::Filter< sensor_msgs::PointCloud2 >::filter_name_ [protected]

The filter name.

Definition at line 315 of file filter.h.

Indices of the points that are removed.

Definition at line 312 of file filter.h.


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