#include <pcl/filters/color.h>
List of all members.
Public Types |
typedef boost::shared_ptr
< Filter< PointT > > | Ptr |
typedef boost::shared_ptr
< const Filter< PointT > > | ConstPtr |
Public Member Functions |
| ColorFilter (bool extract_removed_indices=false) |
| Constructor.
|
void | setKeepOrganized (bool val) |
| 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.
|
bool | getKeepOrganized () |
void | setUserFilterValue (float val) |
| Provide a value that the filtered points should be set to instead of removing them.
|
void | setLookUpTable (const std::vector< bool > &lookup) |
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.
|
Member Typedef Documentation
Constructor & Destructor Documentation
pcl::ColorFilter::ColorFilter |
( |
bool |
extract_removed_indices = false | ) |
[inline] |
Constructor.
Definition at line 61 of file color.h.
Member Function Documentation
void pcl::Filter::filter |
( |
PointCloud & |
output | ) |
[inline, inherited] |
Calls the filtering method and returns the filtered dataset in output.
- Parameters:
-
output | the resultant filtered point cloud dataset |
Reimplemented in pcl::FilterIndices.
Definition at line 160 of file filter.h.
std::string const pcl::Filter::getFilterFieldName |
( |
| ) |
[inline, inherited] |
Get the name of the field used for filtering.
Definition at line 110 of file filter.h.
void pcl::Filter::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 128 of file filter.h.
void pcl::Filter::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 146 of file filter.h.
bool pcl::Filter::getFilterLimitsNegative |
( |
| ) |
[inline, inherited] |
bool pcl::ColorFilter::getKeepOrganized |
( |
| ) |
[inline] |
IndicesConstPtr const pcl::Filter::getRemovedIndices |
( |
| ) |
[inline, inherited] |
Get the point indices being removed.
Definition at line 93 of file filter.h.
void pcl::Filter::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_name | the name of the field that contains values used for filtering |
Definition at line 103 of file filter.h.
void pcl::Filter::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_min | the minimum allowed field value |
limit_max | the maximum allowed field value |
Definition at line 120 of file filter.h.
void pcl::Filter::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_negative | return data inside the interval (false) or outside (true) |
Definition at line 139 of file filter.h.
void pcl::ColorFilter::setKeepOrganized |
( |
bool |
val | ) |
[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.
By default, points are removed.
- Parameters:
-
val | set to true whether the filtered points should be kept and set to a given user value (default: NaN) |
Definition at line 77 of file color.h.
void pcl::ColorFilter::setLookUpTable |
( |
const std::vector< bool > & |
lookup | ) |
[inline] |
void pcl::ColorFilter::setUserFilterValue |
( |
float |
val | ) |
[inline] |
Provide a value that the filtered points should be set to instead of removing them.
Used in conjunction with setKeepOrganized ().
- Parameters:
-
val | the user given value that the filtered point dimensions should be set to |
Definition at line 94 of file color.h.
The documentation for this class was generated from the following files:
- /builddir/build/BUILD/PCL-1.3.1-Source/filters/include/pcl/filters/color.h
- /builddir/build/BUILD/PCL-1.3.1-Source/filters/include/pcl/filters/impl/color.hpp