Public Types | Public Member Functions

pcl::ProjectInliers< sensor_msgs::PointCloud2 > Class Template Reference
[Module filters]

ProjectInliers uses a model and a set of inlier indices from a PointCloud to project them into a separate PointCloud. More...

#include <pcl/filters/project_inliers.h>

Inheritance diagram for pcl::ProjectInliers< sensor_msgs::PointCloud2 >:
Inheritance graph
[legend]
Collaboration diagram for pcl::ProjectInliers< sensor_msgs::PointCloud2 >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef PointIndices::Ptr PointIndicesPtr
typedef PointIndices::ConstPtr PointIndicesConstPtr

Public Member Functions

 ProjectInliers ()
 Empty constructor.
void setModelType (int model)
 The type of model to use (user given parameter).
int getModelType ()
 Get the type of SAC model used.
void setModelCoefficients (const ModelCoefficientsConstPtr &model)
 Provide a pointer to the model coefficients.
ModelCoefficientsConstPtr getModelCoefficients ()
 Get a pointer to the model coefficients.
void setCopyAllFields (bool val)
 Set whether all fields should be copied, or only the XYZ.
bool getCopyAllFields ()
 Get whether all fields are being copied (true), or only XYZ (false).
void setCopyAllData (bool val)
 Set whether all data will be returned, or only the projected inliers.
bool getCopyAllData ()
 Get whether all data is being copied (true), or only the projected inliers (false).
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 filter (PointCloud2 &output)
 Calls the filtering method and returns the filtered dataset in output.
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::ProjectInliers< sensor_msgs::PointCloud2 >

ProjectInliers uses a model and a set of inlier indices from a PointCloud to project them into a separate PointCloud.

Note:
setFilterFieldName (), setFilterLimits (), and setFilterLimitNegative () are ignored.
Author:
Radu Bogdan Rusu

Definition at line 170 of file project_inliers.h.


Member Typedef Documentation

Definition at line 264 of file pcl_base.h.

Definition at line 263 of file pcl_base.h.


Constructor & Destructor Documentation

Empty constructor.

Definition at line 183 of file project_inliers.h.


Member Function Documentation

void pcl::Filter< sensor_msgs::PointCloud2 >::filter ( PointCloud2 output  )  [inherited]

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

Parameters:
output the resultant filtered point cloud dataset

Reimplemented in pcl::FilterIndices< sensor_msgs::PointCloud2 >.

bool pcl::ProjectInliers< sensor_msgs::PointCloud2 >::getCopyAllData (  )  [inline]

Get whether all data is being copied (true), or only the projected inliers (false).

Definition at line 247 of file project_inliers.h.

bool pcl::ProjectInliers< sensor_msgs::PointCloud2 >::getCopyAllFields (  )  [inline]

Get whether all fields are being copied (true), or only XYZ (false).

Definition at line 231 of file project_inliers.h.

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.

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

Definition at line 303 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.

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.

ModelCoefficientsConstPtr pcl::ProjectInliers< sensor_msgs::PointCloud2 >::getModelCoefficients (  )  [inline]

Get a pointer to the model coefficients.

Definition at line 215 of file project_inliers.h.

int pcl::ProjectInliers< sensor_msgs::PointCloud2 >::getModelType (  )  [inline]

Get the type of SAC model used.

Definition at line 199 of file project_inliers.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.

void pcl::ProjectInliers< sensor_msgs::PointCloud2 >::setCopyAllData ( bool  val  )  [inline]

Set whether all data will be returned, or only the projected inliers.

Parameters:
val true if all data should be returned, false if only the projected inliers

Definition at line 240 of file project_inliers.h.

void pcl::ProjectInliers< sensor_msgs::PointCloud2 >::setCopyAllFields ( bool  val  )  [inline]

Set whether all fields should be copied, or only the XYZ.

Parameters:
val true if all fields will be returned, false if only XYZ

Definition at line 224 of file project_inliers.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::ProjectInliers< sensor_msgs::PointCloud2 >::setModelCoefficients ( const ModelCoefficientsConstPtr model  )  [inline]

Provide a pointer to the model coefficients.

Parameters:
model a pointer to the model coefficients

Definition at line 208 of file project_inliers.h.

void pcl::ProjectInliers< sensor_msgs::PointCloud2 >::setModelType ( int  model  )  [inline]

The type of model to use (user given parameter).

Parameters:
model the model type (check model_types.h)

Definition at line 192 of file project_inliers.h.


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