Point Cloud Library (PCL)  1.3.1
Public Types | Public Member Functions
pcl::ProjectInliers Class Reference

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

List of all members.

Public Types

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

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 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 (PointCloud &output)
 Calls the filtering method and returns the filtered dataset in output.

Detailed Description

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

Member Typedef Documentation

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

Definition at line 75 of file filter.h.

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

Definition at line 74 of file filter.h.


Constructor & Destructor Documentation

pcl::ProjectInliers::ProjectInliers ( ) [inline]

Empty constructor.

Definition at line 82 of file project_inliers.h.


Member Function Documentation

void pcl::Filter::filter ( PointCloud output) [inline, inherited]

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

Parameters:
outputthe resultant filtered point cloud dataset

Reimplemented in pcl::FilterIndices.

Definition at line 160 of file filter.h.

bool pcl::ProjectInliers::getCopyAllData ( ) [inline]

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

Definition at line 130 of file project_inliers.h.

std::string const pcl::Filter::getFilterFieldName ( ) [inline, inherited]

Get the name of the field used for filtering.

Definition at line 110 of file filter.h.

void pcl::Filter::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 128 of file filter.h.

void pcl::Filter::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 146 of file filter.h.

bool pcl::Filter::getFilterLimitsNegative ( ) [inline, inherited]

Definition at line 151 of file filter.h.

ModelCoefficientsConstPtr pcl::ProjectInliers::getModelCoefficients ( ) [inline]

Get a pointer to the model coefficients.

Definition at line 114 of file project_inliers.h.

int pcl::ProjectInliers::getModelType ( ) [inline]

Get the type of SAC model used.

Definition at line 98 of file project_inliers.h.

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

Get the point indices being removed.

Definition at line 93 of file filter.h.

void pcl::ProjectInliers::setCopyAllData ( bool  val) [inline]

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

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

Definition at line 123 of file project_inliers.h.

void pcl::Filter::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_namethe name of the field that contains values used for filtering

Definition at line 103 of file filter.h.

void pcl::Filter::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_minthe minimum allowed field value
limit_maxthe maximum allowed field value

Definition at line 120 of file filter.h.

void pcl::Filter::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_negativereturn data inside the interval (false) or outside (true)

Definition at line 139 of file filter.h.

void pcl::ProjectInliers::setModelCoefficients ( const ModelCoefficientsConstPtr model) [inline]

Provide a pointer to the model coefficients.

Parameters:
modela pointer to the model coefficients

Definition at line 107 of file project_inliers.h.

void pcl::ProjectInliers::setModelType ( int  model) [inline]

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

Parameters:
modelthe model type (check model_types.h)

Definition at line 91 of file project_inliers.h.


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