Base class for a Profile Model. More...

#include <VProfileModel.h>

Inheritance diagram for atm::VProfileModel:

Public Member Functions
virtual const ProfileResult &	EvaluateDensityVsHeight () const =0
	Return a table of air density vs. altitude. More...

virtual const ProfileResult &	EvaluateDepthVsHeight () const =0
	Return a table of vertical column depth vs. altitude. More...

virtual const ProfileResult &	EvaluateHeightVsDepth () const =0
	Return a table of altitude vs atmospheric column depth. More...

virtual const ProfileResult &	EvaluatePressureVsHeight () const =0
	Return a table of air pressure vs. altitude. More...

virtual const ProfileResult &	EvaluateRefractionIndexVsHeight () const
	Return a table of wavelength-independent refractive index vs. altitude. More...

virtual const ProfileResult &	EvaluateRefractionIndexVsHeight (const double wl) const
	Return a table of wavelength-independent refractive index vs. altitude. More...

virtual const ProfileResult &	EvaluateTemperatureVsHeight () const =0
	Return a table of air temperature vs. altitude. More...

virtual const ProfileResult &	EvaluateVaporPressureVsHeight () const =0
	Return a table of H2O vapor pressure vs. altitude. More...

virtual double	GetVerticalTimeOfFlight (const double height1, const double height2) const
	Evaluate light signal time-of-flight between two altitudes. More...

virtual bool	HasData () const =0
	True if a data source is for the given model. More...

virtual void	Init ()=0

virtual void	SetUncertaintyBound (const double nSigma) const
	alter Model by nSigma standard deviations More...

	VProfileModel ()

virtual	~VProfileModel ()

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
ProfileResult *	fTabHeightVsLogDepth = nullptr

ProfileResult *	fTabLogDensityVsHeight = nullptr

ProfileResult *	fTabLogDepthVsHeight = nullptr

ProfileResult *	fTabLogPressureVsHeight = nullptr

ProfileResult *	fTabLogVaporPressureVsHeight = nullptr

ProfileResult *	fTabRIVsHeight = nullptr

AltWLFunction	fTabRIVsHeightAndWaveLength

ProfileResult *	fTabTemperatureVsHeight = nullptr

Detailed Description

Base class for a Profile Model.

Important note: that whenever "height" or "altitude" is invoked, this means height over the "sea level", i.e. height above the WGS84 ellipsoid (or the height of the UTM coordinate).

Author: Luis Prado Jr

Date: 21 Sep 2003

Definition at line 26 of file VProfileModel.h.

Member Typedef Documentation

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

protected

Definition at line 76 of file VProfileModel.h.

Constructor & Destructor Documentation

atm::VProfileModel::VProfileModel ( )

Definition at line 34 of file VProfileModel.cc.

atm::VProfileModel::~VProfileModel ( )

virtual

Definition at line 45 of file VProfileModel.cc.

References CleanRIVsWavelength(), fTabHeightVsLogDepth, fTabLogDensityVsHeight, fTabLogDepthVsHeight, fTabLogPressureVsHeight, fTabLogVaporPressureVsHeight, fTabRIVsHeight, and fTabTemperatureVsHeight.

Member Function Documentation

void atm::VProfileModel::CleanRIVsWavelength ( ) const

protected

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

Definition at line 207 of file VProfileModel.cc.

References fTabRIVsHeightAndWaveLength.

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

virtual const ProfileResult& atm::VProfileModel::EvaluateDensityVsHeight ( ) const

pure virtual

Return a table of air density vs. altitude.

Implemented in atm::SimShowerProfileModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, and atm::USStdADBProfileModel.

virtual const ProfileResult& atm::VProfileModel::EvaluateDepthVsHeight ( ) const

pure virtual

Return a table of vertical column depth vs. altitude.

Implemented in atm::SimShowerProfileModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, and atm::USStdADBProfileModel.

virtual const ProfileResult& atm::VProfileModel::EvaluateHeightVsDepth ( ) const

pure virtual

Return a table of altitude vs atmospheric column depth.

Implemented in atm::SimShowerProfileModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, and atm::USStdADBProfileModel.

virtual const ProfileResult& atm::VProfileModel::EvaluatePressureVsHeight ( ) const

pure virtual

Return a table of air pressure vs. altitude.

Implemented in atm::SimShowerProfileModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, and atm::USStdADBProfileModel.

const ProfileResult & atm::VProfileModel::EvaluateRefractionIndexVsHeight ( ) const

virtual

Return a table of wavelength-independent refractive index vs. altitude.

Reimplemented in atm::SimShowerProfileModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, and atm::USStdADBProfileModel.

Definition at line 60 of file VProfileModel.cc.

References fTabRIVsHeight.

const ProfileResult & atm::VProfileModel::EvaluateRefractionIndexVsHeight ( const double wl ) const

virtual

Return a table of wavelength-independent refractive index vs. altitude.

Definition at line 86 of file VProfileModel.cc.

References utl::RefractionIndex::Ciddor95(), atm::ProfileResult::eLinear, atm::ProfileResult::fProfile, fTabLogPressureVsHeight, fTabLogVaporPressureVsHeight, fTabRIVsHeightAndWaveLength, fTabTemperatureVsHeight, utl::TabulatedFunction::XBegin(), utl::TabulatedFunction::XEnd(), and atm::ProfileResult::Y().

virtual const ProfileResult& atm::VProfileModel::EvaluateTemperatureVsHeight ( ) const

pure virtual

Return a table of air temperature vs. altitude.

Implemented in atm::SimShowerProfileModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, and atm::USStdADBProfileModel.

virtual const ProfileResult& atm::VProfileModel::EvaluateVaporPressureVsHeight ( ) const

pure virtual

Return a table of H2O vapor pressure vs. altitude.

Implemented in atm::SimShowerProfileModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, and atm::USStdADBProfileModel.

void atm::VProfileModel::ExtendProfilesTo100km ( ) const

protected

Use the U.S. Standard Atmosphere of 1976 to extend the altitude profiles to 100km (deprecated, pending release of the new molecular DB)

Definition at line 218 of file VProfileModel.cc.

References utl::TabulatedFunctionErrors::Begin(), utl::cm2, atm::ProfileResult::fProfile, fTabHeightVsLogDepth, fTabLogDensityVsHeight, fTabLogDepthVsHeight, fTabLogPressureVsHeight, fTabLogVaporPressureVsHeight, fTabRIVsHeight, fTabTemperatureVsHeight, utl::g, utl::TabulatedFunctionErrors::Insert(), utl::kelvin, utl::kg, utl::kLn10, km, utl::m3, utl::pascal, utl::TabulatedFunctionErrors::PushBack(), and utl::TabulatedFunction::XBack().

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

double atm::VProfileModel::GetVerticalTimeOfFlight	(	const double	height1,
		const double	height2
	)		const

virtual

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.

virtual bool atm::VModel::HasData ( ) const

pure virtualinherited

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

Implemented in atm::SuperMieModel, atm::MeasuredDBMieModel, atm::MieModelOff, atm::RayleighModelOff, atm::LidarCloudDBModel, atm::ParametricXMLMieModel, atm::ParametricXMLRayleighModel, atm::HumidAirRayleighModel, atm::AnalyticalCherenkovModel, atm::SimShowerProfileModel, atm::NonParametricXMLMieModel, atm::GDASProfileModel, atm::RadiosondeDBProfileModel, atm::SuperProfileModel, atm::ParametricXMLProfileModel, atm::MonthlyAvgDBProfileModel, atm::AirflyFluorescenceModel, atm::Kakimoto1996FluorescenceModel, atm::Nagano2004FluorescenceModel, atm::USStdADBProfileModel, atm::ConstantFluorescenceModel, atm::Keilhauer2008FluorescenceModel, and atm::AirFluorescenceModel.