SIM::wgn Class Reference

real value WGN generator source
Core function: SIM::wgn.generate()
More...

Inheritance diagram for SIM::wgn:

Public Member Functions
	wgn ()
	~wgn ()
void	set_sigma (double s)
void	set_mean (double m)
void	set_output (double yout)
double	get_sigma (void)
double	get_mean (void)
double	get_output (void)
vec	generate (const bvec &ce)

Public Attributes
double	y0
double	sigma
double	mean

Detailed Description

real value WGN generator source
Core function: SIM::wgn.generate()

Constructor & Destructor Documentation

SIM::wgn::wgn ( )

inline

SIM::wgn::~wgn ( )

inline

Member Function Documentation

vec SIM::wgn::generate

(

const bvec &

ce

)

for active clock ticks ce[i] generate new sample of white noise

Parameters

ce	- [bvec] - clock enable vector - sizeof(ce)=N

Returns

y - [vec] - output vector - sizeof(y)=[N]

double SIM::wgn::get_mean

(

void

)

get DC of a WGN

Returns

- [double] DC

double SIM::wgn::get_output

(

void

)

get initial/idle output symbol

Returns

- [double] y0

double SIM::wgn::get_sigma

(

void

)

get AC-RMS of a WGN

Returns

- [double] AC-RMS

void SIM::wgn::set_mean

(

double

m

)

set DC of a WGN

Parameters

[in]

m

- [double] DC

void SIM::wgn::set_output

(

double

yout

)

sets initial/idle output symbol

Parameters

[in]

yout

- [double] y0 = yout

void SIM::wgn::set_sigma

(

double

s

)

set AC- RMS of a WGN

Parameters

[in]

s

- [double] AC RMS

Member Data Documentation

double SIM::wgn::mean

double SIM::wgn::sigma

double SIM::wgn::y0

---

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

• C:/jobs/vcc/itpp_sci/include/sim/sim_wgn.hpp
• C:/jobs/vcc/itpp_sci/sim_lib/code/sim_wgn.cpp