#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)
Eigen::Vector4f	getMin ()
	Get the value of the internal min_pt parameter.
void	setMax (const Eigen::Vector4f &max_pt)
Eigen::Vector4f	getMax ()
	Get the value of the internal min_pt parameter.
void	setTranslation (const Eigen::Vector3f &translation)
Eigen::Vector3f	getTranslation ()
	Get the value of the internal translate parameter.
void	setRotation (const Eigen::Vector3f &rotation)
Eigen::Vector3f	getRotation ()
	Get the value of the internal translate parameter.
void	setTransform (const Eigen::Affine3f &transform)
Eigen::Affine3f	getTransform ()
	Get the value of the internal min_pt parameter.
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	setFilterFieldName (const std::string &field_name)
	Provide the name of the field to be used for filtering data.
std::string const	getFilterFieldName ()
	Get the name of the field used for filtering.
void	setFilterLimits (const double &limit_min, const double &limit_max)
	Set the field filter limits.
void	getFilterLimits (double &limit_min, double &limit_max)
	Get the field filter limits (min/max) set by the user.
void	setFilterLimitsNegative (const bool limit_negative)
	Set to true if we want to return the data outside the interval specified by setFilterLimits (min, max).
void	getFilterLimitsNegative (bool &limit_negative)
	Get whether the data outside the interval (min/max) is to be returned (true) or inside (false).
bool	getFilterLimitsNegative ()
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 >

Author:: Justin Rosen

Definition at line 190 of file crop_box.h.

Member Typedef Documentation

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

Definition at line 264 of file pcl_base.h.

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

Definition at line 263 of file pcl_base.h.

Constructor & Destructor Documentation

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

Empty constructor.

Definition at line 201 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:

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:

output the resultant filtered point cloud dataset

std::string const pcl::Filter< sensor_msgs::PointCloud2 >::getFilterFieldName ( ) [inline, inherited]

Get the name of the field used for filtering.

Definition at line 262 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::getFilterLimits	(	double &	limit_min,
		double &	limit_max
	)		`[inline, inherited]`

Get the field filter limits (min/max) set by the user.

The default values are -FLT_MAX, FLT_MAX.

Definition at line 280 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::getFilterLimitsNegative ( bool & limit_negative ) [inline, inherited]

Get whether the data outside the interval (min/max) is to be returned (true) or inside (false).

Definition at line 298 of file filter.h.

bool pcl::Filter< sensor_msgs::PointCloud2 >::getFilterLimitsNegative ( ) [inline, inherited]

Definition at line 303 of file filter.h.

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

Get a pointer to the vector of indices used.

Definition at line 312 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 286 of file pcl_base.h.

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

Get the value of the internal min_pt parameter.

Definition at line 240 of file crop_box.h.

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

Get the value of the internal min_pt parameter.

Definition at line 223 of file crop_box.h.

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

Get the point indices being removed.

Definition at line 245 of file filter.h.

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

Get the value of the internal translate parameter.

Definition at line 274 of file crop_box.h.

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

Get the value of the internal min_pt parameter.

Definition at line 291 of file crop_box.h.

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

Get the value of the internal translate parameter.

Definition at line 257 of file crop_box.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::setFilterFieldName ( const std::string & field_name ) [inline, inherited]

Provide the name of the field to be used for filtering data.

In conjunction with setFilterLimits, points having values outside this interval will be discarded.

Parameters:

field_name the name of the field that contains values used for filtering

Definition at line 255 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::setFilterLimits	(	const double &	limit_min,
		const double &	limit_max
	)		`[inline, inherited]`

Set the field filter limits.

All points having field values outside this interval will be discarded.

Parameters:

limit_min	the minimum allowed field value
limit_max	the maximum allowed field value

Definition at line 272 of file filter.h.

void pcl::Filter< sensor_msgs::PointCloud2 >::setFilterLimitsNegative ( const bool limit_negative ) [inline, inherited]

Set to true if we want to return the data outside the interval specified by setFilterLimits (min, max).

Default: false.

Parameters:

limit_negative return data inside the interval (false) or outside (true)

Definition at line 291 of file filter.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 292 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 303 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]

Parameters:

max_pt

Definition at line 232 of file crop_box.h.

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

Parameters:

min_pt

Definition at line 215 of file crop_box.h.

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

Parameters:

transformation

Definition at line 266 of file crop_box.h.

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

Parameters:

pt_transformation

Definition at line 283 of file crop_box.h.

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

Parameters:

transformation

Definition at line 249 of file crop_box.h.

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

/builddir/build/BUILD/PCL-1.3.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 >