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

#include <pcl/filters/crop_box.h>

Inheritance diagram for pcl::CropBox< sensor_msgs::PointCloud2 >:

Collaboration diagram for pcl::CropBox< sensor_msgs::PointCloud2 >:

Public Types
typedef PointIndices::Ptr	PointIndicesPtr
typedef PointIndices::ConstPtr	PointIndicesConstPtr
Public Member Functions
	CropBox ()
	Empty constructor.
void	setMin (const Eigen::Vector4f &min_pt)
	Set the minimum point of the box.
Eigen::Vector4f	getMin ()
	Get the value of the minimum point of the box, as set by the user.
void	setMax (const Eigen::Vector4f &max_pt)
	Set the maximum point of the box.
Eigen::Vector4f	getMax ()
	Get the value of the maxiomum point of the box, as set by the user.
void	setTranslation (const Eigen::Vector3f &translation)
	Set a translation value for the box.
Eigen::Vector3f	getTranslation ()
	Get the value of the box translation parameter as set by the user.
void	setRotation (const Eigen::Vector3f &rotation)
	Set a rotation value for the box.
Eigen::Vector3f	getRotation ()
	Get the value of the box rotatation parameter, as set by the user.
void	setTransform (const Eigen::Affine3f &transform)
	Set a transformation that should be applied to the cloud before filtering.
Eigen::Affine3f	getTransform ()
	Get the value of the transformation parameter, as set by the user.
virtual void	filter (PointCloud2 &output)
	Calls the filtering method and returns the filtered dataset in output.
void	filter (std::vector< int > &indices)
	Calls the filtering method and returns the filtered dataset in output.
IndicesConstPtr const	getRemovedIndices ()
	Get the point indices being removed.
void	setInputCloud (const PointCloud2ConstPtr &cloud)
	Provide a pointer to the input dataset.
PointCloud2ConstPtr const	getInputCloud ()
	Get a pointer to the input point cloud dataset.
void	setIndices (const IndicesPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
void	setIndices (const PointIndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
IndicesPtr const	getIndices ()
	Get a pointer to the vector of indices used.

Detailed Description

template<>
class pcl::CropBox< sensor_msgs::PointCloud2 >

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

Author:: Justin Rosen

Definition at line 198 of file crop_box.h.

Member Typedef Documentation

typedef PointIndices::ConstPtr pcl::PCLBase< sensor_msgs::PointCloud2 >::PointIndicesConstPtr [inherited]

Definition at line 280 of file pcl_base.h.

typedef PointIndices::Ptr pcl::PCLBase< sensor_msgs::PointCloud2 >::PointIndicesPtr [inherited]

Definition at line 279 of file pcl_base.h.

Constructor & Destructor Documentation

pcl::CropBox< sensor_msgs::PointCloud2 >::CropBox ( ) [inline]

Empty constructor.

Definition at line 209 of file crop_box.h.

Member Function Documentation

virtual void pcl::FilterIndices< sensor_msgs::PointCloud2 >::filter ( PointCloud2 & output ) [inline, virtual, inherited]

Calls the filtering method and returns the filtered dataset in output.

Parameters:

[out] output the resultant filtered point cloud dataset

Reimplemented from pcl::Filter< sensor_msgs::PointCloud2 >.

Definition at line 120 of file filter_indices.h.

void pcl::FilterIndices< sensor_msgs::PointCloud2 >::filter ( std::vector< int > & indices ) [inherited]

Calls the filtering method and returns the filtered dataset in output.

Parameters:

indices the resultant indices

IndicesPtr const pcl::PCLBase< sensor_msgs::PointCloud2 >::getIndices ( ) [inline, inherited]

Get a pointer to the vector of indices used.

Definition at line 329 of file pcl_base.h.

PointCloud2ConstPtr const pcl::PCLBase< sensor_msgs::PointCloud2 >::getInputCloud ( ) [inline, inherited]

Get a pointer to the input point cloud dataset.

Definition at line 303 of file pcl_base.h.

Eigen::Vector4f pcl::CropBox< sensor_msgs::PointCloud2 >::getMax ( ) [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 250 of file crop_box.h.

Eigen::Vector4f pcl::CropBox< sensor_msgs::PointCloud2 >::getMin ( ) [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 232 of file crop_box.h.

IndicesConstPtr const pcl::Filter< sensor_msgs::PointCloud2 >::getRemovedIndices ( ) [inline, inherited]

Get the point indices being removed.

Definition at line 177 of file filter.h.

Eigen::Vector3f pcl::CropBox< sensor_msgs::PointCloud2 >::getRotation ( ) [inline]

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

Definition at line 282 of file crop_box.h.

Eigen::Affine3f pcl::CropBox< sensor_msgs::PointCloud2 >::getTransform ( ) [inline]

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

Definition at line 298 of file crop_box.h.

Eigen::Vector3f pcl::CropBox< sensor_msgs::PointCloud2 >::getTranslation ( ) [inline]

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

Definition at line 266 of file crop_box.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::setIndices ( const IndicesPtr & indices ) [inline, inherited]

Provide a pointer to the vector of indices that represents the input data.

Parameters:

indices a pointer to the vector of indices that represents the input data.

Definition at line 309 of file pcl_base.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::setIndices ( const PointIndicesConstPtr & indices ) [inline, inherited]

Provide a pointer to the vector of indices that represents the input data.

Parameters:

indices a pointer to the vector of indices that represents the input data.

Definition at line 320 of file pcl_base.h.

void pcl::PCLBase< sensor_msgs::PointCloud2 >::setInputCloud ( const PointCloud2ConstPtr & cloud ) [inherited]

Provide a pointer to the input dataset.

Parameters:

cloud the const boost shared pointer to a PointCloud message

void pcl::CropBox< sensor_msgs::PointCloud2 >::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 241 of file crop_box.h.

void pcl::CropBox< sensor_msgs::PointCloud2 >::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 223 of file crop_box.h.

void pcl::CropBox< sensor_msgs::PointCloud2 >::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 275 of file crop_box.h.

void pcl::CropBox< sensor_msgs::PointCloud2 >::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 291 of file crop_box.h.

void pcl::CropBox< sensor_msgs::PointCloud2 >::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 259 of file crop_box.h.

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

/builddir/build/BUILD/PCL-1.5.1-Source/filters/include/pcl/filters/crop_box.h

Public Types

Public Member Functions

Detailed Description

template<> class pcl::CropBox< sensor_msgs::PointCloud2 >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<>
class pcl::CropBox< sensor_msgs::PointCloud2 >