itpp_sci  1.0.0
it++ based simulation framework for scicoslab, scilab and scipy
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
SIM::wgn_x Class Reference

complex value WGN generator source
Core function: SIM::wgn_x.generate()
More...

Inheritance diagram for SIM::wgn_x:
Inheritance graph
[legend]

Public Member Functions

 wgn_x ()
 
 ~wgn_x ()
 
void set_sigma (double s)
 
void set_mean (complexd m)
 
void set_output (complexd yout)
 
double get_sigma (void)
 
complexd get_mean (void)
 
complexd get_output (void)
 
cvec generate (const bvec &ce)
 

Public Attributes

complexd y0
 
double sigma
 
complexd mean
 

Static Public Attributes

static double normalize = 1.0 / (std::sqrt(2.0))
 

Detailed Description

complex value WGN generator source
Core function: SIM::wgn_x.generate()

Constructor & Destructor Documentation

SIM::wgn_x::wgn_x ( )
inline
SIM::wgn_x::~wgn_x ( )
inline

Member Function Documentation

cvec SIM::wgn_x::generate ( const bvec &  ce)

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

Parameters
ce- [bvec] - clock enable vector - sizeof(ce)=N
Returns
y - [cvec] - output vector - sizeof(y)=[N]
complexd SIM::wgn_x::get_mean ( void  )

get complex DC of a WGN

Returns
- [complex double] DC
complexd SIM::wgn_x::get_output ( void  )

get initial/idle output symbol

Returns
- [complex double] y0
double SIM::wgn_x::get_sigma ( void  )

get AC-RMS of a WGN

Returns
- [double] AC-RMS
void SIM::wgn_x::set_mean ( complexd  m)

set complex DC of a WGN

Parameters
[in]m- [complex double] DC
void SIM::wgn_x::set_output ( complexd  yout)

sets initial/idle output symbol

Parameters
[in]yout- [complex double] y0 = yout
void SIM::wgn_x::set_sigma ( double  s)

set AC- RMS of a WGN

Parameters
[in]s- [double] AC RMS

Member Data Documentation

complexd SIM::wgn_x::mean
double SIM::wgn_x::normalize = 1.0 / (std::sqrt(2.0))
static
double SIM::wgn_x::sigma
complexd SIM::wgn_x::y0

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