Isis 3.0
Home
Static Public Member Functions | List of all members
Isis::AtmosModelFactory Class Reference
Pattern Matching

This class is used to create AtmosModel objects. More...

#include <AtmosModelFactory.h>

Static Public Member Functions

static AtmosModel * Create (Pvl &pvl, PhotoModel &pmodel)
 Create an AtmosModel object using a PVL specification. More...
 

Detailed Description

This class is used to create AtmosModel objects.

Typically, applications which perform atmospheric corrections need to use different types of atmospheric function such as Isotropic1, Anisotropic1, HapkeAtm1, etc. If this factory is given a Pvl object which contains an AtmosModel definition, it will create that specific instance of the class. For example,

* Object = AtmosphericModel Group = Algorithm
* AstName/Name = Isotropic1 ...
* EndGroup ...
*EndObject End
*

Will create an Isotropic 1st order object (which is derived from AtmosModel). The simplest way to create an AtmosModel class is to use the static Create method

* Pvl p("myatmosmodel.pvl");
* AtmosModel *ar = AtmosModelFactory::Create(p);
*
Author
2006-01-23 Janet Barrett

Member Function Documentation

AtmosModel * Isis::AtmosModelFactory::Create ( Pvl &  pvl,
PhotoModel &  pmodel 
)
static

Create an AtmosModel object using a PVL specification.

An example of the PVL required for this is:

* Object = AtmosphericModel
* Group = Algorithm
* # Use 'AtmName' instead of 'Name' if using the Gui combo box
* # for unique Pvl keyword in DefFile
* AtmName/Name = Isotropic1
* Tau = 0.7
* Tauref = 0.0
* Wha = 0.5
* Hnorm = 0.003
* Nulneg = NO
* EndGroup
* EndObject
*

There are many other options that can be set via the pvl and are described in other documentation (see below).

Parameters
pvlThe pvl object containing the specification
pmodelThe PhotoModel objects contining the data
Returns
A pointer to the new AtmosModel
See Also
atmosphericModels.doc

References _FILEINFO_, Isis::FileName::fileExists(), Isis::PvlObject::findObject(), Isis::Plugin::GetPlugin(), Isis::PvlContainer::hasKeyword(), Isis::Pvl::read(), Isis::PvlObject::Traverse, and Isis::IException::User.

Referenced by Isis::Photometry::Photometry().

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