pcl::OrganizedDataIndex< PointT > Class Template Reference

OrganizedDataIndex is a type of spatial locator used to query organized datasets, such as point clouds acquired using dense stereo devices. The class best supports square data blocks for now in the form of (k*k+1)^2. More...

#include <organized_data.h>

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

List of all members.

Public Types

typedef boost::shared_ptr
< const OrganizedDataIndex
< PointT > > 
ConstPtr
typedef boost::shared_ptr
< OrganizedDataIndex< PointT > > 
Ptr

Public Member Functions

int getHorizontalSearchWindow () const
 Get the horizontal search window in pixels.
float getMaxDistance () const
 Get the maximum allowed distance between the query point and its k-nearest neighbors.
int getVerticalSearchWindow () const
 Get the vertical search window in pixels.
Ptr makeShared () const
int nearestKSearch (int index, int k, std::vector< int > &k_indices, std::vector< float > &k_distances)
 Search for k-nearest neighbors for the given query point.
int nearestKSearch (const PointCloud &cloud, int index, int k, std::vector< int > &k_indices, std::vector< float > &k_distances)
 Search for k-nearest neighbors for the given query point.
int nearestKSearch (const PointT &p_q, int k, std::vector< int > &k_indices, std::vector< float > &k_distances)
 Search for k-nearest neighbors for the given query point.
 OrganizedDataIndex ()
 Empty constructor for OrganizedDataIndex. Sets some internal values to their defaults.
int radiusSearch (int index, double radius, std::vector< int > &k_indices, std::vector< float > &k_distances, int max_nn=INT_MAX) const
 Approximate search for neighbors around the point from the given index within radius.
int radiusSearch (const PointCloud &cloud, int index, double radius, std::vector< int > &k_indices, std::vector< float > &k_distances, int max_nn=INT_MAX) const
 Approximate search for neighbors around the given query point within radius.
int radiusSearch (const PointT &p_q, double radius, std::vector< int > &k_indices, std::vector< float > &k_distances, int max_nn=INT_MAX) const
 Search for all the nearest neighbors of the query point in a given radius.
void setMaxDistance (float max_dist)
 Set the maximum allowed distance between the query point and its k-nearest neighbors.
void setSearchWindow (int horizontal, int vertical)
 Set the search window (horizontal, vertical) in pixels.
void setSearchWindowAsK (int k)
 Estimate the search window (horizontal, vertical) in pixels in order to get up to k-neighbors.

Private Types

typedef KdTree< PointT > BaseClass
typedef KdTree< PointT >
::PointCloud 
PointCloud
typedef KdTree< PointT >
::PointCloudConstPtr 
PointCloudConstPtr

Private Member Functions

virtual std::string getName () const
 Class getName method.

Private Attributes

int horizontal_window_
 The horizontal search window.
float max_distance_
 Maximum allowed distance between the query point and its k-neighbors.
int vertical_window_
 The horizontal search window.

Detailed Description

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

OrganizedDataIndex is a type of spatial locator used to query organized datasets, such as point clouds acquired using dense stereo devices. The class best supports square data blocks for now in the form of (k*k+1)^2.

Author:
Radu Bogdan Rusu

Definition at line 53 of file organized_data.h.


Member Typedef Documentation

template<typename PointT >
typedef KdTree<PointT> pcl::OrganizedDataIndex< PointT >::BaseClass [private]

Definition at line 58 of file organized_data.h.

template<typename PointT >
typedef boost::shared_ptr<const OrganizedDataIndex<PointT> > pcl::OrganizedDataIndex< PointT >::ConstPtr

Reimplemented from pcl::KdTree< PointT >.

Definition at line 65 of file organized_data.h.

template<typename PointT >
typedef KdTree<PointT>::PointCloud pcl::OrganizedDataIndex< PointT >::PointCloud [private]

Reimplemented from pcl::KdTree< PointT >.

Definition at line 59 of file organized_data.h.

template<typename PointT >
typedef KdTree<PointT>::PointCloudConstPtr pcl::OrganizedDataIndex< PointT >::PointCloudConstPtr [private]

Reimplemented from pcl::KdTree< PointT >.

Definition at line 60 of file organized_data.h.

template<typename PointT >
typedef boost::shared_ptr<OrganizedDataIndex<PointT> > pcl::OrganizedDataIndex< PointT >::Ptr

Reimplemented from pcl::KdTree< PointT >.

Definition at line 64 of file organized_data.h.


Constructor & Destructor Documentation

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

Empty constructor for OrganizedDataIndex. Sets some internal values to their defaults.

Definition at line 68 of file organized_data.h.


Member Function Documentation

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::getHorizontalSearchWindow (  )  const [inline]

Get the horizontal search window in pixels.

Definition at line 157 of file organized_data.h.

template<typename PointT >
float pcl::OrganizedDataIndex< PointT >::getMaxDistance (  )  const [inline]

Get the maximum allowed distance between the query point and its k-nearest neighbors.

Definition at line 167 of file organized_data.h.

template<typename PointT >
virtual std::string pcl::OrganizedDataIndex< PointT >::getName (  )  const [inline, private, virtual]

Class getName method.

Implements pcl::KdTree< PointT >.

Definition at line 172 of file organized_data.h.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::getVerticalSearchWindow (  )  const [inline]

Get the vertical search window in pixels.

Definition at line 160 of file organized_data.h.

template<typename PointT >
Ptr pcl::OrganizedDataIndex< PointT >::makeShared (  )  const [inline]

Definition at line 70 of file organized_data.h.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::nearestKSearch ( int  index,
int  k,
std::vector< int > &  k_indices,
std::vector< float > &  k_distances 
) [inline, virtual]

Search for k-nearest neighbors for the given query point.

Parameters:
index the index representing the query point
k the number of neighbors to search for (not used)
k_indices the resultant point indices (must be resized to k beforehand!)
k_distances 
Note:
this function does not return distances

Implements pcl::KdTree< PointT >.

Definition at line 129 of file organized_data.h.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::nearestKSearch ( const PointCloud cloud,
int  index,
int  k,
std::vector< int > &  k_indices,
std::vector< float > &  k_distances 
) [inline, virtual]

Search for k-nearest neighbors for the given query point.

Parameters:
cloud the point cloud data
index the index in cloud representing the query point
k the number of neighbors to search for (not used)
k_indices the resultant point indices (must be resized to k beforehand!)
k_distances 
Note:
this function does not return distances

Implements pcl::KdTree< PointT >.

Definition at line 115 of file organized_data.hpp.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::nearestKSearch ( const PointT &  p_q,
int  k,
std::vector< int > &  k_indices,
std::vector< float > &  k_sqr_distances 
) [inline, virtual]

Search for k-nearest neighbors for the given query point.

Parameters:
point the given query point
k the number of neighbors to search for
k_indices the resultant indices of the neighboring points (must be resized to k a priori!)
k_sqr_distances the resultant squared distances to the neighboring points (must be resized to k a priori!)
Returns:
number of neighbors found

Implements pcl::KdTree< PointT >.

Definition at line 73 of file organized_data.h.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::radiusSearch ( int  index,
double  radius,
std::vector< int > &  k_indices,
std::vector< float > &  k_distances,
int  max_nn = INT_MAX 
) const [inline, virtual]

Approximate search for neighbors around the point from the given index within radius.

Parameters:
index the index in cloud representing the query point.
radius the maximum distance to search for neighbors in.
k_indices the resultant point indices
k_distances the resultant !squared! point distances
max_nn maximum number of points to return

Implements pcl::KdTree< PointT >.

Definition at line 102 of file organized_data.h.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::radiusSearch ( const PointCloud cloud,
int  index,
double  radius,
std::vector< int > &  k_indices,
std::vector< float > &  k_distances,
int  max_nn = INT_MAX 
) const [inline, virtual]

Approximate search for neighbors around the given query point within radius.

Parameters:
cloud the point cloud data.
index the index in cloud representing the query point.
radius the maximum distance to search for neighbors in.
k_indices the resultant point indices
k_distances the resultant !squared! point distances
max_nn maximum number of points to return

Implements pcl::KdTree< PointT >.

Definition at line 46 of file organized_data.hpp.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::radiusSearch ( const PointT &  p_q,
double  radius,
std::vector< int > &  k_indices,
std::vector< float > &  k_sqr_distances,
int  max_nn = INT_MAX 
) const [inline, virtual]

Search for all the nearest neighbors of the query point in a given radius.

Parameters:
point the given query point
radius the radius of the sphere bounding all of p_q's neighbors
k_indices the resultant indices of the neighboring points
k_sqr_distances the resultant squared distances to the neighboring points
max_nn if given, bounds the maximum returned neighbors to this value
Returns:
number of neighbors found in radius

Implements pcl::KdTree< PointT >.

Definition at line 77 of file organized_data.h.

template<typename PointT >
void pcl::OrganizedDataIndex< PointT >::setMaxDistance ( float  max_dist  )  [inline]

Set the maximum allowed distance between the query point and its k-nearest neighbors.

Definition at line 163 of file organized_data.h.

template<typename PointT >
void pcl::OrganizedDataIndex< PointT >::setSearchWindow ( int  horizontal,
int  vertical 
) [inline]

Set the search window (horizontal, vertical) in pixels.

Parameters:
horizontal the horizontal window
vertical the vertical window

Definition at line 145 of file organized_data.h.

template<typename PointT >
void pcl::OrganizedDataIndex< PointT >::setSearchWindowAsK ( int  k  )  [inline]

Estimate the search window (horizontal, vertical) in pixels in order to get up to k-neighbors.

Parameters:
k the number of neighbors requested

Definition at line 174 of file organized_data.hpp.


Member Data Documentation

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::horizontal_window_ [private]

The horizontal search window.

Definition at line 178 of file organized_data.h.

template<typename PointT >
float pcl::OrganizedDataIndex< PointT >::max_distance_ [private]

Maximum allowed distance between the query point and its k-neighbors.

Definition at line 175 of file organized_data.h.

template<typename PointT >
int pcl::OrganizedDataIndex< PointT >::vertical_window_ [private]

The horizontal search window.

Definition at line 181 of file organized_data.h.


The documentation for this class was generated from the following files:
 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:19 2013