Point Cloud Library (PCL)  1.9.1-dev
List of all members | Classes | Public Types | Public Member Functions | Public Attributes
pcl::common::NormalGenerator< T > Class Template Reference

NormalGenerator class generates a random number from a normal distribution specified by (mean, sigma). More...

#include <pcl/common/random.h>

Classes

struct  Parameters
 

Public Types

typedef boost::mt19937 EngineType
 
typedef normal_distribution< T >::type DistributionType
 

Public Member Functions

 NormalGenerator (T mean=0, T sigma=1, pcl::uint32_t seed=-1)
 Constructor. More...
 
 NormalGenerator (const Parameters &parameters)
 Constructor. More...
 
void setSeed (pcl::uint32_t seed)
 Change seed value. More...
 
void setParameters (T mean, T sigma, pcl::uint32_t seed=-1)
 Set the normal number generator parameters. More...
 
void setParameters (const Parameters &parameters)
 Set generator parameters. More...
 
const ParametersgetParameters ()
 
run ()
 

Public Attributes

Parameters parameters_
 parameters More...
 
DistributionType distribution_
 normal distribution More...
 
EngineType rng_
 random number generator More...
 
boost::variate_generator< EngineType &, DistributionTypegenerator_
 generator of random number from a normal distribution More...
 

Detailed Description

template<typename T>
class pcl::common::NormalGenerator< T >

NormalGenerator class generates a random number from a normal distribution specified by (mean, sigma).

Author
Nizar Sallem

Definition at line 160 of file random.h.

Member Typedef Documentation

template<typename T >
typedef normal_distribution<T>::type pcl::common::NormalGenerator< T >::DistributionType

Definition at line 217 of file random.h.

template<typename T >
typedef boost::mt19937 pcl::common::NormalGenerator< T >::EngineType

Definition at line 216 of file random.h.

Constructor & Destructor Documentation

template<typename T >
pcl::common::NormalGenerator< T >::NormalGenerator ( mean = 0,
sigma = 1,
pcl::uint32_t  seed = -1 
)

Constructor.

Parameters
[in]meannormal mean
[in]sigmanormal variation
[in]seedseeding value

Definition at line 121 of file random.hpp.

References pcl::common::NormalGenerator< T >::parameters_, pcl::common::NormalGenerator< T >::rng_, and pcl::common::NormalGenerator< T >::Parameters::seed.

template<typename T >
pcl::common::NormalGenerator< T >::NormalGenerator ( const Parameters parameters)

Constructor.

Parameters
parametersnormal distribution parameters and seed

Definition at line 133 of file random.hpp.

References pcl::common::NormalGenerator< T >::parameters_, pcl::common::NormalGenerator< T >::rng_, and pcl::common::NormalGenerator< T >::Parameters::seed.

Member Function Documentation

template<typename T >
const Parameters& pcl::common::NormalGenerator< T >::getParameters ( )
inline
Returns
normal distribution parameters and generator seed

Definition at line 210 of file random.h.

template<typename T >
T pcl::common::NormalGenerator< T >::run ( )
inline
Returns
a randomly generated number in the normal distribution (mean, sigma)

Definition at line 214 of file random.h.

template<typename T >
void pcl::common::NormalGenerator< T >::setParameters ( mean,
sigma,
pcl::uint32_t  seed = -1 
)

Set the normal number generator parameters.

Parameters
[in]meanmean of the normal distribution
[in]sigmastandard variation of the normal distribution
[in]seedrandom number generator seed (applied if != -1)

Definition at line 155 of file random.hpp.

References pcl::common::NormalGenerator< T >::distribution_, pcl::common::NormalGenerator< T >::generator_, pcl::common::NormalGenerator< T >::Parameters::mean, pcl::common::NormalGenerator< T >::parameters_, pcl::common::NormalGenerator< T >::rng_, pcl::common::NormalGenerator< T >::Parameters::seed, and pcl::common::NormalGenerator< T >::Parameters::sigma.

template<typename T >
void pcl::common::NormalGenerator< T >::setParameters ( const Parameters parameters)
template<typename T >
void pcl::common::NormalGenerator< T >::setSeed ( pcl::uint32_t  seed)

Change seed value.

Parameters
[in]seednew seed value

Definition at line 144 of file random.hpp.

References pcl::common::NormalGenerator< T >::parameters_, pcl::common::NormalGenerator< T >::rng_, and pcl::common::NormalGenerator< T >::Parameters::seed.

Member Data Documentation

template<typename T >
DistributionType pcl::common::NormalGenerator< T >::distribution_

normal distribution

Definition at line 221 of file random.h.

Referenced by pcl::common::NormalGenerator< T >::setParameters().

template<typename T >
boost::variate_generator<EngineType&, DistributionType > pcl::common::NormalGenerator< T >::generator_

generator of random number from a normal distribution

Definition at line 225 of file random.h.

Referenced by pcl::common::NormalGenerator< T >::setParameters().

template<typename T >
Parameters pcl::common::NormalGenerator< T >::parameters_
template<typename T >
EngineType pcl::common::NormalGenerator< T >::rng_

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