Point Cloud Library (PCL)  1.8.1-dev
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::PCLSurfaceBase< PointInT > Class Template Referenceabstract

Pure abstract class. More...

#include <pcl/surface/reconstruction.h>

+ Inheritance diagram for pcl::PCLSurfaceBase< PointInT >:

Public Types

typedef boost::shared_ptr
< PCLSurfaceBase< PointInT > > 
Ptr
 
typedef boost::shared_ptr
< const PCLSurfaceBase
< PointInT > > 
ConstPtr
 
typedef pcl::search::Search
< PointInT > 
KdTree
 
typedef pcl::search::Search
< PointInT >::Ptr 
KdTreePtr
 
- Public Types inherited from pcl::PCLBase< PointInT >
typedef pcl::PointCloud< PointInT > PointCloud
 
typedef PointCloud::Ptr PointCloudPtr
 
typedef PointCloud::ConstPtr PointCloudConstPtr
 
typedef boost::shared_ptr
< PointIndices
PointIndicesPtr
 
typedef boost::shared_ptr
< PointIndices const > 
PointIndicesConstPtr
 

Public Member Functions

 PCLSurfaceBase ()
 Empty constructor. More...
 
virtual ~PCLSurfaceBase ()
 Empty destructor. More...
 
void setSearchMethod (const KdTreePtr &tree)
 Provide an optional pointer to a search object. More...
 
KdTreePtr getSearchMethod ()
 Get a pointer to the search method used. More...
 
virtual void reconstruct (pcl::PolygonMesh &output)=0
 Base method for surface reconstruction for all points given in <setInputCloud (), setIndices ()> More...
 
- Public Member Functions inherited from pcl::PCLBase< PointInT >
 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 (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...
 
IndicesConstPtr const getIndices () const
 Get a pointer to the vector of indices used. More...
 
const PointInT & operator[] (size_t pos) const
 Override PointCloud operator[] to shorten code. More...
 

Protected Member Functions

virtual std::string getClassName () const
 Abstract class get name method. More...
 
- Protected Member Functions inherited from pcl::PCLBase< PointInT >
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...
 

Protected Attributes

KdTreePtr tree_
 A pointer to the spatial search object. More...
 
- Protected Attributes inherited from pcl::PCLBase< PointInT >
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 PointInT>
class pcl::PCLSurfaceBase< PointInT >

Pure abstract class.

All types of meshing/reconstruction algorithms in libpcl_surface must inherit from this, in order to make sure we have a consistent API. The methods that we care about here are:

Author
Radu B. Rusu, Michael Dixon, Alexandru E. Ichim

Definition at line 61 of file reconstruction.h.

Member Typedef Documentation

template<typename PointInT>
typedef boost::shared_ptr<const PCLSurfaceBase<PointInT> > pcl::PCLSurfaceBase< PointInT >::ConstPtr

Definition at line 65 of file reconstruction.h.

template<typename PointInT>
typedef pcl::search::Search<PointInT> pcl::PCLSurfaceBase< PointInT >::KdTree

Definition at line 67 of file reconstruction.h.

template<typename PointInT>
typedef pcl::search::Search<PointInT>::Ptr pcl::PCLSurfaceBase< PointInT >::KdTreePtr

Definition at line 68 of file reconstruction.h.

template<typename PointInT>
typedef boost::shared_ptr<PCLSurfaceBase<PointInT> > pcl::PCLSurfaceBase< PointInT >::Ptr

Definition at line 64 of file reconstruction.h.

Constructor & Destructor Documentation

template<typename PointInT>
pcl::PCLSurfaceBase< PointInT >::PCLSurfaceBase ( )
inline

Empty constructor.

Definition at line 71 of file reconstruction.h.

template<typename PointInT>
virtual pcl::PCLSurfaceBase< PointInT >::~PCLSurfaceBase ( )
inlinevirtual

Empty destructor.

Definition at line 74 of file reconstruction.h.

Member Function Documentation

template<typename PointInT>
virtual std::string pcl::PCLSurfaceBase< PointInT >::getClassName ( ) const
inlineprotectedvirtual

Abstract class get name method.

Reimplemented in pcl::MarchingCubes< PointNT >, pcl::ConvexHull< PointInT >, pcl::Poisson< PointNT >, and pcl::ConcaveHull< PointInT >.

Definition at line 102 of file reconstruction.h.

template<typename PointInT>
KdTreePtr pcl::PCLSurfaceBase< PointInT >::getSearchMethod ( )
inline

Get a pointer to the search method used.

Definition at line 87 of file reconstruction.h.

template<typename PointInT>
virtual void pcl::PCLSurfaceBase< PointInT >::reconstruct ( pcl::PolygonMesh output)
pure virtual

Base method for surface reconstruction for all points given in <setInputCloud (), setIndices ()>

Parameters
[out]outputthe resultant reconstructed surface model

Implemented in pcl::MeshConstruction< PointInT >, pcl::SurfaceReconstruction< PointInT >, and pcl::SurfaceReconstruction< PointNT >.

template<typename PointInT>
void pcl::PCLSurfaceBase< PointInT >::setSearchMethod ( const KdTreePtr tree)
inline

Provide an optional pointer to a search object.

Parameters
[in]treea pointer to the spatial search object.

Definition at line 80 of file reconstruction.h.

Member Data Documentation

template<typename PointInT>
KdTreePtr pcl::PCLSurfaceBase< PointInT >::tree_
protected

A pointer to the spatial search object.

Definition at line 98 of file reconstruction.h.

Referenced by pcl::PCLSurfaceBase< PointNT >::getSearchMethod(), and pcl::PCLSurfaceBase< PointNT >::setSearchMethod().


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