MTP  1.0
 All Classes Files Functions Variables Macros Pages
Public Member Functions | List of all members
RetrievalCoefficientFile Class Reference

#include <rcf.h>

Public Member Functions

 RetrievalCoefficientFile (std::string)
 
 RetrievalCoefficientFile ()
 
std::string getId ()
 
std::string getFileName ()
 
RCF_HDR getRCF_HDR ()
 When using getRCF_HDR, be advised that char arrays have no endstring! More...
 
std::vector< RC_Set_1FLgetFL_RC_Vec ()
 
bool isValid ()
 
RC_Set_1FL getRCAvgWt (float)
 
bool setFlightLevelsKm (float[], int)
 

Detailed Description

This class provides for reading in an RCF, storing and providing access to its data.

Retrieval Coeeficient Files (RCFs) are currently written by the VB program RCCalc which takes RAOB data and converts it into Templates that describe what that RAOB profile would look like to the MTP instrument if the instrument was used to measure the atmosphere described by the profile.

Since the profile would appear differerntly to the MTP depending upon the altitude at which the instrument was performing the measurement, the RCF files have multiple flight levels containing expected brightness temperatures (observables), assocciated rms values and the retrieval coefficients that would allow one to convert from the brightness temperatures to the profile temperatures.

Definition at line 39 of file rcf.h.

Constructor & Destructor Documentation

RetrievalCoefficientFile::RetrievalCoefficientFile ( std::string  )
RetrievalCoefficientFile::RetrievalCoefficientFile ( )

Definition at line 153 of file rcf.cc.

Member Function Documentation

std::string RetrievalCoefficientFile::getFileName ( )
inline

Definition at line 47 of file rcf.h.

std::vector<RC_Set_1FL> RetrievalCoefficientFile::getFL_RC_Vec ( )
inline

Definition at line 51 of file rcf.h.

std::string RetrievalCoefficientFile::getId ( )
inline

Definition at line 46 of file rcf.h.

RC_Set_1FL RetrievalCoefficientFile::getRCAvgWt ( float  PAltKm)

Get the weighted average Retrieval Coefficient Set

Parameters
PAltKmpressure altitude in KM at which to weight the elements of the set: the observables and rmms vectors as well as the retrieval coefficient matrices from flight levels above and below PAltKm are averaged with a weight factor based on nearness of PAltkm to the pressure altitude of the flight level as described in the RCF header.

Definition at line 165 of file rcf.cc.

RCF_HDR RetrievalCoefficientFile::getRCF_HDR ( )
inline

When using getRCF_HDR, be advised that char arrays have no endstring!

Definition at line 48 of file rcf.h.

bool RetrievalCoefficientFile::isValid ( )

Definition at line 159 of file rcf.cc.

bool RetrievalCoefficientFile::setFlightLevelsKm ( float  FlightLevels[],
int  Len 
)

Set the Flight Levels in KM.

Parameters
isa vector of floating point values indicating the km above sea level of each flight level in the retrieval coefficient file. Flight levels should be ordered in decreasing altitude.
Returns
true if levels successfully set, false if not.

Definition at line 242 of file rcf.cc.


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