Public Types | Public Member Functions

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

List of all members.

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

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

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 68 of file project_inliers.h.


Member Typedef Documentation

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

Definition at line 75 of file filter.h.

template<typename PointT>
typedef PointIndices::ConstPtr pcl::PCLBase< PointT >::PointIndicesConstPtr [inherited]
template<typename PointT>
typedef PointIndices::Ptr pcl::PCLBase< PointT >::PointIndicesPtr [inherited]
template<typename PointT>
typedef boost::shared_ptr< Filter<PointT> > pcl::Filter< PointT >::Ptr [inherited]

Definition at line 74 of file filter.h.


Constructor & Destructor Documentation

template<typename PointT>
pcl::ProjectInliers< PointT >::ProjectInliers (  )  [inline]

Empty constructor.

Definition at line 82 of file project_inliers.h.


Member Function Documentation

template<typename PointT>
void pcl::Filter< PointT >::filter ( PointCloud output  )  [inline, inherited]

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

Parameters:
output the resultant filtered point cloud dataset

Reimplemented in pcl::FilterIndices< PointT >.

Definition at line 160 of file filter.h.

template<typename PointT>
bool pcl::ProjectInliers< PointT >::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.

template<typename PointT>
std::string const pcl::Filter< PointT >::getFilterFieldName (  )  [inline, inherited]

Get the name of the field used for filtering.

Definition at line 110 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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.

template<typename PointT>
void pcl::Filter< PointT >::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.

template<typename PointT>
bool pcl::Filter< PointT >::getFilterLimitsNegative (  )  [inline, inherited]

Definition at line 151 of file filter.h.

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

Get a pointer to the vector of indices used.

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

template<typename PointT>
ModelCoefficientsConstPtr pcl::ProjectInliers< PointT >::getModelCoefficients (  )  [inline]

Get a pointer to the model coefficients.

Definition at line 114 of file project_inliers.h.

template<typename PointT>
int pcl::ProjectInliers< PointT >::getModelType (  )  [inline]

Get the type of SAC model used.

Definition at line 98 of file project_inliers.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>
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 178 of file pcl_base.h.

template<typename PointT>
void pcl::ProjectInliers< PointT >::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 123 of file project_inliers.h.

template<typename PointT>
void pcl::Filter< PointT >::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 103 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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 120 of file filter.h.

template<typename PointT>
void pcl::Filter< PointT >::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 139 of file filter.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 105 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 116 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 132 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

Definition at line 95 of file pcl_base.h.

template<typename PointT>
void pcl::ProjectInliers< PointT >::setModelCoefficients ( const ModelCoefficientsConstPtr model  )  [inline]

Provide a pointer to the model coefficients.

Parameters:
model a pointer to the model coefficients

Definition at line 107 of file project_inliers.h.

template<typename PointT>
void pcl::ProjectInliers< PointT >::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 91 of file project_inliers.h.


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