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< PointT >:

Public Types
typedef boost::shared_ptr < const CropBox< PointT > >	ConstPtr
typedef boost::shared_ptr < CropBox< PointT > >	Ptr
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 (PointCloud &output)
	Sample of point indices into a separate PointCloud.
void	applyFilter (std::vector< int > &indices)
	Sample of point indices.
Private Types
typedef Filter< PointT > ::PointCloud	PointCloud
typedef PointCloud::ConstPtr	PointCloudConstPtr
typedef PointCloud::Ptr	PointCloudPtr
Private 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.

Detailed Description

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

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

Author:: Justin Rosen

Definition at line 57 of file crop_box.h.

Member Typedef Documentation

template<typename PointT>

typedef boost::shared_ptr< const CropBox<PointT> > pcl::CropBox< PointT >::ConstPtr

Reimplemented from pcl::FilterIndices< PointT >.

Definition at line 68 of file crop_box.h.

template<typename PointT>

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

Reimplemented from pcl::FilterIndices< PointT >.

Definition at line 61 of file crop_box.h.

template<typename PointT>

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

Reimplemented from pcl::Filter< PointT >.

Definition at line 63 of file crop_box.h.

template<typename PointT>

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

Reimplemented from pcl::Filter< PointT >.

Definition at line 62 of file crop_box.h.

template<typename PointT>

typedef boost::shared_ptr< CropBox<PointT> > pcl::CropBox< PointT >::Ptr

Reimplemented from pcl::FilterIndices< PointT >.

Definition at line 67 of file crop_box.h.

Constructor & Destructor Documentation

template<typename PointT>

pcl::CropBox< PointT >::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 73 of file crop_box.h.

Member Function Documentation

template<typename PointT >

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

Sample of point indices into a separate PointCloud.

Parameters:

[out] output the resultant point cloud

Implements pcl::Filter< PointT >.

Definition at line 48 of file crop_box.hpp.

template<typename PointT >

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

Sample of point indices.

Parameters:

[out] indices the resultant point cloud indices

Implements pcl::FilterIndices< PointT >.

Definition at line 74 of file crop_box.hpp.

template<typename PointT>

Eigen::Vector4f pcl::CropBox< PointT >::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 115 of file crop_box.h.

template<typename PointT>

Eigen::Vector4f pcl::CropBox< PointT >::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 97 of file crop_box.h.

template<typename PointT>

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

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

Definition at line 147 of file crop_box.h.

template<typename PointT>

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

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

Definition at line 163 of file crop_box.h.

template<typename PointT>

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

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

Definition at line 131 of file crop_box.h.

template<typename PointT>

void pcl::CropBox< PointT >::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 106 of file crop_box.h.

template<typename PointT>

void pcl::CropBox< PointT >::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 88 of file crop_box.h.

template<typename PointT>

void pcl::CropBox< PointT >::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 140 of file crop_box.h.

template<typename PointT>

void pcl::CropBox< PointT >::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 156 of file crop_box.h.

template<typename PointT>

void pcl::CropBox< PointT >::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 124 of file crop_box.h.

Member Data Documentation

template<typename PointT>

Eigen::Vector4f pcl::CropBox< PointT >::max_pt_ [private]

The maximum point of the box.

Definition at line 194 of file crop_box.h.

template<typename PointT>

Eigen::Vector4f pcl::CropBox< PointT >::min_pt_ [private]

The minimum point of the box.

Definition at line 192 of file crop_box.h.

template<typename PointT>

Eigen::Vector3f pcl::CropBox< PointT >::rotation_ [private]

The 3D rotation for the box.

Definition at line 196 of file crop_box.h.

template<typename PointT>

Eigen::Affine3f pcl::CropBox< PointT >::transform_ [private]

The affine transform applied to the cloud.

Definition at line 200 of file crop_box.h.

template<typename PointT>

Eigen::Vector3f pcl::CropBox< PointT >::translation_ [private]

The 3D translation for the box.

Definition at line 198 of file crop_box.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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