PassThrough uses the base Filter class methods to pass through all data that satisfies the user given constraints. More...
#include <pcl/filters/passthrough.h>
Public Member Functions |
|
| PassThrough (bool extract_removed_indices=false) | |
| Constructor. More... |
|
| void | setFilterFieldName (const std::string &field_name) |
| Provide the name of the field to be used for filtering data. More... |
|
| const std::string | getFilterFieldName () const |
| Get the name of the field used for filtering. More... |
|
| void | setFilterLimits (const double &limit_min, const double &limit_max) |
| Set the field filter limits. More... |
|
| void | getFilterLimits (double &limit_min, double &limit_max) const |
| Get the field filter limits (min/max) set by the user. More... |
|
 Public Member Functions inherited from pcl::FilterIndices< pcl::PCLPointCloud2 > |
|
| FilterIndices (bool extract_removed_indices=false) | |
| Constructor. More... |
|
| void | filter (Indices &indices) |
| Calls the filtering method and returns the filtered point cloud indices. More... |
|
| void | setNegative (bool negative) |
| Set whether the regular conditions for points filtering should apply, or the inverted conditions. More... |
|
| bool | getNegative () const |
| Get whether the regular conditions for points filtering should apply, or the inverted conditions. More... |
|
| 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. More... |
|
| bool | getKeepOrganized () const |
| 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. More... |
|
| void | setUserFilterValue (float value) |
| Provide a value that the filtered points should be set to instead of removing them. More... |
|
| Public Member Functions inherited from pcl::Filter< pcl::PCLPointCloud2 > |
|
| Filter (bool extract_removed_indices=false) | |
| Empty constructor. More... |
|
| const IndicesConstPtr | getRemovedIndices () const |
| Get the point indices being removed. More... |
|
| void | getRemovedIndices (PointIndices &pi) |
| Get the point indices being removed. More... |
|
| void | filter (PCLPointCloud2 &output) |
| Calls the filtering method and returns the filtered dataset in output. More... |
|
| Public Member Functions inherited from pcl::PCLBase< pcl::PCLPointCloud2 > |
|
| PCLBase () | |
| Empty constructor. More... |
|
| virtual | ~PCLBase ()=default |
| destructor. More... |
|
| void | setInputCloud (const PCLPointCloud2ConstPtr &cloud) |
| Provide a pointer to the input dataset. More... |
|
| const PCLPointCloud2ConstPtr | getInputCloud () const |
| Get a pointer to the input point cloud dataset. More... |
|
| void | setIndices (const IndicesPtr &indices) |
| Provide a pointer to the vector of indices that represents the input data. More... |
|
| void | setIndices (const PointIndicesConstPtr &indices) |
| Provide a pointer to the vector of indices that represents the input data. More... |
|
| const IndicesPtr | getIndices () const |
| Get a pointer to the vector of indices used. More... |
|
Protected Member Functions |
|
| void | applyFilter (PCLPointCloud2 &output) override |
| Abstract filter method for point cloud. More... |
|
| void | applyFilter (Indices &indices) override |
| Abstract filter method for point cloud indices. More... |
|
| Protected Member Functions inherited from pcl::Filter< pcl::PCLPointCloud2 > |
|
| const std::string & | getClassName () const |
| Get a string representation of the name of this class. More... |
|
| Protected Member Functions inherited from pcl::PCLBase< pcl::PCLPointCloud2 > |
|
| bool | initCompute () |
| bool | deinitCompute () |
Additional Inherited Members |
|
| Public Types inherited from pcl::FilterIndices< pcl::PCLPointCloud2 > |
|
| using | PCLPointCloud2 = pcl::PCLPointCloud2 |
| Public Types inherited from pcl::Filter< pcl::PCLPointCloud2 > |
|
| using | Ptr = shared_ptr< Filter< pcl::PCLPointCloud2 > > |
| using | ConstPtr = shared_ptr< const Filter< pcl::PCLPointCloud2 > > |
| using | PCLPointCloud2 = pcl::PCLPointCloud2 |
| using | PCLPointCloud2Ptr = PCLPointCloud2::Ptr |
| using | PCLPointCloud2ConstPtr = PCLPointCloud2::ConstPtr |
| Public Types inherited from pcl::PCLBase< pcl::PCLPointCloud2 > |
|
| using | PCLPointCloud2 = pcl::PCLPointCloud2 |
| using | PCLPointCloud2Ptr = PCLPointCloud2::Ptr |
| using | PCLPointCloud2ConstPtr = PCLPointCloud2::ConstPtr |
| using | PointIndicesPtr = PointIndices::Ptr |
| using | PointIndicesConstPtr = PointIndices::ConstPtr |
| Protected Attributes inherited from pcl::FilterIndices< pcl::PCLPointCloud2 > |
|
| bool | negative_ |
| False = normal filter behavior (default), true = inverted behavior. More... |
|
| bool | keep_organized_ |
| False = remove points (default), true = redefine points, keep structure. More... |
|
| float | user_filter_value_ |
| The user given value that the filtered point dimensions should be set to (default = NaN). More... |
|
| Protected Attributes inherited from pcl::Filter< pcl::PCLPointCloud2 > |
|
| IndicesPtr | removed_indices_ |
| Indices of the points that are removed. More... |
|
| bool | extract_removed_indices_ |
| Set to true if we want to return the indices of the removed points. More... |
|
| std::string | filter_name_ |
| The filter name. More... |
|
| Protected Attributes inherited from pcl::PCLBase< pcl::PCLPointCloud2 > |
|
| PCLPointCloud2ConstPtr | input_ |
| The input point cloud dataset. More... |
|
| IndicesPtr | indices_ |
| A pointer to the vector of point indices to use. More... |
|
| bool | use_indices_ |
| Set to true if point indices are used. More... |
|
| bool | fake_indices_ |
| If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud. More... |
|
| std::vector< uindex_t > | field_sizes_ |
| The size of each individual field. More... |
|
| index_t | x_idx_ |
| The x-y-z fields indices. More... |
|
| index_t | y_idx_ |
| index_t | z_idx_ |
| std::string | x_field_name_ |
| The desired x-y-z field names. More... |
|
| std::string | y_field_name_ |
| std::string | z_field_name_ |
Detailed Description
PassThrough uses the base Filter class methods to pass through all data that satisfies the user given constraints.
Definition at line 226 of file passthrough.h.
Constructor & Destructor Documentation
PassThrough()
|
inline |
Constructor.
Definition at line 237 of file passthrough.h.
Member Function Documentation
applyFilter() [1/2]
|
overrideprotectedvirtual |
Abstract filter method for point cloud indices.
Implements pcl::FilterIndices< pcl::PCLPointCloud2 >.
applyFilter() [2/2]
|
overrideprotectedvirtual |
Abstract filter method for point cloud.
Implements pcl::FilterIndices< pcl::PCLPointCloud2 >.
getFilterFieldName()
|
inline |
Get the name of the field used for filtering.
Definition at line 256 of file passthrough.h.
getFilterLimits()
|
inline |
Get the field filter limits (min/max) set by the user.
The default values are -FLT_MAX, FLT_MAX.
- Parameters
-
[out] limit_min the minimum allowed field value [out] limit_max the maximum allowed field value
Definition at line 277 of file passthrough.h.
setFilterFieldName()
|
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
-
[in] field_name the name of the field that contains values used for filtering
Definition at line 249 of file passthrough.h.
setFilterLimits()
|
inline |
Set the field filter limits.
All points having field values outside this interval will be discarded.
- Parameters
-
[in] limit_min the minimum allowed field value [in] limit_max the maximum allowed field value
Definition at line 266 of file passthrough.h.
The documentation for this class was generated from the following file:
- pcl/filters/passthrough.h
© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1_pass_through_3_01pcl_1_1_p_c_l_point_cloud2_01_4.html
