List of all members | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
atm::ParametricXMLProfileModel Class Reference

Molecular profile using a parametric model. More...

#include <ParametricXMLProfileModel.h>

Inheritance diagram for atm::ParametricXMLProfileModel:
Inheritance graph
[legend]

Public Member Functions

const atm::ProfileResultEvaluateDensityVsHeight () const
 Table of density as a function of height. More...
 
const atm::ProfileResultEvaluateDepthVsHeight () const
 Table of depth as a function of height. More...
 
const atm::ProfileResultEvaluateHeightVsDepth () const
 Table of height as a function of depth. More...
 
const atm::ProfileResultEvaluatePressureVsHeight () const
 Table of air pressure as a function of height. More...
 
virtual const ProfileResultEvaluateRefractionIndexVsHeight (const double wl) const
 Return a table of wavelength-independent refractive index vs. altitude. More...
 
const atm::ProfileResultEvaluateRefractionIndexVsHeight () const
 Tabl of refraction index as a function of height. More...
 
const atm::ProfileResultEvaluateTemperatureVsHeight () const
 Table of temperature as a function of height. More...
 
const ProfileResultEvaluateVaporPressureVsHeight () const
 Table of H2O vapor pressure as a function of height. More...
 
virtual double GetVerticalTimeOfFlight (const double height1, const double height2) const
 Evaluate light signal time-of-flight between two altitudes. More...
 
bool HasData () const
 True if a data source is for the given model. More...
 
void Init ()
 
 ParametricXMLProfileModel ()
 
virtual void SetUncertaintyBound (const double nSigma) const
 alter Model by nSigma standard deviations More...
 
virtual ~ParametricXMLProfileModel ()
 Destructor - should be virtual for base classes. More...
 

Protected Types

typedef std::map< double,
ProfileResult * > 
AltWLFunction
 

Protected Member Functions

void CleanRIVsWavelength () const
 Clean up refraction indices. Derived modules decide when to do this. More...
 
void ExtendProfilesTo100km () const
 

Protected Attributes

ProfileResultfTabHeightVsLogDepth = nullptr
 
ProfileResultfTabLogDensityVsHeight = nullptr
 
ProfileResultfTabLogDepthVsHeight = nullptr
 
ProfileResultfTabLogPressureVsHeight = nullptr
 
ProfileResultfTabLogVaporPressureVsHeight = nullptr
 
ProfileResultfTabRIVsHeight = nullptr
 
AltWLFunction fTabRIVsHeightAndWaveLength
 
ProfileResultfTabTemperatureVsHeight = nullptr
 

Private Member Functions

 REGISTER_MODEL (atm::VProfileModel,"ParametricXML", ParametricXMLProfileModel)
 

Detailed Description

Molecular profile using a parametric model.

  "atm/ParametricXMLProfileModel.h"

The data used in this model are stored in an XML file.

Author
Luis Prado Jr
T. Paul
Date
21 Sep 2003

Definition at line 33 of file ParametricXMLProfileModel.h.

Member Typedef Documentation

typedef std::map<double, ProfileResult*> atm::VProfileModel::AltWLFunction
protectedinherited

Definition at line 76 of file VProfileModel.h.

Constructor & Destructor Documentation

ParametricXMLProfileModel::ParametricXMLProfileModel ( )

Definition at line 36 of file ParametricXMLProfileModel.cc.

ParametricXMLProfileModel::~ParametricXMLProfileModel ( )
virtual

Destructor - should be virtual for base classes.

Definition at line 39 of file ParametricXMLProfileModel.cc.

Member Function Documentation

void atm::VProfileModel::CleanRIVsWavelength ( ) const
protectedinherited

Clean up refraction indices. Derived modules decide when to do this.

Definition at line 207 of file VProfileModel.cc.

References atm::VProfileModel::fTabRIVsHeightAndWaveLength.

Referenced by atm::GDASProfileModel::CheckForUpdates(), atm::RadiosondeDBProfileModel::CheckForUpdates(), and atm::VProfileModel::~VProfileModel().

const ProfileResult & ParametricXMLProfileModel::EvaluateDensityVsHeight ( ) const
virtual

Table of density as a function of height.

Implements atm::VProfileModel.

Definition at line 155 of file ParametricXMLProfileModel.cc.

References atm::VProfileModel::fTabLogDensityVsHeight.

const ProfileResult & ParametricXMLProfileModel::EvaluateDepthVsHeight ( ) const
virtual

Table of depth as a function of height.

Implements atm::VProfileModel.

Definition at line 161 of file ParametricXMLProfileModel.cc.

References atm::VProfileModel::fTabLogDepthVsHeight.

const ProfileResult & ParametricXMLProfileModel::EvaluateHeightVsDepth ( ) const
virtual

Table of height as a function of depth.

Implements atm::VProfileModel.

Definition at line 167 of file ParametricXMLProfileModel.cc.

References atm::VProfileModel::fTabHeightVsLogDepth.

const ProfileResult & ParametricXMLProfileModel::EvaluatePressureVsHeight ( ) const
virtual

Table of air pressure as a function of height.

Implements atm::VProfileModel.

Definition at line 137 of file ParametricXMLProfileModel.cc.

References atm::VProfileModel::fTabLogPressureVsHeight.

const ProfileResult & atm::VProfileModel::EvaluateRefractionIndexVsHeight ( const double  wl) const
virtualinherited
const ProfileResult & ParametricXMLProfileModel::EvaluateRefractionIndexVsHeight ( ) const
virtual

Tabl of refraction index as a function of height.

Reimplemented from atm::VProfileModel.

Definition at line 173 of file ParametricXMLProfileModel.cc.

References atm::VProfileModel::fTabRIVsHeight.

const ProfileResult & ParametricXMLProfileModel::EvaluateTemperatureVsHeight ( ) const
virtual

Table of temperature as a function of height.

Implements atm::VProfileModel.

Definition at line 149 of file ParametricXMLProfileModel.cc.

References atm::VProfileModel::fTabTemperatureVsHeight.

const ProfileResult & ParametricXMLProfileModel::EvaluateVaporPressureVsHeight ( ) const
virtual

Table of H2O vapor pressure as a function of height.

Implements atm::VProfileModel.

Definition at line 143 of file ParametricXMLProfileModel.cc.

References atm::VProfileModel::fTabLogVaporPressureVsHeight.

void atm::VProfileModel::ExtendProfilesTo100km ( ) const
protectedinherited
double atm::VProfileModel::GetVerticalTimeOfFlight ( const double  height1,
const double  height2 
) const
virtualinherited

Evaluate light signal time-of-flight between two altitudes.

Definition at line 116 of file VProfileModel.cc.

References utl::cm, utl::cm2, utl::g, utl::kRefractiveIndexSeaLevel, utl::kSpeedOfLight, utl::m, and max.

bool atm::ParametricXMLProfileModel::HasData ( ) const
inlinevirtual

True if a data source is for the given model.

This method is meant to be checked to determine whether the given model is able to find valid data to evaluate. Typically it will always be true for parametric models which rely on an XML file, and will be true or false for database-based models, depending on whether or not relevant data are found in the DB for the current detector time

Implements atm::VModel.

Definition at line 62 of file ParametricXMLProfileModel.h.

void ParametricXMLProfileModel::Init ( void  )
virtual
atm::ParametricXMLProfileModel::REGISTER_MODEL ( atm::VProfileModel  ,
"ParametricXML"  ,
ParametricXMLProfileModel   
)
private
void VModel::SetUncertaintyBound ( const double  nSigma) const
virtualinherited

alter Model by nSigma standard deviations

Reimplemented in atm::MeasuredDBMieModel, and atm::SuperMieModel.

Definition at line 11 of file VModel.cc.

References ERROR.

Member Data Documentation

ProfileResult* atm::VProfileModel::fTabHeightVsLogDepth = nullptr
protectedinherited
ProfileResult* atm::VProfileModel::fTabLogDensityVsHeight = nullptr
protectedinherited
ProfileResult* atm::VProfileModel::fTabLogDepthVsHeight = nullptr
protectedinherited
ProfileResult* atm::VProfileModel::fTabLogPressureVsHeight = nullptr
protectedinherited
ProfileResult* atm::VProfileModel::fTabLogVaporPressureVsHeight = nullptr
protectedinherited
ProfileResult* atm::VProfileModel::fTabRIVsHeight = nullptr
protectedinherited
AltWLFunction atm::VProfileModel::fTabRIVsHeightAndWaveLength
mutableprotectedinherited
ProfileResult* atm::VProfileModel::fTabTemperatureVsHeight = nullptr
protectedinherited

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

, generated on Tue Sep 26 2023.