ns3::SatChannelEstimationError Class Reference

SatChannelEstimatorError reads from file and stores the channel estimation error mean and standard deviation values for a set of SINR values. More...

#include "satellite-channel-estimation-error.h"

+ Inheritance diagram for ns3::SatChannelEstimationError:
+ Collaboration diagram for ns3::SatChannelEstimationError:

Public Member Functions

 SatChannelEstimationError ()
 Default constructor. More...
 
 SatChannelEstimationError (std::string filePathName)
 Constructor. More...
 
virtual ~SatChannelEstimationError ()
 Destructor for SatChannelEstimationError. More...
 
double AddError (double sinrInDb) const
 Add channel estimation error to SINR. More...
 
virtual void DoDispose ()
 Dispose of this class instance. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 inherited from Object More...
 

Private Member Functions

void ReadFile (std::string filePathName)
 Read the distribution mean and STD values from file. More...
 

Private Attributes

uint32_t m_lastSampleIndex
 Last sample index of the containers. More...
 
std::vector< double > m_mueCesDb
 Mean values. More...
 
Ptr< NormalRandomVariable > m_normalRandomVariable
 Normal random variable used to calculate the channel estimation error. More...
 
std::vector< double > m_sinrsDb
 SINR values. More...
 
std::vector< double > m_stdCesDb
 Standard deviation values. More...
 

Detailed Description

SatChannelEstimatorError reads from file and stores the channel estimation error mean and standard deviation values for a set of SINR values.

Channel estimation error mean and standard deviation is dependent on calculated SINR. A proper error for a given SINR is interpolated between two closest SINR points. The channel estimation error is added to a given measurement by using the AddError method.

Definition at line 39 of file satellite-channel-estimation-error.h.

Constructor & Destructor Documentation

◆ SatChannelEstimationError() [1/2]

ns3::SatChannelEstimationError::SatChannelEstimationError ( )

Default constructor.

Definition at line 37 of file satellite-channel-estimation-error.cc.

References m_normalRandomVariable.

◆ SatChannelEstimationError() [2/2]

ns3::SatChannelEstimationError::SatChannelEstimationError ( std::string  filePathName)

Constructor.

Parameters
filePathNameA file containing the gaussian gaussian distribution mean and STD.

Definition at line 47 of file satellite-channel-estimation-error.cc.

References m_normalRandomVariable, and ReadFile().

+ Here is the call graph for this function:

◆ ~SatChannelEstimationError()

ns3::SatChannelEstimationError::~SatChannelEstimationError ( )
virtual

Destructor for SatChannelEstimationError.

Definition at line 58 of file satellite-channel-estimation-error.cc.

Member Function Documentation

◆ AddError()

double ns3::SatChannelEstimationError::AddError ( double  sinrInDb) const

Add channel estimation error to SINR.

Parameters
sinrInDbMeasured SINR in dB
Returns
SINR including channel estimation error in dB

Interpolate the proper mean and std values

Definition at line 127 of file satellite-channel-estimation-error.cc.

References ns3::SatUtils::Interpolate(), m_lastSampleIndex, m_mueCesDb, m_normalRandomVariable, m_sinrsDb, and m_stdCesDb.

+ Here is the call graph for this function:

◆ DoDispose()

void ns3::SatChannelEstimationError::DoDispose ( void  )
virtual

Dispose of this class instance.

Definition at line 72 of file satellite-channel-estimation-error.cc.

References m_normalRandomVariable.

◆ GetTypeId()

TypeId ns3::SatChannelEstimationError::GetTypeId ( void  )
static

inherited from Object

Definition at line 63 of file satellite-channel-estimation-error.cc.

◆ ReadFile()

void ns3::SatChannelEstimationError::ReadFile ( std::string  filePathName)
private

Read the distribution mean and STD values from file.

Parameters
filePathNameFile name

Definition at line 81 of file satellite-channel-estimation-error.cc.

References m_lastSampleIndex, m_mueCesDb, m_sinrsDb, and m_stdCesDb.

Referenced by SatChannelEstimationError().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_lastSampleIndex

uint32_t ns3::SatChannelEstimationError::m_lastSampleIndex
private

Last sample index of the containers.

Definition at line 86 of file satellite-channel-estimation-error.h.

Referenced by AddError(), and ReadFile().

◆ m_mueCesDb

std::vector<double> ns3::SatChannelEstimationError::m_mueCesDb
private

Mean values.

Definition at line 102 of file satellite-channel-estimation-error.h.

Referenced by AddError(), and ReadFile().

◆ m_normalRandomVariable

Ptr<NormalRandomVariable> ns3::SatChannelEstimationError::m_normalRandomVariable
private

Normal random variable used to calculate the channel estimation error.

Definition at line 92 of file satellite-channel-estimation-error.h.

Referenced by SatChannelEstimationError(), AddError(), and DoDispose().

◆ m_sinrsDb

std::vector<double> ns3::SatChannelEstimationError::m_sinrsDb
private

SINR values.

Definition at line 97 of file satellite-channel-estimation-error.h.

Referenced by AddError(), and ReadFile().

◆ m_stdCesDb

std::vector<double> ns3::SatChannelEstimationError::m_stdCesDb
private

Standard deviation values.

Definition at line 107 of file satellite-channel-estimation-error.h.

Referenced by AddError(), and ReadFile().


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