Point Cloud Library (PCL) 1.15.0
Loading...
Searching...
No Matches
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::PCLSurfaceBase< PointInT > Class Template Referenceabstract
Module surface

Pure abstract class. More...

#include <pcl/surface/reconstruction.h>

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

Public Types

using Ptr = shared_ptr<PCLSurfaceBase<PointInT> >
using ConstPtr = shared_ptr<const PCLSurfaceBase<PointInT> >
using KdTree = pcl::search::Search<PointInT>
using KdTreePtr = typename KdTree::Ptr
Public Types inherited from pcl::PCLBase< PointInT >
using PointCloud
using PointCloudPtr
using PointCloudConstPtr
using PointIndicesPtr
using PointIndicesConstPtr

Public Member Functions

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

Protected Member Functions

virtual std::string getClassName () const
 Abstract class get name method.
Protected Member Functions inherited from pcl::PCLBase< PointInT >
bool initCompute ()
 This method should get called before starting the actual computation.
bool deinitCompute ()
 This method should get called after finishing the actual computation.

Protected Attributes

KdTreePtr tree_
 A pointer to the spatial search object.
Protected Attributes inherited from pcl::PCLBase< PointInT >
PointCloudConstPtr input_
 The input point cloud dataset.
IndicesPtr indices_
 A pointer to the vector of point indices to use.
bool use_indices_
 Set to true if point indices are used.
bool fake_indices_
 If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud.

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:

  • setSearchMethod(&SearchPtr): passes a search locator
  • reconstruct(&PolygonMesh): creates a PolygonMesh object from the input data
Author
Radu B. Rusu, Michael Dixon, Alexandru E. Ichim

Definition at line 59 of file reconstruction.h.

Member Typedef Documentation

◆ ConstPtr

template<typename PointInT>
using pcl::PCLSurfaceBase< PointInT >::ConstPtr = shared_ptr<const PCLSurfaceBase<PointInT> >

Definition at line 63 of file reconstruction.h.

◆ KdTree

template<typename PointInT>
using pcl::PCLSurfaceBase< PointInT >::KdTree = pcl::search::Search<PointInT>

Definition at line 65 of file reconstruction.h.

◆ KdTreePtr

template<typename PointInT>
using pcl::PCLSurfaceBase< PointInT >::KdTreePtr = typename KdTree::Ptr

Definition at line 66 of file reconstruction.h.

◆ Ptr

template<typename PointInT>
using pcl::PCLSurfaceBase< PointInT >::Ptr = shared_ptr<PCLSurfaceBase<PointInT> >

Definition at line 62 of file reconstruction.h.

Constructor & Destructor Documentation

◆ PCLSurfaceBase()

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

Empty constructor.

Definition at line 69 of file reconstruction.h.

References tree_.

◆ ~PCLSurfaceBase()

template<typename PointInT>
pcl::PCLSurfaceBase< PointInT >::~PCLSurfaceBase ( )
overridedefault

Empty destructor.

Member Function Documentation

◆ getClassName()

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

Abstract class get name method.

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

Definition at line 100 of file reconstruction.h.

◆ getSearchMethod()

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

Get a pointer to the search method used.

Definition at line 85 of file reconstruction.h.

References tree_.

◆ reconstruct()

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 >.

◆ setSearchMethod()

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 78 of file reconstruction.h.

References tree_.

Member Data Documentation

◆ tree_

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

A pointer to the spatial search object.

Definition at line 96 of file reconstruction.h.

Referenced by getSearchMethod(), PCLSurfaceBase(), pcl::MeshConstruction< PointInT >::reconstruct(), pcl::SurfaceReconstruction< PointInT >::reconstruct(), pcl::SurfaceReconstruction< PointInT >::reconstruct(), and setSearchMethod().

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