pcl::PassThrough< PointT > Class Template Reference

PassThrough uses the base Filter class methods to pass through all data that satisfies the user given constraints. More...

#include <passthrough.h>

Inheritance diagram for pcl::PassThrough< PointT >:

[legend]

List of all members.

Public Member Functions
bool	getKeepOrganized ()
	PassThrough ()
	Empty 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. By default, points are removed.
void	setUserFilterValue (float val)
	Provide a value that the filtered points should be set to instead of removing them. Used in conjunction with setKeepOrganized ().
Protected Types
typedef pcl::traits::fieldList < PointT >::type	FieldList
Protected Member Functions
void	applyFilter (PointCloud &output)
	Filter a Point Cloud.
Private Types
typedef Filter< PointT > ::PointCloud	PointCloud
typedef PointCloud::ConstPtr	PointCloudConstPtr
typedef PointCloud::Ptr	PointCloudPtr
Private Attributes
bool	keep_organized_
	Keep the structure of the data organized, by setting the filtered points to the a user given value (NaN by default).
float	user_filter_value_
	User given value to be set to any filtered point. Casted to the correct field type.

---

Detailed Description

template<typename PointT>
class pcl::PassThrough< PointT >

PassThrough uses the base Filter class methods to pass through all data that satisfies the user given constraints.

Author:

Radu Bogdan Rusu

Definition at line 51 of file passthrough.h.

---

Member Typedef Documentation

template<typename PointT>

typedef pcl::traits::fieldList<PointT>::type pcl::PassThrough< PointT >::FieldList [protected]

Definition at line 97 of file passthrough.h.

template<typename PointT>

typedef Filter<PointT>::PointCloud pcl::PassThrough< PointT >::PointCloud [private]

Reimplemented from pcl::Filter< PointT >.

Definition at line 61 of file passthrough.h.

template<typename PointT>

typedef PointCloud::ConstPtr pcl::PassThrough< PointT >::PointCloudConstPtr [private]

Reimplemented from pcl::Filter< PointT >.

Definition at line 63 of file passthrough.h.

template<typename PointT>

typedef PointCloud::Ptr pcl::PassThrough< PointT >::PointCloudPtr [private]

Reimplemented from pcl::Filter< PointT >.

Definition at line 62 of file passthrough.h.

---

Constructor & Destructor Documentation

template<typename PointT>

pcl::PassThrough< PointT >::PassThrough

(

)

[inline]

Empty constructor.

Definition at line 67 of file passthrough.h.

---

Member Function Documentation

template<typename PointT >

void pcl::PassThrough< PointT >::applyFilter

(

PointCloud &

output

)

[inline, protected, virtual]

Filter a Point Cloud.

Parameters:

output

the resultant point cloud message

Implements pcl::Filter< PointT >.

Definition at line 46 of file passthrough.hpp.

template<typename PointT>

bool pcl::PassThrough< PointT >::getKeepOrganized

(

)

[inline]

Definition at line 83 of file passthrough.h.

template<typename PointT>

void pcl::PassThrough< PointT >::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 81 of file passthrough.h.

template<typename PointT>

void pcl::PassThrough< PointT >::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 90 of file passthrough.h.

---

Member Data Documentation

template<typename PointT>

bool pcl::PassThrough< PointT >::keep_organized_ [private]

Keep the structure of the data organized, by setting the filtered points to the a user given value (NaN by default).

Definition at line 102 of file passthrough.h.

template<typename PointT>

float pcl::PassThrough< PointT >::user_filter_value_ [private]

User given value to be set to any filtered point. Casted to the correct field type.

Definition at line 106 of file passthrough.h.

---

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

• passthrough.h
• passthrough.hpp