pcl::CropBox< PointT > Class Template Reference
[Module filters]

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 >:
Inheritance graph
[legend]
Collaboration diagram for pcl::CropBox< PointT >:
Collaboration graph
[legend]

List of all members.

Public Types

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

Public Member Functions

 CropBox (bool extract_removed_indices=false)
 Constructor.
void setMin (const Eigen::Vector4f &min_pt)
 Set the minimum point of the box.
Eigen::Vector4f getMin () const
 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 () const
 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 () const
 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 () const
 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 () const
 Get the value of the transformation parameter, as set by the user.

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.

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 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.

References pcl::Filter< PointT >::filter_name_.


Member Function Documentation

template<typename PointT >
void pcl::CropBox< PointT >::applyFilter ( std::vector< int > &  indices  )  [inline, protected, virtual]
template<typename PointT >
void pcl::CropBox< PointT >::applyFilter ( PointCloud output  )  [inline, protected, virtual]
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.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends