Point Cloud Library (PCL)  1.7.0
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>

List of all members.

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.
 NormalGenerator (const Parameters &parameters)
 Constructor.
void setSeed (pcl::uint32_t seed)
 Change seed value.
void setParameters (T mean, T sigma, pcl::uint32_t seed=-1)
 Set the normal number generator parameters.
void setParameters (const Parameters &parameters)
 Set generator parameters.
const ParametersgetParameters ()
run ()

Public Attributes

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

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 161 of file random.h.


Member Typedef Documentation

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

Definition at line 218 of file random.h.

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

Definition at line 217 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 211 of file random.h.

References pcl::common::NormalGenerator< T >::parameters_.

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

Definition at line 215 of file random.h.

References pcl::common::NormalGenerator< T >::generator_.

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.

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

Set generator parameters.

Parameters:
parametersnormal distribution parameters and seed

Definition at line 174 of file random.hpp.

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.


Member Data Documentation

normal distribution

Definition at line 222 of file random.h.

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

generator of random number from a normal distribution

Definition at line 226 of file random.h.

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

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

random number generator

Definition at line 224 of file random.h.

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


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