Point Cloud Library (PCL)  1.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
pcl::ProjectInliers< PointT > Class Template 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< PointT >:
Inheritance graph
[legend]
Collaboration diagram for pcl::ProjectInliers< PointT >:
Collaboration graph
[legend]

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. More...
 
void setModelType (int model)
 The type of model to use (user given parameter). More...
 
int getModelType ()
 Get the type of SAC model used. More...
 
void setModelCoefficients (const ModelCoefficientsConstPtr &model)
 Provide a pointer to the model coefficients. More...
 
ModelCoefficientsConstPtr getModelCoefficients ()
 Get a pointer to the model coefficients. More...
 
void setCopyAllData (bool val)
 Set whether all data will be returned, or only the projected inliers. More...
 
bool getCopyAllData ()
 Get whether all data is being copied (true), or only the projected inliers (false). More...
 
IndicesConstPtr const getRemovedIndices ()
 Get the point indices being removed. More...
 
void filter (PointCloud &output)
 Calls the filtering method and returns the filtered dataset in output. More...
 
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Provide a pointer to the input dataset. More...
 
PointCloudConstPtr const getInputCloud ()
 Get a pointer to the input point cloud dataset. More...
 
void setIndices (const IndicesPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
void setIndices (const IndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
void setIndices (const PointIndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
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. More...
 
IndicesPtr const getIndices ()
 Get a pointer to the vector of indices used. More...
 
const PointToperator[] (size_t pos)
 Override PointCloud operator[] to shorten code. More...
 

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.

Author
Radu Bogdan Rusu

Definition at line 69 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 76 of file filter.h.

template<typename PointT>
typedef PointIndices::ConstPtr pcl::PCLBase< PointT >::PointIndicesConstPtr
inherited

Definition at line 79 of file pcl_base.h.

template<typename PointT>
typedef PointIndices::Ptr pcl::PCLBase< PointT >::PointIndicesPtr
inherited

Definition at line 78 of file pcl_base.h.

template<typename PointT>
typedef boost::shared_ptr< Filter<PointT> > pcl::Filter< PointT >::Ptr
inherited

Definition at line 75 of file filter.h.

Constructor & Destructor Documentation

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

Empty constructor.

Definition at line 83 of file project_inliers.h.

Member Function Documentation

template<typename PointT>
void pcl::Filter< PointT >::filter ( PointCloud output)
inlineinherited

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

Parameters
[out]outputthe resultant filtered point cloud dataset

Definition at line 104 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 131 of file project_inliers.h.

template<typename PointT>
IndicesPtr const pcl::PCLBase< PointT >::getIndices ( )
inlineinherited

Get a pointer to the vector of indices used.

Definition at line 190 of file pcl_base.h.

template<typename PointT>
PointCloudConstPtr const pcl::PCLBase< PointT >::getInputCloud ( )
inlineinherited

Get a pointer to the input point cloud dataset.

Definition at line 107 of file pcl_base.h.

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

Get a pointer to the model coefficients.

Definition at line 115 of file project_inliers.h.

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

Get the type of SAC model used.

Definition at line 99 of file project_inliers.h.

template<typename PointT>
IndicesConstPtr const pcl::Filter< PointT >::getRemovedIndices ( )
inlineinherited

Get the point indices being removed.

Definition at line 95 of file filter.h.

template<typename PointT>
const PointT& pcl::PCLBase< PointT >::operator[] ( size_t  pos)
inlineinherited

Override PointCloud operator[] to shorten code.

Note
this method can be called instead of (*input_)[(*indices_)[pos]] or input_->points[(*indices_)[pos]]
Parameters
posposition in indices_ vector

Definition at line 197 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
valtrue if all data should be returned, false if only the projected inliers

Definition at line 124 of file project_inliers.h.

template<typename PointT>
void pcl::PCLBase< PointT >::setIndices ( const IndicesPtr indices)
inlineinherited

Provide a pointer to the vector of indices that represents the input data.

Parameters
indicesa pointer to the vector of indices that represents the input data.

Definition at line 113 of file pcl_base.h.

template<typename PointT>
void pcl::PCLBase< PointT >::setIndices ( const IndicesConstPtr indices)
inlineinherited

Provide a pointer to the vector of indices that represents the input data.

Parameters
indicesa pointer to the vector of indices that represents the input data.

Definition at line 124 of file pcl_base.h.

template<typename PointT>
void pcl::PCLBase< PointT >::setIndices ( const PointIndicesConstPtr indices)
inlineinherited

Provide a pointer to the vector of indices that represents the input data.

Parameters
indicesa pointer to the vector of indices that represents the input data.

Definition at line 135 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 
)
inlineinherited

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_startthe offset on rows
col_startthe offset on columns
nb_rowsthe number of rows to be considered row_start included
nb_colsthe number of columns to be considered col_start included

Definition at line 151 of file pcl_base.h.

template<typename PointT>
virtual void pcl::PCLBase< PointT >::setInputCloud ( const PointCloudConstPtr cloud)
inlinevirtualinherited

Provide a pointer to the input dataset.

Parameters
cloudthe const boost shared pointer to a PointCloud message

Reimplemented in pcl::PCA< PointT >.

Definition at line 103 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
modela pointer to the model coefficients

Definition at line 108 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
modelthe model type (check model_types.h)

Definition at line 92 of file project_inliers.h.


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