point_cloud_library / 1.12.1 / classpcl_1_1_random_sample_3_01pcl_1_1_p_c_l_point_cloud2_01_4.html /

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

#include <pcl/filters/random_sample.h>

Public Types

using Ptr = shared_ptr< RandomSample< pcl::PCLPointCloud2 > >
using ConstPtr = shared_ptr< const RandomSample< pcl::PCLPointCloud2 > >
- Public Types inherited from pcl::FilterIndices< pcl::PCLPointCloud2 >
using PCLPointCloud2 = pcl::PCLPointCloud2
- Public Types inherited from pcl::Filter< pcl::PCLPointCloud2 >
using Ptr = shared_ptr< Filter< pcl::PCLPointCloud2 > >
using ConstPtr = shared_ptr< const Filter< pcl::PCLPointCloud2 > >
using PCLPointCloud2 = pcl::PCLPointCloud2
using PCLPointCloud2Ptr = PCLPointCloud2::Ptr
using PCLPointCloud2ConstPtr = PCLPointCloud2::ConstPtr
- Public Types inherited from pcl::PCLBase< pcl::PCLPointCloud2 >
using PCLPointCloud2 = pcl::PCLPointCloud2
using PCLPointCloud2Ptr = PCLPointCloud2::Ptr
using PCLPointCloud2ConstPtr = PCLPointCloud2::ConstPtr
using PointIndicesPtr = PointIndices::Ptr
using PointIndicesConstPtr = PointIndices::ConstPtr

Public Member Functions

RandomSample ()
Empty constructor. More...
void setSample (unsigned int sample)
Set number of indices to be sampled. More...
unsigned int getSample ()
Get the value of the internal sample parameter. More...
void setSeed (unsigned int seed)
Set seed of random function. More...
unsigned int getSeed ()
Get the value of the internal seed parameter. More...
- Public Member Functions inherited from pcl::FilterIndices< pcl::PCLPointCloud2 >
FilterIndices (bool extract_removed_indices=false)
Constructor. More...
void filter (Indices &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 () const
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 () const
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< pcl::PCLPointCloud2 >
Filter (bool extract_removed_indices=false)
Empty constructor. More...
const IndicesConstPtr getRemovedIndices () const
Get the point indices being removed. More...
void getRemovedIndices (PointIndices &pi)
Get the point indices being removed. More...
void filter (PCLPointCloud2 &output)
Calls the filtering method and returns the filtered dataset in output. More...
- Public Member Functions inherited from pcl::PCLBase< pcl::PCLPointCloud2 >
PCLBase ()
Empty constructor. More...
virtual ~PCLBase ()=default
destructor. More...
void setInputCloud (const PCLPointCloud2ConstPtr &cloud)
Provide a pointer to the input dataset. More...
const PCLPointCloud2ConstPtr getInputCloud () const
Get a pointer to the input point cloud dataset. More...
void setIndices (const IndicesPtr &indices)
Provide a pointer to the vector of indices that represents the input data. More...
void setIndices (const PointIndicesConstPtr &indices)
Provide a pointer to the vector of indices that represents the input data. More...
const IndicesPtr getIndices () const
Get a pointer to the vector of indices used. More...

Protected Member Functions

void applyFilter (PCLPointCloud2 &output) override
Sample of point indices into a separate PointCloud. More...
void applyFilter (Indices &indices) override
Sample of point indices. More...
float unifRand ()
Return a random number fast using a LCG (Linear Congruential Generator) algorithm. More...
- Protected Member Functions inherited from pcl::Filter< pcl::PCLPointCloud2 >
const std::string & getClassName () const
Get a string representation of the name of this class. More...
- Protected Member Functions inherited from pcl::PCLBase< pcl::PCLPointCloud2 >
bool initCompute ()
bool deinitCompute ()

Protected Attributes

unsigned int sample_
Number of indices that will be returned. More...
unsigned int seed_
Random number seed. More...
- Protected Attributes inherited from pcl::FilterIndices< pcl::PCLPointCloud2 >
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< pcl::PCLPointCloud2 >
IndicesPtr removed_indices_
Indices of the points that are removed. More...
bool extract_removed_indices_
Set to true if we want to return the indices of the removed points. More...
std::string filter_name_
The filter name. More...
- Protected Attributes inherited from pcl::PCLBase< pcl::PCLPointCloud2 >
PCLPointCloud2ConstPtr 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...
std::vector< uindex_t > field_sizes_
The size of each individual field. More...
index_t x_idx_
The x-y-z fields indices. More...
index_t y_idx_
index_t z_idx_
std::string x_field_name_
The desired x-y-z field names. More...
std::string y_field_name_
std::string z_field_name_

Detailed Description

RandomSample applies a random sampling with uniform probability.

Author
Justin Rosen

Definition at line 148 of file random_sample.h.

Member Typedef Documentation

ConstPtr

Definition at line 160 of file random_sample.h.

Ptr

Definition at line 159 of file random_sample.h.

Constructor & Destructor Documentation

RandomSample()

Empty constructor.

Definition at line 163 of file random_sample.h.

Member Function Documentation

applyFilter() [1/2]

void pcl::RandomSample< pcl::PCLPointCloud2 >::applyFilter ( Indices & indices )
overrideprotectedvirtual

Sample of point indices.

Parameters
indices the resultant point cloud indices

Implements pcl::FilterIndices< pcl::PCLPointCloud2 >.

applyFilter() [2/2]

void pcl::RandomSample< pcl::PCLPointCloud2 >::applyFilter ( PCLPointCloud2 & output )
overrideprotectedvirtual

Sample of point indices into a separate PointCloud.

Parameters
output the resultant point cloud

Implements pcl::FilterIndices< pcl::PCLPointCloud2 >.

getSample()

unsigned int pcl::RandomSample< pcl::PCLPointCloud2 >::getSample ( )
inline

Get the value of the internal sample parameter.

Definition at line 180 of file random_sample.h.

getSeed()

unsigned int pcl::RandomSample< pcl::PCLPointCloud2 >::getSeed ( )
inline

Get the value of the internal seed parameter.

Definition at line 197 of file random_sample.h.

setSample()

void pcl::RandomSample< pcl::PCLPointCloud2 >::setSample ( unsigned int sample )
inline

Set number of indices to be sampled.

Parameters
sample

Definition at line 172 of file random_sample.h.

Referenced by pcl::outofcore::OutofcoreOctreeBaseNode::addPointCloud_and_genLOD().

setSeed()

void pcl::RandomSample< pcl::PCLPointCloud2 >::setSeed ( unsigned int seed )
inline

Set seed of random function.

Parameters
seed

Definition at line 189 of file random_sample.h.

unifRand()

float pcl::RandomSample< pcl::PCLPointCloud2 >::unifRand ( )
inlineprotected

Return a random number fast using a LCG (Linear Congruential Generator) algorithm.

See http://software.intel.com/en-us/articles/fast-random-number-generator-on-the-intel-pentiumr-4-processor/ for more information.

Definition at line 225 of file random_sample.h.

Member Data Documentation

sample_

unsigned int pcl::RandomSample< pcl::PCLPointCloud2 >::sample_
protected

Number of indices that will be returned.

Definition at line 205 of file random_sample.h.

seed_

unsigned int pcl::RandomSample< pcl::PCLPointCloud2 >::seed_
protected

Random number seed.

Definition at line 207 of file random_sample.h.


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

© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1_random_sample_3_01pcl_1_1_p_c_l_point_cloud2_01_4.html