List of all members | Public Member Functions | Private Attributes
atm::VMieModel Class Referenceabstract
Atmosphere model

Base class for a Mie Model. More...

#include <VMieModel.h>

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

Public Member Functions

virtual AttenuationResult EvaluateMieAttenuation (const utl::Point &xInit, const utl::Point &xFinal, const std::vector< double > &wLength) const =0
 
virtual double EvaluateMieAttenuation (const utl::Point &xInit, const utl::Point &xFinal, const double wLength) const =0
 
virtual ScatteringResult EvaluateMieScattering (const utl::Point &xA, const utl::Point &xB, const double angle, const double distance, const std::vector< double > &xLength) const =0
 
virtual ScatteringResult EvaluateMieScattering (const utl::Point &xA, const utl::Point &xB, const double angle, const double distance, const AttenuationResult &mieAttenuation) const =0
 
virtual double EvaluateMieScattering (const utl::Point &xA, const utl::Point &xB, const double angle, const double distance, const double xLength) const =0
 
virtual double EvaluateMieScattering (const utl::Point &xA, const utl::Point &xB, const double angle, const double distance, const double xLength, const double mieAttenuation) const =0
 
virtual double EvaluateScatteringAngle (const utl::Point &p, const double angle, const double wLength) const =0
 
virtual const utl::VRandomSampler & EvaluateScatteringAngleDistribution (const utl::Point &p, const double wLength) const
 
virtual double GetAttenuationLength (const utl::Point &p, const double wLength) const =0
 
virtual double GetVerticalAerosolOpticalDepth (const unsigned int eyeId, const double altitude) const =0
 
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...
 
 VMieModel ()
 
virtual ~VMieModel ()
 

Private Attributes

utl::VRandomSampler * fAngularDistribution
 

Detailed Description

Base class for a Mie Model.

Author
Luis Prado Jr
Date
18 Jun 2003

Definition at line 38 of file VMieModel.h.

Constructor & Destructor Documentation

VMieModel::VMieModel ( )

Definition at line 22 of file VMieModel.cc.

VMieModel::~VMieModel ( )
virtual

Definition at line 28 of file VMieModel.cc.

References fAngularDistribution.

Member Function Documentation

virtual AttenuationResult atm::VMieModel::EvaluateMieAttenuation ( const utl::Point &  xInit,
const utl::Point &  xFinal,
const std::vector< double > &  wLength 
) const
pure virtual

Implemented in atm::MeasuredDBMieModel, atm::SuperMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

virtual double atm::VMieModel::EvaluateMieAttenuation ( const utl::Point &  xInit,
const utl::Point &  xFinal,
const double  wLength 
) const
pure virtual

Implemented in atm::SuperMieModel, atm::MeasuredDBMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

virtual ScatteringResult atm::VMieModel::EvaluateMieScattering ( const utl::Point &  xA,
const utl::Point &  xB,
const double  angle,
const double  distance,
const std::vector< double > &  xLength 
) const
pure virtual

Implemented in atm::MeasuredDBMieModel, atm::SuperMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

virtual ScatteringResult atm::VMieModel::EvaluateMieScattering ( const utl::Point &  xA,
const utl::Point &  xB,
const double  angle,
const double  distance,
const AttenuationResult &  mieAttenuation 
) const
pure virtual

Additionally takes a precomputed Mie AttenuationResult. Warning: Make sure it's compatible with the other parameters!

Implemented in atm::MeasuredDBMieModel, atm::SuperMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

virtual double atm::VMieModel::EvaluateMieScattering ( const utl::Point &  xA,
const utl::Point &  xB,
const double  angle,
const double  distance,
const double  xLength 
) const
pure virtual

Implemented in atm::SuperMieModel, atm::MeasuredDBMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

virtual double atm::VMieModel::EvaluateMieScattering ( const utl::Point &  xA,
const utl::Point &  xB,
const double  angle,
const double  distance,
const double  xLength,
const double  mieAttenuation 
) const
pure virtual

Implemented in atm::SuperMieModel, atm::MeasuredDBMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

virtual double atm::VMieModel::EvaluateScatteringAngle ( const utl::Point &  p,
const double  angle,
const double  wLength 
) const
pure virtual

Implemented in atm::SuperMieModel, atm::MeasuredDBMieModel, atm::MieModelOff, atm::ParametricXMLMieModel, and atm::NonParametricXMLMieModel.

Referenced by EvaluateScatteringAngleDistribution().

const utl::VRandomSampler & VMieModel::EvaluateScatteringAngleDistribution ( const utl::Point &  p,
const double  wLength 
) const
virtual

Definition at line 35 of file VMieModel.cc.

References utl::deg, EvaluateScatteringAngle(), fAngularDistribution, and utl::TabulatedFunction::PushBack().

virtual double atm::VMieModel::GetAttenuationLength ( const utl::Point &  p,
const double  wLength 
) const
pure virtual

Implemented in atm::SuperMieModel, atm::MeasuredDBMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

virtual double atm::VMieModel::GetVerticalAerosolOpticalDepth ( const unsigned int  eyeId,
const double  altitude 
) const
pure virtual

Implemented in atm::SuperMieModel, atm::MeasuredDBMieModel, atm::MieModelOff, atm::NonParametricXMLMieModel, and atm::ParametricXMLMieModel.

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.

virtual void atm::VModel::Init ( )
pure virtualinherited

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

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

utl::VRandomSampler* atm::VMieModel::fAngularDistribution
mutableprivate

Definition at line 94 of file VMieModel.h.

Referenced by EvaluateScatteringAngleDistribution(), and ~VMieModel().

The documentation for this class was generated from the following files:
, generated on Tue Sep 26 2023.