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

#include <rcf_set.h>

Public Member Functions

 RetrievalCoefficientFileSet (const std::string)
 
std::vector
< RetrievalCoefficientFile
getRCFVector ()
 
RetrievalCoefficientFile getRCFbyId (std::string RCFId)
 
bool setFlightLevelsKm (float[], int)
 
RC_Set_4Retrieval getBestWeightedRCSet (std::vector< float >, float, float)
 

Detailed Description

This class encapsulates the whole set of RCFs for a project and provides a method for determining which of the RCFs is the best match of a given set of brightness temperatures (scan) taken at a particular elevation.

A set of Retrieval Coefficient 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.

When the MTP instrument completes a scan of the atmosphere the scan counts are converted to Brightness Temperatures, using these the "best match" RCF is found and it's corresponding Retrieval Coefficients are used to determine the atmospheric temperature profile.

Definition at line 41 of file rcf_set.h.

Constructor & Destructor Documentation

RetrievalCoefficientFileSet::RetrievalCoefficientFileSet ( const std::string  )

Constructor

Parameters
std::stringis directory name containing the RCF files to be pulled into the set.

Definition at line 13 of file rcf_set.cc.

Member Function Documentation

RC_Set_4Retrieval RetrievalCoefficientFileSet::getBestWeightedRCSet ( std::vector< float >  ScanBrightnessTemps,
float  PAltKm,
float  BTBias 
)

Get the Retrieval Coefficient Set from the "best" template weighted according to the flight level of the aircraft and given a set of Scan Brightness Temperatures

Parameters
[in]isan array of Scan Brightness Temperatures and is expected to be NUM_OBSVBLSs in length. It is also expected that channel 1 will be in array elements 0-9 with element 0 being the highest scan angle and element 9 is the lowest scan angle. Similarly, channel 2 will be found in elements 10-19 and channel 3 will be in elements 20-29.
[in]isthe altitude of the aircraft in km at the time that the Scan was taken. [in] is an Brightness Temperature Bias provided by user
Returns
is the weighted average set of Model Brightness Temperatures, RMS values, and Retrieval Coefficients from the template that best matches the input Scan Brightness Temperatures as observed from the input flight altitude.

Definition at line 77 of file rcf_set.cc.

RetrievalCoefficientFile RetrievalCoefficientFileSet::getRCFbyId ( std::string  RCFId)

Definition at line 39 of file rcf_set.cc.

std::vector<RetrievalCoefficientFile> RetrievalCoefficientFileSet::getRCFVector ( )
inline

Get functions

Definition at line 57 of file rcf_set.h.

bool RetrievalCoefficientFileSet::setFlightLevelsKm ( float  FlightLevels[],
int  NumFlightLevels 
)

Set the Flight Levels in KM.

Parameters
[in]isan array of floating point values indicating the km above sea level of each flight level in each retrieval coefficient file.
[in]isthe size fo the vector Flight levels should be ordered in decreasing altitude.
Returns
true if levels successfully set, false if not. Assumes that all RCFs in the set have the same flight levels - historically that has been the case, but it may not have to be.

Definition at line 52 of file rcf_set.cc.


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