RandomSample applies a random sampling with uniform probability. More...

#include <pcl/filters/random_sample.h>

Inheritance diagram for pcl::RandomSample< PointT >:

Collaboration diagram for pcl::RandomSample< PointT >:

Public Types
typedef boost::shared_ptr < Filter< PointT > >	Ptr
typedef boost::shared_ptr < const Filter< PointT > >	ConstPtr
typedef PointIndices::Ptr	PointIndicesPtr
typedef PointIndices::ConstPtr	PointIndicesConstPtr
Public Member Functions
	RandomSample ()
	Empty constructor.
void	setSample (unsigned int sample)
	Set number of indices to be sampled.
unsigned int	getSample ()
	Get the value of the internal sample parameter.
void	setSeed (unsigned int seed)
	Set seed of random function.
unsigned int	getSeed ()
	Get the value of the internal seed parameter.
virtual void	filter (PointCloud &output)
	Calls the filtering method and returns the filtered dataset in output.
void	filter (std::vector< int > &indices)
	Calls the filtering method and returns the filtered point cloud indices.
IndicesConstPtr const	getRemovedIndices ()
	Get the point indices being removed.
virtual void	setInputCloud (const PointCloudConstPtr &cloud)
	Provide a pointer to the input dataset.
PointCloudConstPtr const	getInputCloud ()
	Get a pointer to the input point cloud dataset.
void	setIndices (const IndicesPtr &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.
void	setIndices (const PointIndicesConstPtr &indices)
	Provide a pointer to the vector of indices that represents the input data.
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.
IndicesPtr const	getIndices ()
	Get a pointer to the vector of indices used.
const PointT &	operator[] (size_t pos)
	Override PointCloud operator[] to shorten code.
Public Attributes
unsigned int	sample_
	Number of indices that will be returned.
unsigned int	seed_
	Random number seed.

Detailed Description

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

RandomSample applies a random sampling with uniform probability.

Based off http://www.keithschwarz.com/interesting/code/?dir=random-sample Runs in O(n)

Author:: Justin Rosen

Definition at line 54 of file random_sample.h.

Member Typedef Documentation

template<typename PointT>

typedef boost::shared_ptr< const Filter<PointT> > pcl::Filter< PointT >::ConstPtr [inherited]

Definition at line 76 of file filter.h.

template<typename PointT>

typedef PointIndices::ConstPtr pcl::PCLBase< PointT >::PointIndicesConstPtr [inherited]

Reimplemented in pcl::EuclideanClusterExtraction< PointT >, pcl::ExtractPolygonalPrismData< PointT >, pcl::SegmentDifferences< PointT >, pcl::LabeledEuclideanClusterExtraction< PointT >, pcl::SampleConsensusInitialAlignment< PointSource, PointTarget, FeatureT >, and pcl::PCA< PointT >.

Definition at line 81 of file pcl_base.h.

template<typename PointT>

typedef PointIndices::Ptr pcl::PCLBase< PointT >::PointIndicesPtr [inherited]

Reimplemented in pcl::EuclideanClusterExtraction< PointT >, pcl::ExtractPolygonalPrismData< PointT >, pcl::SegmentDifferences< PointT >, pcl::LabeledEuclideanClusterExtraction< PointT >, pcl::SampleConsensusInitialAlignment< PointSource, PointTarget, FeatureT >, and pcl::PCA< PointT >.

Definition at line 80 of file pcl_base.h.

template<typename PointT>

typedef boost::shared_ptr< Filter<PointT> > pcl::Filter< PointT >::Ptr [inherited]

Definition at line 75 of file filter.h.

Constructor & Destructor Documentation

template<typename PointT >

pcl::RandomSample< PointT >::RandomSample ( ) [inline]

Empty constructor.

Definition at line 67 of file random_sample.h.

Member Function Documentation

template<typename PointT>

virtual void pcl::FilterIndices< PointT >::filter ( PointCloud & output ) [inline, virtual, inherited]

Calls the filtering method and returns the filtered dataset in output.

Parameters:

[out] output the resultant filtered point cloud dataset

Reimplemented from pcl::Filter< PointT >.

Definition at line 73 of file filter_indices.h.

template<typename PointT>

void pcl::FilterIndices< PointT >::filter ( std::vector< int > & indices ) [inline, inherited]

Calls the filtering method and returns the filtered point cloud indices.

Parameters:

indices the resultant filtered point cloud indices

Definition at line 83 of file filter_indices.h.

template<typename PointT>

IndicesPtr const pcl::PCLBase< PointT >::getIndices ( ) [inline, inherited]

Get a pointer to the vector of indices used.

Definition at line 192 of file pcl_base.h.

template<typename PointT>

PointCloudConstPtr const pcl::PCLBase< PointT >::getInputCloud ( ) [inline, inherited]

Get a pointer to the input point cloud dataset.

Definition at line 109 of file pcl_base.h.

template<typename PointT>

IndicesConstPtr const pcl::Filter< PointT >::getRemovedIndices ( ) [inline, inherited]

Get the point indices being removed.

Definition at line 93 of file filter.h.

template<typename PointT >

unsigned int pcl::RandomSample< PointT >::getSample ( ) [inline]

Get the value of the internal sample parameter.

Definition at line 84 of file random_sample.h.

template<typename PointT >

unsigned int pcl::RandomSample< PointT >::getSeed ( ) [inline]

Get the value of the internal seed parameter.

Definition at line 101 of file random_sample.h.

template<typename PointT>

const PointT& pcl::PCLBase< PointT >::operator[] ( size_t pos ) [inline, inherited]

Override PointCloud operator[] to shorten code.

Note:: this method can be called instead of (*input_)[(*indices_)[pos]] or input_->points[(*indices_)[pos]]

Parameters:

pos	position in indices_ vector

Definition at line 199 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices ( const IndicesPtr & indices ) [inline, inherited]

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 115 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices ( const IndicesConstPtr & indices ) [inline, inherited]

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 126 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices ( const PointIndicesConstPtr & indices ) [inline, inherited]

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 137 of file pcl_base.h.

template<typename PointT>

void pcl::PCLBase< PointT >::setIndices	(	size_t	row_start,
		size_t	col_start,
		size_t	nb_rows,
		size_t	nb_cols
	)		`[inline, inherited]`

Set the indices for the points laying within an interest region of the point cloud.

Note:: you shouldn't call this method on unorganized point clouds!

Parameters:

row_start	the offset on rows
col_start	the offset on columns
nb_rows	the number of rows to be considered row_start included
nb_cols	the number of columns to be considered col_start included

Definition at line 153 of file pcl_base.h.

template<typename PointT>

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

Provide a pointer to the input dataset.

Parameters:

cloud the const boost shared pointer to a PointCloud message

Reimplemented in pcl::PCA< PointT >, and pcl::GeneralizedIterativeClosestPoint< PointT, PointT >.

Definition at line 105 of file pcl_base.h.

template<typename PointT >

void pcl::RandomSample< PointT >::setSample ( unsigned int sample ) [inline]

Set number of indices to be sampled.

Parameters:

sample

Definition at line 76 of file random_sample.h.

template<typename PointT >

void pcl::RandomSample< PointT >::setSeed ( unsigned int seed ) [inline]

Set seed of random function.

Parameters:

seed

Definition at line 93 of file random_sample.h.

Member Data Documentation

template<typename PointT >

unsigned int pcl::RandomSample< PointT >::sample_

Number of indices that will be returned.

Definition at line 107 of file random_sample.h.

template<typename PointT >

unsigned int pcl::RandomSample< PointT >::seed_

Random number seed.

Definition at line 109 of file random_sample.h.

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

/builddir/build/BUILD/PCL-1.4.0-Source/filters/include/pcl/filters/random_sample.h
/builddir/build/BUILD/PCL-1.4.0-Source/filters/include/pcl/filters/impl/random_sample.hpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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