Classes
Atmosphere model
Collaboration diagram for Atmosphere model:

Classes

class  atm::AirflyFluorescenceModel
 Fluorescence yields from AIRFLY. More...
 
class  atm::AnalyticalCherenkovModel
 Model with analytical calculation of the Cherenkov light. More...
 
class  atm::Arbeletche2021CherenkovAngularModel
 Parametrization of the angular distribution of Cherenkov photons from L. Arbeletche and V. de Souza (10.1140/epjc/s10052-021-08971-7) More...
 
class  atm::CherenkovModel
 model of Cherenkov light production in a shower More...
 
class  atm::ConstantFluorescenceModel
 Model with constant fluorescence yield. More...
 
class  atm::GDASProfileModel
 Molecular profile taken from GDAS database. More...
 
class  atm::HumidAirRayleighModel
 Model for Rayleigh scattering and attenuation in a humid atmosphere. More...
 
class  atm::Kakimoto1996FluorescenceModel
 Fluorescence yield calculation based. More...
 
class  atm::Keilhauer2008FluorescenceModel
 Fluorescence yields from Keilhauer et al. (arXiv:0801.4200) More...
 
class  atm::LidarCloudDBModel
 Class for cloud coverage calculations. More...
 
class  atm::MeasuredDBMieModel
 Class for computing aerosol scattering and attenuation using database measurements. More...
 
class  atm::MieModelOff
 In case you don't believe in Mie scattering ... More...
 
class  atm::ModelRegister< ModelType >
 Registry of atmosphere models. More...
 
class  atm::MonthlyAvgDBProfileModel
 Molecular profile information from database monthly averages. More...
 
class  atm::Nagano2004FluorescenceModel
 Fluorescence yields from Nagano et al. More...
 
class  atm::ParametricXMLMieModel
 Class for computing aerosol scattering and attenuation using simple parameterizations. More...
 
class  atm::ParametricXMLProfileModel
 Molecular profile using a parametric model. More...
 
class  atm::ParametricXMLRayleighModel
 Parametric model for Rayleigh scattering and attenuation using. More...
 
class  atm::RadiosondeDBProfileModel
 Molecular profile taken from radiosonde database. More...
 
class  atm::RayleighModelOff
 In case you don't believe in Rayleigh scattering ... More...
 
class  atm::SimShowerProfileModel
 Molecular profile using a parametric model stored in a shower file. More...
 
class  atm::SuperMieModel
 Compute Mie scattering/attenuation using the best data source. More...
 
class  atm::SuperProfileModel
 Atmospheric profile using best available data source. More...
 
class  atm::USStdADBProfileModel
 Extracts profile info from US Standard Atmosphere. More...
 
class  atm::VCherenkovModel
 Base class for a Cherenkov Model. More...
 
class  VFluorescence
 Base class for a Fluorescence Model. More...
 
class  atm::VMieModel
 Base class for a Mie Model. More...
 
class  atm::VModel
 Base class of atmospheric functions. More...
 
class  atm::VProfileModel
 Base class for a Profile Model. More...
 
class  atm::VRayleighModel
 Base class for an Rayleigh Model. More...
 

Detailed Description

As described in the section on the atmosphere interface, high-level interface methods belonging the atm::Atmosphere class are implemeted using swappable atmosphere models, which are pieces of code responsible for locating the relevant data and using it to compute a result. The user has the freedom to choose which models are used in carrying out these calculations. Different models may use different data sources or different algorithms to evaluate the data.

Model types

There are currently five distinct model types used in the atmosphere:

Model selection and naming conventions

The choice of which models to employ is specified in the AtmosphereInterface.xml configuration file. You will find it here:

path-to-offline-install/share/auger-offline/config/AtmosphereInterface.xml

This file contains a list of elements whose names describe the model types, with the specific instance of the model to be used written between the element tags. For example, the configuration file might read:

<AtmosphereInterfaceConfig>
  <RayleighModel>     ParametricXML   </RayleighModel>
  <ProfileModel>      MonthlyAvgDB    </ProfileModel>
  <MieModel>          MeasuredDB      </MieModel>
  <FluorescenceModel> Nagano2004      </FluorescenceModel>
  <CherenkovModel>    Analytical      </CherenkovModel>
  <CloudModel>        LidarCloudDB    </CloudModel>
</AtmosphereInterfaceConfig>

The names for the model instances are supposed to indicate what sort of algorithm is employed to do the calculation, and where the data for the calculation are taken from. For example,

   <MieModel> MeasuredDB </MieModel>

indicates that aerosol scattering and attenuation are computed using measurements stored in the database. In contrast,

   <MieModel> ParametricXML </MieModel>

indicates that a parametrization is used, with parameters kept in an XML file.Note that there are also some models which are capable of automatically choosing the most appropriate data source to use, so that you do not have to make the choice in the Atmosphere interface configuration. Such models are called "super" models, and appear like this in the configuration file:

   <MieModel> Super </MieModel>

In the case of the Mie super model, the calculations use measurements from the database if they are available, or a parametrization in case no data are found in the database.The various model instances are given by the list of classes at top of this section. To determine the model instance name to use in the configuration file from the class name for the model, you generally just have to strip off the last two word from the class name. For example, the model coded in the class atm::MeasuredDBMieModel is called MeasuredDB in the <MieModel> element of the AtmosphereInterface.xml configuration file.If you want to see where the model names used in the configuration file are actually mapped on to instances of the model types, you can look in the source code for atm::AtmosphereModelsManager.


, generated on Tue Sep 26 2023.