Point Cloud Library (PCL)  1.8.1-dev
List of all members | Public Member Functions | Protected Types | Protected Member Functions
pcl::LocalMaximum< PointT > Class Template Reference

LocalMaximum downsamples the cloud, by eliminating points that are locally maximal. More...

#include <pcl/filters/local_maximum.h>

+ Inheritance diagram for pcl::LocalMaximum< PointT >:

Public Member Functions

 LocalMaximum (bool extract_removed_indices=false)
 Empty constructor. More...
 
void setRadius (float radius)
 Set the radius to use to determine if a point is the local max. More...
 
float getRadius () const
 Get the radius to use to determine if a point is the local max. More...
 
- Public Member Functions inherited from pcl::FilterIndices< PointT >
 FilterIndices (bool extract_removed_indices=false)
 Constructor. More...
 
virtual ~FilterIndices ()
 Empty virtual destructor. More...
 
void filter (PointCloud &output)
 
void filter (std::vector< int > &indices)
 Calls the filtering method and returns the filtered point cloud indices. More...
 
void setNegative (bool negative)
 Set whether the regular conditions for points filtering should apply, or the inverted conditions. More...
 
bool getNegative ()
 Get whether the regular conditions for points filtering should apply, or the inverted conditions. More...
 
void setKeepOrganized (bool keep_organized)
 Set whether the filtered points should be kept and set to the value given through setUserFilterValue (default: NaN), or removed from the PointCloud, thus potentially breaking its organized structure. More...
 
bool getKeepOrganized ()
 Get whether the filtered points should be kept and set to the value given through setUserFilterValue (default = NaN), or removed from the PointCloud, thus potentially breaking its organized structure. More...
 
void setUserFilterValue (float value)
 Provide a value that the filtered points should be set to instead of removing them. More...
 
- Public Member Functions inherited from pcl::Filter< PointT >
 Filter (bool extract_removed_indices=false)
 Empty constructor. More...
 
virtual ~Filter ()
 Empty destructor. More...
 
IndicesConstPtr const getRemovedIndices ()
 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 (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 PointToperator[] (size_t pos) const
 Override PointCloud operator[] to shorten code. More...
 

Protected Types

typedef FilterIndices< PointT >
::PointCloud 
PointCloud
 
typedef pcl::search::Search
< PointT >::Ptr 
SearcherPtr
 

Protected Member Functions

void applyFilter (PointCloud &output)
 Downsample a Point Cloud by eliminating points that are locally maximal in z. More...
 
void applyFilter (std::vector< int > &indices)
 Filtered results are indexed by an indices array. More...
 
void applyFilterIndices (std::vector< int > &indices)
 Filtered results are indexed by an indices array. 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

- Public Types inherited from pcl::FilterIndices< PointT >
typedef pcl::PointCloud< PointTPointCloud
 
typedef boost::shared_ptr
< FilterIndices< PointT > > 
Ptr
 
typedef boost::shared_ptr
< const FilterIndices< PointT > > 
ConstPtr
 
- Public Types inherited from pcl::Filter< PointT >
typedef boost::shared_ptr
< Filter< PointT > > 
Ptr
 
typedef boost::shared_ptr
< const Filter< PointT > > 
ConstPtr
 
typedef pcl::PointCloud< PointTPointCloud
 
typedef PointCloud::Ptr PointCloudPtr
 
typedef PointCloud::ConstPtr PointCloudConstPtr
 
- Public Types inherited from pcl::PCLBase< PointT >
typedef pcl::PointCloud< PointTPointCloud
 
typedef PointCloud::Ptr PointCloudPtr
 
typedef PointCloud::ConstPtr PointCloudConstPtr
 
typedef boost::shared_ptr
< PointIndices
PointIndicesPtr
 
typedef boost::shared_ptr
< PointIndices const > 
PointIndicesConstPtr
 
- Protected Attributes inherited from pcl::FilterIndices< PointT >
bool negative_
 False = normal filter behavior (default), true = inverted behavior. More...
 
bool keep_organized_
 False = remove points (default), true = redefine points, keep structure. More...
 
float user_filter_value_
 The user given value that the filtered point dimensions should be set to (default = NaN). More...
 
- 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::LocalMaximum< PointT >

LocalMaximum downsamples the cloud, by eliminating points that are locally maximal.

The LocalMaximum class analyzes each point and removes those that are found to be locally maximal with respect to their neighbors (found via radius search). The comparison is made in the z dimension only at this time.

Author
Bradley J Chambers

Definition at line 61 of file local_maximum.h.

Member Typedef Documentation

template<typename PointT >
typedef FilterIndices<PointT>::PointCloud pcl::LocalMaximum< PointT >::PointCloud
protected

Definition at line 64 of file local_maximum.h.

template<typename PointT >
typedef pcl::search::Search<PointT>::Ptr pcl::LocalMaximum< PointT >::SearcherPtr
protected

Definition at line 65 of file local_maximum.h.

Constructor & Destructor Documentation

template<typename PointT >
pcl::LocalMaximum< PointT >::LocalMaximum ( bool  extract_removed_indices = false)
inline

Empty constructor.

Definition at line 69 of file local_maximum.h.

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

Member Function Documentation

template<typename PointT >
void pcl::LocalMaximum< PointT >::applyFilter ( PointCloud output)
protectedvirtual

Downsample a Point Cloud by eliminating points that are locally maximal in z.

Parameters
[out]outputthe resultant point cloud message

Implements pcl::FilterIndices< PointT >.

Definition at line 52 of file local_maximum.hpp.

References pcl::PointCloud< T >::height, pcl::PointCloud< T >::is_dense, pcl::PointCloud< T >::points, and pcl::PointCloud< T >::width.

template<typename PointT >
void pcl::LocalMaximum< PointT >::applyFilter ( std::vector< int > &  indices)
inlineprotectedvirtual

Filtered results are indexed by an indices array.

Parameters
[out]indicesThe resultant indices.

Implements pcl::FilterIndices< PointT >.

Definition at line 108 of file local_maximum.h.

References pcl::LocalMaximum< PointT >::applyFilterIndices().

template<typename PointT >
void pcl::LocalMaximum< PointT >::applyFilterIndices ( std::vector< int > &  indices)
protected
template<typename PointT >
float pcl::LocalMaximum< PointT >::getRadius ( ) const
inline

Get the radius to use to determine if a point is the local max.

Returns
The radius to use to determine if a point is the local max.

Definition at line 87 of file local_maximum.h.

template<typename PointT >
void pcl::LocalMaximum< PointT >::setRadius ( float  radius)
inline

Set the radius to use to determine if a point is the local max.

Parameters
[in]radiusThe radius to use to determine if a point is the local max.

Definition at line 81 of file local_maximum.h.


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