Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Types | Public Member Functions | Protected 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 >:

Public Types

using Ptr = boost::shared_ptr< ProjectInliers< PointT > >
 
using ConstPtr = boost::shared_ptr< const ProjectInliers< PointT > >
 
- Public Types inherited from pcl::Filter< PointT >
using Ptr = boost::shared_ptr< Filter< PointT > >
 
using ConstPtr = boost::shared_ptr< const Filter< PointT > >
 
using PointCloud = pcl::PointCloud< PointT >
 
using PointCloudPtr = typename PointCloud::Ptr
 
using PointCloudConstPtr = typename PointCloud::ConstPtr
 
- Public Types inherited from pcl::PCLBase< PointT >
using PointCloud = pcl::PointCloud< PointT >
 
using PointCloudPtr = typename PointCloud::Ptr
 
using PointCloudConstPtr = typename PointCloud::ConstPtr
 
using PointIndicesPtr = PointIndices::Ptr
 
using PointIndicesConstPtr = PointIndices::ConstPtr
 

Public Member Functions

 ProjectInliers ()
 Empty constructor. More...
 
 ~ProjectInliers ()
 Empty destructor. 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...
 
- Public Member Functions inherited from pcl::Filter< PointT >
 Filter (bool extract_removed_indices=false)
 Empty constructor. More...
 
 ~Filter ()
 Empty destructor. More...
 
IndicesConstPtr const getRemovedIndices () const
 Get the point indices being removed. More...
 
void getRemovedIndices (PointIndices &pi)
 Get the point indices being removed. More...
 
void filter (PointCloud &output)
 Calls the filtering method and returns the filtered dataset in output. More...
 
- Public Member Functions inherited from pcl::PCLBase< PointT >
 PCLBase ()
 Empty constructor. More...
 
 PCLBase (const PCLBase &base)
 Copy constructor. More...
 
virtual ~PCLBase ()
 Destructor. More...
 
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Provide a pointer to the input dataset. More...
 
PointCloudConstPtr const getInputCloud () const
 Get a pointer to the input point cloud dataset. More...
 
virtual void setIndices (const IndicesPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (const IndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (const PointIndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data. More...
 
virtual void setIndices (std::size_t row_start, std::size_t col_start, std::size_t nb_rows, std::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...
 
IndicesConstPtr const getIndices () const
 Get a pointer to the vector of indices used. More...
 
const PointToperator[] (std::size_t pos) const
 Override PointCloud operator[] to shorten code. More...
 

Protected Member Functions

void applyFilter (PointCloud &output) override
 Project point indices into a separate PointCloud. More...
 
- Protected Member Functions inherited from pcl::Filter< PointT >
const std::string & getClassName () const
 Get a string representation of the name of this class. More...
 
- Protected Member Functions inherited from pcl::PCLBase< PointT >
bool initCompute ()
 This method should get called before starting the actual computation. More...
 
bool deinitCompute ()
 This method should get called after finishing the actual computation. More...
 

Additional Inherited Members

- Protected Attributes inherited from pcl::Filter< PointT >
IndicesPtr removed_indices_
 Indices of the points that are removed. More...
 
std::string filter_name_
 The filter name. More...
 
bool extract_removed_indices_
 Set to true if we want to return the indices of the removed points. More...
 
- Protected Attributes inherited from pcl::PCLBase< PointT >
PointCloudConstPtr input_
 The input point cloud dataset. More...
 
IndicesPtr indices_
 A pointer to the vector of point indices to use. More...
 
bool use_indices_
 Set to true if point indices are used. More...
 
bool fake_indices_
 If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud. 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 68 of file project_inliers.h.

Member Typedef Documentation

◆ ConstPtr

template<typename PointT>
using pcl::ProjectInliers< PointT >::ConstPtr = boost::shared_ptr<const ProjectInliers<PointT> >

Definition at line 83 of file project_inliers.h.

◆ Ptr

template<typename PointT>
using pcl::ProjectInliers< PointT >::Ptr = boost::shared_ptr<ProjectInliers<PointT> >

Definition at line 82 of file project_inliers.h.

Constructor & Destructor Documentation

◆ ProjectInliers()

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

Empty constructor.

Definition at line 87 of file project_inliers.h.

References pcl::Filter< PointT >::filter_name_.

◆ ~ProjectInliers()

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

Empty destructor.

Definition at line 93 of file project_inliers.h.

Member Function Documentation

◆ applyFilter()

template<typename PointT >
void pcl::ProjectInliers< PointT >::applyFilter ( PointCloud output)
overrideprotectedvirtual

◆ getCopyAllData()

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

References pcl::ProjectInliers< PointT >::applyFilter().

◆ getModelCoefficients()

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

Get a pointer to the model coefficients.

Definition at line 122 of file project_inliers.h.

◆ getModelType()

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

Get the type of SAC model used.

Definition at line 106 of file project_inliers.h.

◆ setCopyAllData()

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

◆ setModelCoefficients()

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

Referenced by pcl::LocalMaximum< PointT >::applyFilterIndices().

◆ setModelType()

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

Referenced by pcl::LocalMaximum< PointT >::applyFilterIndices().


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