CropBox is a filter that allows the user to filter all the data inside of a given box. More...

#include <crop_box.h>

Inheritance diagram for pcl::CropBox< pcl::PCLPointCloud2 >:

Public Member Functions
	CropBox (bool extract_removed_indices=false)
	Constructor.
Eigen::Vector4f	getMax () const
	Get the value of the maxiomum point of the box, as set by the user.
Eigen::Vector4f	getMin () const
	Get the value of the minimum point of the box, as set by the user.
Eigen::Vector3f	getRotation () const
	Get the value of the box rotatation parameter, as set by the user.
Eigen::Affine3f	getTransform () const
	Get the value of the transformation parameter, as set by the user.
Eigen::Vector3f	getTranslation () const
	Get the value of the box translation parameter as set by the user.
void	setMax (const Eigen::Vector4f &max_pt)
	Set the maximum point of the box.
void	setMin (const Eigen::Vector4f &min_pt)
	Set the minimum point of the box.
void	setRotation (const Eigen::Vector3f &rotation)
	Set a rotation value for the box.
void	setTransform (const Eigen::Affine3f &transform)
	Set a transformation that should be applied to the cloud before filtering.
void	setTranslation (const Eigen::Vector3f &translation)
	Set a translation value for the box.
Protected Member Functions
void	applyFilter (PCLPointCloud2 &output)
	Sample of point indices into a separate PointCloud.
void	applyFilter (std::vector< int > &indices)
	Sample of point indices.
Protected Attributes
Eigen::Vector4f	max_pt_
	The maximum point of the box.
Eigen::Vector4f	min_pt_
	The minimum point of the box.
Eigen::Vector3f	rotation_
	The 3D rotation for the box.
Eigen::Affine3f	transform_
	The affine transform applied to the cloud.
Eigen::Vector3f	translation_
	The 3D translation for the box.
Private Types
typedef pcl::PCLPointCloud2	PCLPointCloud2
typedef PCLPointCloud2::ConstPtr	PCLPointCloud2ConstPtr
typedef PCLPointCloud2::Ptr	PCLPointCloud2Ptr

Detailed Description

template<>
class pcl::CropBox< pcl::PCLPointCloud2 >

CropBox is a filter that allows the user to filter all the data inside of a given box.

Author:: Justin Rosen

Definition at line 211 of file crop_box.h.

Member Typedef Documentation

typedef pcl::PCLPointCloud2 pcl::CropBox< pcl::PCLPointCloud2 >::PCLPointCloud2 [private]

Reimplemented from pcl::FilterIndices< pcl::PCLPointCloud2 >.

Definition at line 216 of file crop_box.h.

typedef PCLPointCloud2::ConstPtr pcl::CropBox< pcl::PCLPointCloud2 >::PCLPointCloud2ConstPtr [private]

Reimplemented from pcl::Filter< pcl::PCLPointCloud2 >.

Definition at line 218 of file crop_box.h.

typedef PCLPointCloud2::Ptr pcl::CropBox< pcl::PCLPointCloud2 >::PCLPointCloud2Ptr [private]

Reimplemented from pcl::Filter< pcl::PCLPointCloud2 >.

Definition at line 217 of file crop_box.h.

Constructor & Destructor Documentation

pcl::CropBox< pcl::PCLPointCloud2 >::CropBox ( bool extract_removed_indices = false ) [inline]

Constructor.

Parameters:

[in] extract_removed_indices Set to true if you want to be able to extract the indices of points being removed (default = false).

Definition at line 224 of file crop_box.h.

Member Function Documentation

void pcl::CropBox< pcl::PCLPointCloud2 >::applyFilter ( PCLPointCloud2 & output ) [protected, virtual]

Sample of point indices into a separate PointCloud.

Parameters:

output the resultant point cloud

Implements pcl::Filter< pcl::PCLPointCloud2 >.

Definition at line 43 of file crop_box.cpp.

void pcl::CropBox< pcl::PCLPointCloud2 >::applyFilter ( std::vector< int > & indices ) [protected, virtual]

Sample of point indices.

Parameters:

indices the resultant point cloud indices

Implements pcl::FilterIndices< pcl::PCLPointCloud2 >.

Definition at line 137 of file crop_box.cpp.

Eigen::Vector4f pcl::CropBox< pcl::PCLPointCloud2 >::getMax ( ) const [inline]

Get the value of the maxiomum point of the box, as set by the user.

Returns:: the value of the internal max_pt parameter.

Definition at line 266 of file crop_box.h.

Eigen::Vector4f pcl::CropBox< pcl::PCLPointCloud2 >::getMin ( ) const [inline]

Get the value of the minimum point of the box, as set by the user.

Returns:: the value of the internal min_pt parameter.

Definition at line 248 of file crop_box.h.

Eigen::Vector3f pcl::CropBox< pcl::PCLPointCloud2 >::getRotation ( ) const [inline]

Get the value of the box rotatation parameter, as set by the user.

Definition at line 298 of file crop_box.h.

Eigen::Affine3f pcl::CropBox< pcl::PCLPointCloud2 >::getTransform ( ) const [inline]

Get the value of the transformation parameter, as set by the user.

Definition at line 314 of file crop_box.h.

Eigen::Vector3f pcl::CropBox< pcl::PCLPointCloud2 >::getTranslation ( ) const [inline]

Get the value of the box translation parameter as set by the user.

Definition at line 282 of file crop_box.h.

void pcl::CropBox< pcl::PCLPointCloud2 >::setMax ( const Eigen::Vector4f & max_pt ) [inline]

Set the maximum point of the box.

Parameters:

[in] max_pt the maximum point of the box

Definition at line 257 of file crop_box.h.

void pcl::CropBox< pcl::PCLPointCloud2 >::setMin ( const Eigen::Vector4f & min_pt ) [inline]

Set the minimum point of the box.

Parameters:

[in] min_pt the minimum point of the box

Definition at line 239 of file crop_box.h.

void pcl::CropBox< pcl::PCLPointCloud2 >::setRotation ( const Eigen::Vector3f & rotation ) [inline]

Set a rotation value for the box.

Parameters:

[in] rotation the (rx,ry,rz) values that the box should be rotated by

Definition at line 291 of file crop_box.h.

void pcl::CropBox< pcl::PCLPointCloud2 >::setTransform ( const Eigen::Affine3f & transform ) [inline]

Set a transformation that should be applied to the cloud before filtering.

Parameters:

[in] transform an affine transformation that needs to be applied to the cloud before filtering

Definition at line 307 of file crop_box.h.

void pcl::CropBox< pcl::PCLPointCloud2 >::setTranslation ( const Eigen::Vector3f & translation ) [inline]

Set a translation value for the box.

Parameters:

[in] translation the (tx,ty,tz) values that the box should be translated by

Definition at line 275 of file crop_box.h.

Member Data Documentation

Eigen::Vector4f pcl::CropBox< pcl::PCLPointCloud2 >::max_pt_ [protected]

The maximum point of the box.

Definition at line 335 of file crop_box.h.

Eigen::Vector4f pcl::CropBox< pcl::PCLPointCloud2 >::min_pt_ [protected]

The minimum point of the box.

Definition at line 333 of file crop_box.h.

Eigen::Vector3f pcl::CropBox< pcl::PCLPointCloud2 >::rotation_ [protected]

The 3D rotation for the box.

Definition at line 339 of file crop_box.h.

Eigen::Affine3f pcl::CropBox< pcl::PCLPointCloud2 >::transform_ [protected]

The affine transform applied to the cloud.

Definition at line 341 of file crop_box.h.

Eigen::Vector3f pcl::CropBox< pcl::PCLPointCloud2 >::translation_ [protected]

The 3D translation for the box.

Definition at line 337 of file crop_box.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Detailed Description

template<> class pcl::CropBox< pcl::PCLPointCloud2 >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<>
class pcl::CropBox< pcl::PCLPointCloud2 >