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

Collaboration diagram for pcl::CropBox< PointT >:

Public Types
typedef boost::shared_ptr < Filter< PointT > >	Ptr
typedef boost::shared_ptr < const Filter< PointT > >	ConstPtr
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 (PointCloud &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 point cloud indices.
IndicesConstPtr const	getRemovedIndices ()
	Get the point indices being removed.
virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Provide a pointer to the input dataset.
PointCloudConstPtr 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 IndicesConstPtr &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.
void	setIndices (size_t row_start, size_t col_start, size_t nb_rows, size_t nb_cols)
	Set the indices for the points laying within an interest region of the point cloud.
IndicesPtr const	getIndices ()
	Get a pointer to the vector of indices used.
const PointT &	operator[] (size_t pos)
	Override PointCloud operator[] to shorten code.

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 Filter<PointT> > pcl::Filter< PointT >::ConstPtr [inherited]

Definition at line 76 of file filter.h.

template<typename PointT>

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

Reimplemented in pcl::EuclideanClusterExtraction< PointT >, pcl::ExtractPolygonalPrismData< PointT >, pcl::SegmentDifferences< PointT >, pcl::LabeledEuclideanClusterExtraction< PointT >, pcl::SampleConsensusInitialAlignment< PointSource, PointTarget, FeatureT >, and pcl::PCA< PointT >.

Definition at line 79 of file pcl_base.h.

template<typename PointT>

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

Reimplemented in pcl::EuclideanClusterExtraction< PointT >, pcl::ExtractPolygonalPrismData< PointT >, pcl::SegmentDifferences< PointT >, pcl::LabeledEuclideanClusterExtraction< PointT >, pcl::SampleConsensusInitialAlignment< PointSource, PointTarget, FeatureT >, and pcl::PCA< PointT >.

Definition at line 78 of file pcl_base.h.

template<typename PointT>

typedef boost::shared_ptr< Filter<PointT> > pcl::Filter< PointT >::Ptr [inherited]

Definition at line 75 of file filter.h.

Constructor & Destructor Documentation

template<typename PointT >

pcl::CropBox< PointT >::CropBox ( ) [inline]

Empty constructor.

Definition at line 70 of file crop_box.h.

Member Function Documentation

template<typename PointT>

virtual void pcl::FilterIndices< PointT >::filter ( PointCloud & 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< PointT >.

Definition at line 73 of file filter_indices.h.

template<typename PointT>

void pcl::FilterIndices< PointT >::filter ( std::vector< int > & indices ) [inline, inherited]

Calls the filtering method and returns the filtered point cloud indices.

Parameters:

indices the resultant filtered point cloud indices

Definition at line 83 of file filter_indices.h.

template<typename PointT>

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

Get a pointer to the vector of indices used.

Definition at line 190 of file pcl_base.h.

template<typename PointT>

PointCloudConstPtr const pcl::PCLBase< PointT >::getInputCloud ( ) [inline, inherited]

Get a pointer to the input point cloud dataset.

Definition at line 107 of file pcl_base.h.

template<typename PointT >

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

template<typename PointT >

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

template<typename PointT>

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

Get the point indices being removed.

Definition at line 93 of file filter.h.

template<typename PointT >

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

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

Definition at line 143 of file crop_box.h.

template<typename PointT >

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

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

Definition at line 159 of file crop_box.h.

template<typename PointT >

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

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

Definition at line 127 of file crop_box.h.

template<typename PointT>

const PointT& pcl::PCLBase< PointT >::operator[] ( size_t pos ) [inline, inherited]

Override PointCloud operator[] to shorten code.

Note:: this method can be called instead of (*input_)[(*indices_)[pos]] or input_->points[(*indices_)[pos]]

Parameters:

pos	position in indices_ vector

Definition at line 197 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::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 113 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices ( const IndicesConstPtr & 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 124 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::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 135 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices	(	size_t	row_start,
		size_t	col_start,
		size_t	nb_rows,
		size_t	nb_cols
	)		`[inline, inherited]`

Set the indices for the points laying within an interest region of the point cloud.

Note:: you shouldn't call this method on unorganized point clouds!

Parameters:

row_start	the offset on rows
col_start	the offset on columns
nb_rows	the number of rows to be considered row_start included
nb_cols	the number of columns to be considered col_start included

Definition at line 151 of file pcl_base.h.

template<typename PointT>

virtual void pcl::PCLBase< PointT >::setInputCloud ( const PointCloudConstPtr & cloud ) [inline, virtual, inherited]

Provide a pointer to the input dataset.

Parameters:

cloud the const boost shared pointer to a PointCloud message

Reimplemented in pcl::PCA< PointT >, and pcl::GeneralizedIterativeClosestPoint< PointT, PointT >.

Definition at line 103 of file pcl_base.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 102 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 84 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 136 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 152 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 120 of file crop_box.h.

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

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

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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