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

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

Filter represents the base filter class. More...

#include <pcl/filters/filter.h>

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

List of all members.

Public Types

typedef pcl::PointCloud< PointT > PointCloud
typedef PointCloud::Ptr PointCloudPtr
typedef PointCloud::ConstPtr PointCloudConstPtr

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 (PointCloud &output)
 Calls the filtering method and returns the filtered dataset in output.

Protected Member Functions

virtual void applyFilter (PointCloud &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<typename PointT>
class pcl::Filter< PointT >

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 66 of file filter.h.


Member Typedef Documentation

template<typename PointT>
typedef pcl::PointCloud<PointT> pcl::Filter< PointT >::PointCloud

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 75 of file filter.h.

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

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 77 of file filter.h.

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

Reimplemented from pcl::PCLBase< PointT >.

Definition at line 76 of file filter.h.


Constructor & Destructor Documentation

template<typename PointT>
pcl::Filter< PointT >::Filter ( bool  extract_removed_indices = false  )  [inline]

Empty constructor.

Definition at line 80 of file filter.h.


Member Function Documentation

template<typename PointT>
virtual void pcl::Filter< PointT >::applyFilter ( PointCloud output  )  [protected, pure virtual]
template<typename PointT>
void pcl::Filter< PointT >::filter ( PointCloud output  )  [inline]

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

Parameters:
output the resultant filtered point cloud dataset

Definition at line 158 of file filter.h.

template<typename PointT>
const std::string& pcl::Filter< PointT >::getClassName (  )  const [inline, protected]

Get a string representation of the name of this class.

Definition at line 210 of file filter.h.

template<typename PointT>
std::string const pcl::Filter< PointT >::getFilterFieldName (  )  [inline]

Get the name of the field used for filtering.

Definition at line 108 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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 126 of file filter.h.

template<typename PointT>
bool pcl::Filter< PointT >::getFilterLimitsNegative (  )  [inline]

Definition at line 149 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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 144 of file filter.h.

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

Get the point indices being removed.

Definition at line 91 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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 101 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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 118 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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 137 of file filter.h.


Member Data Documentation

template<typename PointT>
bool pcl::Filter< PointT >::extract_removed_indices_ [protected]

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

Definition at line 199 of file filter.h.

template<typename PointT>
std::string pcl::Filter< PointT >::filter_field_name_ [protected]

The desired user filter field name.

Definition at line 187 of file filter.h.

template<typename PointT>
double pcl::Filter< PointT >::filter_limit_max_ [protected]

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

Definition at line 193 of file filter.h.

template<typename PointT>
double pcl::Filter< PointT >::filter_limit_min_ [protected]

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

Definition at line 190 of file filter.h.

template<typename PointT>
bool pcl::Filter< PointT >::filter_limit_negative_ [protected]

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

Default: false.

Definition at line 196 of file filter.h.

template<typename PointT>
std::string pcl::Filter< PointT >::filter_name_ [protected]

The filter name.

Definition at line 184 of file filter.h.

template<typename PointT>
IndicesPtr pcl::Filter< PointT >::removed_indices_ [protected]

Indices of the points that are removed.

Definition at line 181 of file filter.h.


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