pcl::PCLBase< PointT > Class Template Reference

PCL base class. Implements methods that are used by all PCL objects. More...

#include <pcl_base.h>

Inheritance diagram for pcl::PCLBase< PointT >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef pcl::PointCloud< PointT > PointCloud
typedef PointCloud::ConstPtr PointCloudConstPtr
typedef PointCloud::Ptr PointCloudPtr
typedef PointIndices::ConstPtr PointIndicesConstPtr
typedef PointIndices::Ptr PointIndicesPtr

Public Member Functions

IndicesConstPtr const getIndices ()
 Get a pointer to the vector of indices used.
PointCloudConstPtr const getInputCloud ()
 Get a pointer to the input point cloud dataset.
 PCLBase ()
 Empty constructor.
void setIndices (const PointIndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data.
void setIndices (const IndicesConstPtr &indices)
 Provide a pointer to the vector of indices that represents the input data.
virtual void setInputCloud (const PointCloudConstPtr &cloud)
 Provide a pointer to the input dataset.

Protected Member Functions

bool deinitCompute ()
 This method should get called after finishing the actual computation.
bool initCompute ()
 This method should get called before starting the actual computation.

Protected Attributes

bool fake_indices_
 If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud.
IndicesConstPtr indices_
 A pointer to the vector of point indices to use.
PointCloudConstPtr input_
 The input point cloud dataset.
bool use_indices_
 Set to true if point indices are used.

Detailed Description

template<typename PointT>
class pcl::PCLBase< PointT >

PCL base class. Implements methods that are used by all PCL objects.

Definition at line 67 of file pcl_base.h.


Member Typedef Documentation

template<typename PointT>
typedef pcl::PointCloud<PointT> pcl::PCLBase< PointT >::PointCloud
template<typename PointT>
typedef PointCloud::ConstPtr pcl::PCLBase< PointT >::PointCloudConstPtr
template<typename PointT>
typedef PointCloud::Ptr pcl::PCLBase< PointT >::PointCloudPtr
template<typename PointT>
typedef PointIndices::ConstPtr pcl::PCLBase< PointT >::PointIndicesConstPtr
template<typename PointT>
typedef PointIndices::Ptr pcl::PCLBase< PointT >::PointIndicesPtr

Constructor & Destructor Documentation

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

Empty constructor.

Definition at line 78 of file pcl_base.h.


Member Function Documentation

template<typename PointT>
bool pcl::PCLBase< PointT >::deinitCompute (  )  [inline, protected]

This method should get called after finishing the actual computation.

Definition at line 158 of file pcl_base.h.

template<typename PointT>
IndicesConstPtr const pcl::PCLBase< PointT >::getIndices (  )  [inline]

Get a pointer to the vector of indices used.

Definition at line 114 of file pcl_base.h.

template<typename PointT>
PointCloudConstPtr const pcl::PCLBase< PointT >::getInputCloud (  )  [inline]

Get a pointer to the input point cloud dataset.

Definition at line 88 of file pcl_base.h.

template<typename PointT>
bool pcl::PCLBase< PointT >::initCompute (  )  [inline, protected]

This method should get called before starting the actual computation.

Definition at line 131 of file pcl_base.h.

template<typename PointT>
void pcl::PCLBase< PointT >::setIndices ( const PointIndicesConstPtr indices  )  [inline]

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 IndicesConstPtr indices  )  [inline]

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.

Reimplemented in pcl::FPFHEstimation< PointInT, PointNT, PointOutT >.

Definition at line 94 of file pcl_base.h.

template<typename PointT>
virtual void pcl::PCLBase< PointT >::setInputCloud ( const PointCloudConstPtr cloud  )  [inline, virtual]

Provide a pointer to the input dataset.

Parameters:
cloud the const boost shared pointer to a PointCloud message

Definition at line 84 of file pcl_base.h.


Member Data Documentation

template<typename PointT>
bool pcl::PCLBase< PointT >::fake_indices_ [protected]

If no set of indices are given, we construct a set of fake indices that mimic the input PointCloud.

Definition at line 127 of file pcl_base.h.

template<typename PointT>
IndicesConstPtr pcl::PCLBase< PointT >::indices_ [protected]

A pointer to the vector of point indices to use.

Definition at line 121 of file pcl_base.h.

template<typename PointT>
PointCloudConstPtr pcl::PCLBase< PointT >::input_ [protected]

The input point cloud dataset.

Definition at line 118 of file pcl_base.h.

template<typename PointT>
bool pcl::PCLBase< PointT >::use_indices_ [protected]

Set to true if point indices are used.

Definition at line 124 of file pcl_base.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


pcl
Author(s): See http://pcl.ros.org/authors for the complete list of authors.
autogenerated on Fri Jan 11 09:57:20 2013