RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData Class Reference

Public Member Functions
def	__init__ (self)
def	CalibrationID (self)
def	HasCompressionData (self)
def	HasCalibrationData (self)
def	FileHeaderVersioned (cls)
def	Clear (self)
def	GetAmplitudeCalibration (self, nIndexMHz)
def	GetCompressionAmplitude (self, nIndexMHz)
def	NormalizeDataIterating (self, arrAmplitudeData)
def	NormalizeAmplitudeCalibrationDataIterating (self)
def	NormalizeCompressionData (self)
def	NormalizeDataCopy (self)
def	LoadFile (self, sFilename)

Public Attributes
	m_arrAmplitudeCalibrationDataDB
	m_arrCompressionDataDBM
	m_bHasCompressionData
	lm_bHasCalibrationData
	m_sCalibrationID
	m_bHasCalibrationData

Static Public Attributes
int	CONST_MAX_ENTRY_DATA = 6101
int	CONST_MIN_ENTRY_DATA = 0
int	CONST_INVALID_DATA = -1E10
float	CONST_DEFAULT_COMPRESSION = -10.0
float	CONST_DEFAULT_AMPLITUDE_CORRECTION = 0.0

Detailed Description

Class support a single collection of calibration amplitude values, of 1 MHz steps
Positive values will be used to externally add to the measurement, that means imply correcting attenuation
whereas negative values will be to externally substract to the measurement, implying correcting gain. 

Constructor & Destructor Documentation

__init__()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.__init__

(

self

)

Member Function Documentation

CalibrationID()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.CalibrationID

(

self

)

Calibration ID is usually a filename to name the calibration in use
future versions may support different IDs than a filename

Clear()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.Clear

(

self

)

Initialize all collection of calibration amplitude values 

FileHeaderVersioned()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.FileHeaderVersioned

(

cls

)

File header version to control an unknown format

Returns:
    String File header version

GetAmplitudeCalibration()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.GetAmplitudeCalibration	(		self,
			nIndexMHz
	)

Amplitude correction data for each MHZ entry

Parameters:
    nIndexMHz -- Frequency reference in MHZ to get correction data from
Returns:
    Float Correction amplitude value in dB

GetCompressionAmplitude()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.GetCompressionAmplitude	(		self,
			nIndexMHz
	)

Amplitude compression data for each MHZ entry

Parameters: 
    nIndexMHz -- Frequency reference in MHZ to get compression amplitude data from
Returns:
    Float Compression amplitude value in dB

HasCalibrationData()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.HasCalibrationData

(

self

)

Will return true if there is loaded valid calibration data

HasCompressionData()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.HasCompressionData

(

self

)

Returns true if data stored include compression amplitude for overload check

LoadFile()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.LoadFile	(		self,
			sFilename
	)

Load a file with amplitude and optionally compression data 

Parameters:
    sFilename -- Full path of the filename
Returns:
    Boolean True if everything ok, False if data was invalid

NormalizeAmplitudeCalibrationDataIterating()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.NormalizeAmplitudeCalibrationDataIterating

(

self

)

It will iterate to all values and will fill in anything that is not initialized with a valid value
 As oposed to NormalizeDataCopy, it will look for valid values and will fill it in with intermediate
 calculated values in between these two. If no valid value is found among two (i.e. last value or first value)
 then it is filled in using NormalizedDataCopy.

NormalizeCompressionData()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.NormalizeCompressionData

(

self

)

This function will make sure the compression data has start/end points even if not specified in the file

NormalizeDataCopy()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.NormalizeDataCopy

(

self

)

It will iterate to all values and will fill in anything that is not initialized with a valid value
It uses a copy method, not an incremental method (i.e. it will pick the first valid value and 
go copying the same value over and over till it find another valid one. See NormalizeDataPredict for alternative

NormalizeDataIterating()

def RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.NormalizeDataIterating	(		self,
			arrAmplitudeData
	)

Utility function to be used by both arrays, when needed

Parameters:
    arrAmplitudeData -- Collection of amplitude calibration data
Returns:
    List  Collection of amplitude calibration data   

Member Data Documentation

CONST_DEFAULT_AMPLITUDE_CORRECTION

float RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.CONST_DEFAULT_AMPLITUDE_CORRECTION = 0.0

static

CONST_DEFAULT_COMPRESSION

float RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.CONST_DEFAULT_COMPRESSION = -10.0

static

CONST_INVALID_DATA

int RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.CONST_INVALID_DATA = -1E10

static

CONST_MAX_ENTRY_DATA

int RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.CONST_MAX_ENTRY_DATA = 6101

static

CONST_MIN_ENTRY_DATA

int RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.CONST_MIN_ENTRY_DATA = 0

static

lm_bHasCalibrationData

RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.lm_bHasCalibrationData

m_arrAmplitudeCalibrationDataDB

RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.m_arrAmplitudeCalibrationDataDB

m_arrCompressionDataDBM

RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.m_arrCompressionDataDBM

m_bHasCalibrationData

RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.m_bHasCalibrationData

m_bHasCompressionData

RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.m_bHasCompressionData

m_sCalibrationID

RFExplorer.RFEAmplitudeTableData.RFEAmplitudeTableData.m_sCalibrationID

---

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

• R:/git/linux/Python/deploy_pip/RFExplorer/RFExplorer/RFEAmplitudeTableData.py