Isis 3 Programmer Reference
Isis::AtmosModel Class Referenceabstract

Isotropic atmos scattering model. More...

#include <AtmosModel.h>

Inheritance diagram for Isis::AtmosModel:
Inheritance graph
Collaboration diagram for Isis::AtmosModel:
Collaboration graph

Public Member Functions

 AtmosModel (Pvl &pvl, PhotoModel &pmodel)
 Create an AtmosModel object. More...
 
virtual ~AtmosModel ()
 Empty destructor. More...
 
void CalcAtmEffect (double pha, double inc, double ema, double *pstd, double *trans, double *trans0, double *sbar, double *transs)
 Calculate the atmospheric scattering effect using photometric angle information. More...
 
virtual void SetStandardConditions (bool standard)
 Used to calculate atmosphere at standard conditions. More...
 
void GenerateAhTable ()
 This method computes the values of the atmospheric Ah table and sets the properties of the atmospheric Ah spline. More...
 
void GenerateHahgTables ()
 This method computes the values of the atmospheric Hahg and Hahg0 tables and sets the properties of the atmospheric Hahg and Hahg0 splines. More...
 
void GenerateHahgTablesShadow ()
 This method is a modified version of the GenerateHahgTables method and is used solely for shadow modeling. More...
 
void SetAtmosAtmSwitch (const int atmswitch)
 Set the switch that controls the function that will be integrated. More...
 
void SetAtmosBha (const double bha)
 Set the Anisotropic Atmospheric function parameter. More...
 
void SetAtmosHga (const double hga)
 Set the Hapke atmospheric function parameter. More...
 
void SetAtmosInc (const double inc)
 Set the incidence angle. More...
 
void SetAtmosNulneg (const string nulneg)
 Set the Atmospheric function parameter. More...
 
void SetAtmosPhi (const double phi)
 Set the azimuth angle. More...
 
void SetAtmosTau (const double tau)
 Set the Atmospheric function parameter. More...
 
void SetAtmosTauref (const double tauref)
 Set the Atmospheric function parameter. More...
 
void SetAtmosWha (const double wha)
 Set the Atmospheric function parameter. More...
 
void SetAtmosHnorm (const double hnorm)
 Set the Atmospheric function parameter. More...
 
void SetAtmosIord (const string offset)
 Set additive offset in fit. More...
 
void SetAtmosEstTau (const string esttau)
 Estimate the optical depth tau using shadows. More...
 
string AlgorithmName () const
 Return atmospheric algorithm name. More...
 
bool AtmosAdditiveOffset () const
 Allow additive offset in fit? More...
 
double AtmosHnorm () const
 Return atmospheric Hnorm value. More...
 
double AtmosBha () const
 Return atmospheric Bha value. More...
 
double AtmosTau () const
 Return atmospheric Tau value. More...
 
double AtmosWha () const
 Return atmospheric Wha value. More...
 
double AtmosHga () const
 Return atmospheric Hga value. More...
 
double AtmosTauref () const
 Return atmospheric Tauref value. More...
 
bool AtmosNulneg () const
 Return atmospheric Nulneg value. More...
 
double AtmosAb () const
 Return atmospheric Ab value. More...
 
double AtmosHahgsb () const
 Return atmospheric Hahgsb value. More...
 
int AtmosNinc () const
 Return atmospheric Ninc value. More...
 
double AtmosMunot () const
 Return atmospheric Munot value. More...
 
vector< double > AtmosIncTable ()
 Return atmospheric IncTable value. More...
 
vector< double > AtmosAhTable ()
 Return atmospheric AhTable value. More...
 
vector< double > AtmosHahgtTable ()
 Return atmospheric HahgtTable value. More...
 
vector< double > AtmosHahgt0Table ()
 Return atmospheric Hahgt0Table value. More...
 
NumericalApproximation AtmosAhSpline ()
 If GenerateAhTable() has been called this returns a clamped cubic spline of the data set (p_atmosIncTable, p_atmosAhTable) with first derivatives of the endpoints equal to 1.0e30. More...
 
NumericalApproximation AtmosHahgtSpline ()
 If GenerateHahgTables() has been called this returns a clamped cubic spline of the data set (p_atmosIncTable, p_atmosHahgtTable) with first derivatives of the endpoints equal to 1.0e30. More...
 
NumericalApproximation AtmosHahgt0Spline ()
 If GenerateHahgTables() has been called this returns a clamped cubic spline of the data set (p_atmosIncTable, p_atmosHahgt0Table) with first derivatives of the endpoints equal to 1.0e30. More...
 

Static Public Member Functions

static double G11Prime (double tau)
 Perform Chandra and Van de Hulst's series approximation for the g'11 function needed in second order scattering theory. More...
 
static double Ei (double x)
 This routine computes the exponential integral, Ei(x). More...
 
static double En (unsigned int n, double x)
 This routine evaluates the generalized exponential integral, En(x). More...
 

Protected Member Functions

virtual void AtmosModelAlgorithm (double phase, double incidence, double emission)=0
 
void SetAlgorithmName (string name)
 
void SetAtmosNulneg (bool nulneg)
 
void SetAtmosIord (bool offset)
 
void SetAtmosEstTau (bool esttau)
 
void SetOldTau (double tau)
 
void SetOldWha (double wha)
 
PhotoModelGetPhotoModel () const
 
bool StandardConditions () const
 
bool TauOrWhaChanged () const
 Checks whether tau or wha have changed. More...
 
double Eulgam () const
 

Protected Attributes

int p_atmosAtmSwitch
 
int p_atmosNinc
 
double p_atmosBha
 
double p_atmosBhasave
 
double p_atmosHgasave
 
double p_atmosTauref
 
double p_atmosTausave
 
double p_atmosWhasave
 
double p_pstd
 Pure atmospheric-scattering term. More...
 
double p_trans
 Transmission of surface reflected light through the atmosphere overall. More...
 
double p_trans0
 Transmission of surface reflected light through the atmosphere with no scatterings in the atmosphere. More...
 
double p_transs
 Transmission of light that must be subtracted from the flat surface model to get the shadow model. More...
 
double p_sbar
 Illumination of the ground by the sky. More...
 
double p_atmosHga
 
double p_atmosTau
 
double p_atmosWha
 
double p_atmosAb
 
double p_atmosHnorm
 Atmospheric shell thickness normalized to planet radius. More...
 
bool p_atmosAddOffset
 Allow additive offset in fit. More...
 
bool p_atmosEstTau
 Estimate optical depth tau using shadows. More...
 
vector< double > p_atmosIncTable
 
vector< double > p_atmosAhTable
 
double p_atmosHahgsb
 
vector< double > p_atmosHahgtTable
 
vector< double > p_atmosHahgt0Table
 
double p_atmosInc
 
double p_atmosPhi
 
double p_atmosMunot
 
double p_atmosSini
 
double p_atmosCosphi
 
double p_atmosEulgam
 
NumericalApproximation p_atmosAhSpline
 Spline object for the atmospheric Ah Table. Properties are set in GenerateAhTable(). More...
 
NumericalApproximation p_atmosHahgtSpline
 Spline object for the atmospheric Hahg Table. Properties are set in GenerateHahgTables(). More...
 
NumericalApproximation p_atmosHahgt0Spline
 Spline object for the atmospheric Hahg0 Table. Properties are set in GenerateHahgTables(). More...
 

Private Attributes

bool p_standardConditions
 
string p_atmosAlgorithmName
 
PhotoModelp_atmosPM
 
bool p_atmosNulneg
 
double p_atmosTauold
 
double p_atmosWhaold
 

Friends

class NumericalAtmosApprox
 

Detailed Description

Isotropic atmos scattering model.

Author
1998-12-21 Randy Kirk
History:

2007-02-20 Janet Barrett - Imported from Isis2.

2007-07-31 Steven Lambright - Fixed unit test

2007-08-15 Steven Lambright - Refactored

2008-03-07 Janet Barrett - Added code to set standard conditions. Also added bharef, hgaref, tauref, and wharef variables and supporting methods.

2008-06-18 Christopher Austin - Fixed much documentation

2008-07-09 Steven Lambright - Fixed unit test

2008-11-05 Jeannie Walldren - Moved numerical methods and functions to NumericalMethods and NumericalAtmosApprox classes. Moved G11Prime(), Ei(), and En() from NumericalMethods into this class. Added splines to protected variables and removed second derivative vector protected variables (p_atmosAhTable2, p_atmosHahgtTable2, p_atmosHahgt0Table2) that are no longer needed. Replaced arrays with vectors in protected variables. Added documentation from Isis2 files. Removed "Isis::" and "std::" in AtmosModel.cpp since that file uses std and Isis namespaces.

2008-11-07 Jeannie Walldren - Fixed documentation

2011-08-17 Sharmila Prasad -Added API's for HNORM, Additive Offset

2011-09-14 Janet Barrett - Got rid of bharef, hgaref, and wharef variables and supporting methods.

2011-12-19 Janet Barrett - Added the p_atmosEstTau variable that determines if the optical depth "tau" will be estimated using shadow modeling. Added the GenerateHahgTablesShadow method for doing the shadow modeling. Added a getter method for accessing the Munot (normally the cosine of the incidence angle) value in the atmospheric classes. Added a setter method for setting the p_atmosEstTau variable which is used by the atmospheric classes.

Definition at line 76 of file AtmosModel.h.

Constructor & Destructor Documentation

◆ AtmosModel()

Isis::AtmosModel::AtmosModel ( Pvl pvl,
PhotoModel pmodel 
)

Create an AtmosModel object.

Because this is a pure virtual class you can not create an AtmosModel class directly. Instead, see the Isis::AtmosModelFactory class.

Parameters
pvlIsis::Pvl object containing a valid AtmosModel specification
pmodelPhotoModel object containing valud AtmosModel data
See also
atmosphericModels.doc
History:
2008-11-05 Jeannie Walldren - Replaced arrays with vectors

Definition at line 35 of file AtmosModel.cpp.

References Isis::PvlObject::findObject(), and Isis::PvlContainer::hasKeyword().

◆ ~AtmosModel()

virtual Isis::AtmosModel::~AtmosModel ( )
inlinevirtual

Empty destructor.

Definition at line 80 of file AtmosModel.h.

Member Function Documentation

◆ AlgorithmName()

string Isis::AtmosModel::AlgorithmName ( ) const
inline

Return atmospheric algorithm name.

Definition at line 116 of file AtmosModel.h.

◆ AtmosAb()

double Isis::AtmosModel::AtmosAb ( ) const
inline

Return atmospheric Ab value.

Definition at line 155 of file AtmosModel.h.

Referenced by Isis::AlbedoAtm::NormModelAlgorithm().

◆ AtmosAdditiveOffset()

bool Isis::AtmosModel::AtmosAdditiveOffset ( ) const
inline

Allow additive offset in fit?

Definition at line 121 of file AtmosModel.h.

◆ AtmosAhSpline()

NumericalApproximation Isis::AtmosModel::AtmosAhSpline ( )
inline

If GenerateAhTable() has been called this returns a clamped cubic spline of the data set (p_atmosIncTable, p_atmosAhTable) with first derivatives of the endpoints equal to 1.0e30.

Otherwise, it is a natural cubic spline with an empty data set.

Returns
NumericalApproximation Cubic spline
History:
2008-11-05 Jeannie Walldren - Original version

Definition at line 199 of file AtmosModel.h.

Referenced by Isis::AlbedoAtm::AlbedoAtm(), and Isis::AlbedoAtm::NormModelAlgorithm().

◆ AtmosAhTable()

vector<double> Isis::AtmosModel::AtmosAhTable ( )
inline

Return atmospheric AhTable value.

Definition at line 176 of file AtmosModel.h.

◆ AtmosBha()

double Isis::AtmosModel::AtmosBha ( ) const
inline

Return atmospheric Bha value.

Definition at line 131 of file AtmosModel.h.

◆ AtmosHahgsb()

double Isis::AtmosModel::AtmosHahgsb ( ) const
inline

Return atmospheric Hahgsb value.

Definition at line 159 of file AtmosModel.h.

◆ AtmosHahgt0Spline()

NumericalApproximation Isis::AtmosModel::AtmosHahgt0Spline ( )
inline

If GenerateHahgTables() has been called this returns a clamped cubic spline of the data set (p_atmosIncTable, p_atmosHahgt0Table) with first derivatives of the endpoints equal to 1.0e30.

Otherwise, it is a natural cubic spline with an empty data set.

Returns
NumericalApproximation Cubic spline
History:
2008-11-05 Jeannie Walldren - Original version

Definition at line 227 of file AtmosModel.h.

◆ AtmosHahgt0Table()

vector<double> Isis::AtmosModel::AtmosHahgt0Table ( )
inline

Return atmospheric Hahgt0Table value.

Definition at line 184 of file AtmosModel.h.

◆ AtmosHahgtSpline()

NumericalApproximation Isis::AtmosModel::AtmosHahgtSpline ( )
inline

If GenerateHahgTables() has been called this returns a clamped cubic spline of the data set (p_atmosIncTable, p_atmosHahgtTable) with first derivatives of the endpoints equal to 1.0e30.

Otherwise, it is a natural cubic spline with an empty data set.

Returns
NumericalApproximation Cubic spline
History:
2008-11-05 Jeannie Walldren - Original version

Definition at line 213 of file AtmosModel.h.

◆ AtmosHahgtTable()

vector<double> Isis::AtmosModel::AtmosHahgtTable ( )
inline

Return atmospheric HahgtTable value.

Definition at line 180 of file AtmosModel.h.

◆ AtmosHga()

double Isis::AtmosModel::AtmosHga ( ) const
inline

Return atmospheric Hga value.

Definition at line 143 of file AtmosModel.h.

Referenced by Isis::NumericalAtmosApprox::InrFunc2Bint().

◆ AtmosHnorm()

double Isis::AtmosModel::AtmosHnorm ( ) const
inline

Return atmospheric Hnorm value.

Definition at line 126 of file AtmosModel.h.

◆ AtmosIncTable()

vector<double> Isis::AtmosModel::AtmosIncTable ( )
inline

Return atmospheric IncTable value.

Definition at line 172 of file AtmosModel.h.

◆ AtmosMunot()

double Isis::AtmosModel::AtmosMunot ( ) const
inline

Return atmospheric Munot value.

Definition at line 167 of file AtmosModel.h.

◆ AtmosNinc()

int Isis::AtmosModel::AtmosNinc ( ) const
inline

Return atmospheric Ninc value.

Definition at line 163 of file AtmosModel.h.

◆ AtmosNulneg()

bool Isis::AtmosModel::AtmosNulneg ( ) const
inline

Return atmospheric Nulneg value.

Definition at line 151 of file AtmosModel.h.

◆ AtmosTau()

double Isis::AtmosModel::AtmosTau ( ) const
inline

Return atmospheric Tau value.

Definition at line 135 of file AtmosModel.h.

Referenced by Isis::NumericalAtmosApprox::InrFunc2Bint().

◆ AtmosTauref()

double Isis::AtmosModel::AtmosTauref ( ) const
inline

Return atmospheric Tauref value.

Definition at line 147 of file AtmosModel.h.

◆ AtmosWha()

double Isis::AtmosModel::AtmosWha ( ) const
inline

Return atmospheric Wha value.

Definition at line 139 of file AtmosModel.h.

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), and Isis::HapkeAtm2::AtmosModelAlgorithm().

◆ CalcAtmEffect()

void Isis::AtmosModel::CalcAtmEffect ( double  pha,
double  inc,
double  ema,
double *  pstd,
double *  trans,
double *  trans0,
double *  sbar,
double *  transs 
)

Calculate the atmospheric scattering effect using photometric angle information.

Parameters
phaphase angle
incincidence angle
emaemission angle
pstdpure atmospheric-scattering term
transtransmission of surface reflected light through the atmosphere overall
trans0transmission of surface reflected light through the atmosphere with no scatterings in the atmosphere
sbarillumination of the ground by the sky
Exceptions
Isis::IException::User"Invalid photometric angles"

Definition at line 469 of file AtmosModel.cpp.

Referenced by Isis::AlbedoAtm::AlbedoAtm(), and Isis::AlbedoAtm::NormModelAlgorithm().

◆ Ei()

double Isis::AtmosModel::Ei ( double  x)
static

This routine computes the exponential integral, Ei(x).

This is defined as

\[ Ei(x) = - \int_{-x}^{\infty} \frac{e^{-t}}{t}\mathrm{d}t = \int_{-\infty}^{x} \frac{e^{t}}{t}\mathrm{d}t \]

for x > 0.

For small x, this method uses the power series,

\[ Ei(x) = \gamma + \ln x + \frac{x}{1*1!} + \frac{x^2}{2*2!} + ... \]

where \( \gamma = 0.5772156649... \) is Euler's constant, and for large x, the asymptotic series is used,

\[ Ei(x) \sim \frac{e^x}{x} (1 + \frac{1!}{x} + \frac{2!}{x^2} + ...) \]

See also
mathworld.wolfram.com/ExponentialIntegral.html
Parameters
xValue at which the exponential integral will be computed, x > 0.0
Returns
double The exponential integral for the given x.
Exceptions
Isis::IException::Programmer"Invalid arguments. Definition requires x > 0.0."
Isis::IException::Math"Power series failed to converge"
History:

1999-08-11 K Teal Thompson - Original version named pht_r8ei in Isis2.

2007-02-20 Janet Barrett - Imported to Isis3 in NumericalMethods class named r8ei().

2008-11-05 Jeannie Walldren - Renamed and modified input parameters. Added documentation.

Definition at line 223 of file AtmosModel.cpp.

References _FILEINFO_.

Referenced by Isis::Isotropic2::AtmosModelAlgorithm(), Isis::HapkeAtm2::AtmosModelAlgorithm(), and Isis::Anisotropic2::AtmosModelAlgorithm().

◆ En()

double Isis::AtmosModel::En ( unsigned int  n,
double  x 
)
static

This routine evaluates the generalized exponential integral, En(x).

This is defined as

\[ E_n(x) = \int_{1}^{\infty} \frac{e^{-xt}}{t^n}\mathrm{d}t \mathrm{ for } x \in \mathbb{R }, n \in \mathbb{Z } \mathrm{such that } x \ge 0.0, n \ge 0 \]

Notice that if x = 0, then the equation is not defined for n = 0 or n = 1, as these will result in \( E_n(x) = \infty \).

This method uses the following for cases:

  • For n > 1 and x = 0.0,

    \[ E_n(0) = \frac{1}{n-1} \]

  • For n = 0 and x > 0.0,

    \[ E_0(x) = \frac{e^{-x}}{x} \]

  • For \( x >\sim 1.0 \), Lentz's continued fraction algorithm is used,

    \[ E_n(x) = e^{-x}(\frac{1}{x + n - \frac{1*n}{x + n + 2 - \frac{2(n+1)}{x + n + 4 - ...}}}) \]

  • For \( 0.0 < x <\sim 1.0 \), series representation is used,

    \[ E_n(x) = \frac{(-x)^{n-1}}{(n-1)!}[- \ln x + \psi (n)] - \sum_{m=0, m \neq n-1}^{\infty}\frac{(-x)^m}{(m-n+1)m!} \]

    where \( \psi (1) = \gamma \) and \( \psi (n) = - \gamma + \sum_{m=1}^{n-1} \frac{1}{m}\) and \( \gamma = 0.5772156649... \) is Euler's constant.

The parameter n is of type unsigned int since n cannot be negative.

The routine allows fast evaluation of En(x) to any accuracy, \(\epsilon\), within the reach of your machine's word length for floating-point numbers. The only modification required for increased accuracy is to supply Euler's constant with enough significant digits.

See also
mathworld.wolfram.com/En-Function.html
Parameters
nInteger value at which the exponential integral will be evaluated (n >= 0)
xThe exponential integral En(x) will be evaluated
Returns
double Value of the exponential integral for the give n and x.
Exceptions
Isis::IException::Programmer"Invalid arguments. Definition requires (x > 0.0 and n >=0 ) or (x >= 0.0 and n > 1)." @throws Isis::IException::Math "Continued fraction failed to converge" @throws Isis::IException::Math "Series representation failed to converge"
History:

1999-08-10 K Teal Thompson - Original version in named pht_r8expint Isis2.

2007-02-20 Janet Barrett - Imported to Isis3 in NumericalMethods class named r8expint().

2008-11-05 Jeannie Walldren - Renamed and modified input parameters. Added documentation.

Definition at line 364 of file AtmosModel.cpp.

References _FILEINFO_.

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), Isis::Isotropic2::AtmosModelAlgorithm(), Isis::HapkeAtm2::AtmosModelAlgorithm(), Isis::Anisotropic1::AtmosModelAlgorithm(), and Isis::Anisotropic2::AtmosModelAlgorithm().

◆ G11Prime()

double Isis::AtmosModel::G11Prime ( double  tau)
static

Perform Chandra and Van de Hulst's series approximation for the g'11 function needed in second order scattering theory.

Parameters
taunormal optical depth of atmosphere
Returns
double Value of the g'11 function evaluated at the given tau
History:

1998-12-21 Randy Kirk, USGS - Flagstaff - Original code in Isis2 pht_am_functions

1999-03-12 K Teal Thompson - Port to Unix/ISIS; declare vars; cadd implicit none.

2007-02-20 Janet Barrett - Imported from Isis2 to Isis3 in NumericalMethods class.

2008-11-05 Jeannie Walldren - Moved this method from NumericalMethods class.

Definition at line 147 of file AtmosModel.cpp.

Referenced by Isis::Isotropic2::AtmosModelAlgorithm(), Isis::HapkeAtm2::AtmosModelAlgorithm(), and Isis::Anisotropic2::AtmosModelAlgorithm().

◆ GenerateAhTable()

void Isis::AtmosModel::GenerateAhTable ( )

This method computes the values of the atmospheric Ah table and sets the properties of the atmospheric Ah spline.

It obtains the hemispheric albedo by integrating the photometric function times mu over mu = 0 to 1 and then over phi = 0 to 2*pi to calculate the hemispheric reflectance Ah needed for the photometric model with atmosphere. The Trapezoid rule is applied to the table of Ah to obtain bihemispheric albedo Ab. The parameter p_atmosAtmSwitch is set to 0 to integrate Ah.

History:

1998-12-21 Randy Kirk - USGS, Flagstaff - Original specs

1999-01-15 K Teal Thompson - Original code

2000-12-29 Randy Kirk - Modified /hide_inc/ so phi gets passed, etc. moved factors to outside integration

2006-05-30 Randy Kirk - Added code to report the directional hemispheric albedo that relates to thermal balance for simulating Themis images

2007-02-20 Janet Barrett - Imported to Isis3 from Isis2 pht_get_ah_table

2008-11-05 Jeannie Walldren - Modified references to NumericalMethods and replaced r8qromb() with NumericalAtmosApprox::RombergsMethod(). Changed name from PhtGetAhTable().

Definition at line 531 of file AtmosModel.cpp.

References Isis::PI, Isis::NumericalAtmosApprox::RombergsMethod(), and Isis::IString::UpCase().

Referenced by Isis::AlbedoAtm::AlbedoAtm().

◆ GenerateHahgTables()

void Isis::AtmosModel::GenerateHahgTables ( )

This method computes the values of the atmospheric Hahg and Hahg0 tables and sets the properties of the atmospheric Hahg and Hahg0 splines.

It integrates functions involving the single particle phase function (assumed to be Hapke Henyey-Greenstein) over mu = 0 to 1 and then over phi = 0 to 2*pi to calculate the corrections needed for the anisotropic photometric model with atmosphere. The Trapezoid rule is applied to the table of Ah to obtain bihemispheric albedo Ab. The parameter p_atmosAtmSwitch is set to 1, 2, 3 to evaluate the 3 required integrals.

History:

1998-12-21 Randy Kirk - USGS, Flagstaff - Original specs

1999-01-15 K Teal Thompson - Original code

2006-07-07 Randy Kirk - Modify get_ah_table to get other integrals

2000-12-29 Randy Kirk - Modified /hide_inc/ so phi gets passed, etc. moved factors to outside integration

2007-02-20 Janet Barrett - Imported to Isis3 from Isis2 pht_get_ah_table

2008-11-05 Jeannie Walldren - Modified references to NumericalMethods and replaced r8qromb() with NumericalAtmosApprox::RombergsMethod(). Changed name from GetHahgTables().

Definition at line 631 of file AtmosModel.cpp.

References Isis::PI, Isis::NumericalApproximation::Reset(), and Isis::NumericalAtmosApprox::RombergsMethod().

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), and Isis::HapkeAtm2::AtmosModelAlgorithm().

◆ GenerateHahgTablesShadow()

void Isis::AtmosModel::GenerateHahgTablesShadow ( )

This method is a modified version of the GenerateHahgTables method and is used solely for shadow modeling.

Unlike the GenerateHahgTables method, this method does not tabulate the first or third integrals. It only evaluates the middle integral that corrects the sbar variable (illumination of the ground by the sky).

History:

1998-12-21 Randy Kirk - USGS, Flagstaff - Original specs

1999-01-15 K Teal Thompson - Original code

2006-07-07 Randy Kirk - Modify get_ah_table to get other integrals

2000-09-15 Randy Kirk - Delete first, last integrals and table of second integral

2000-12-29 Randy Kirk - Modified /hide_inc/ so phi gets passed, etc. moved factors to outside integration

2011-12-16 Janet Barrett - Imported to Isis3 from Isis2 get_hahgsb_shad routine in the not_shadow_tau set of routines

Definition at line 720 of file AtmosModel.cpp.

References Isis::PI, Isis::NumericalApproximation::Reset(), and Isis::NumericalAtmosApprox::RombergsMethod().

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), and Isis::HapkeAtm2::AtmosModelAlgorithm().

◆ SetAtmosAtmSwitch()

void Isis::AtmosModel::SetAtmosAtmSwitch ( const int  atmswitch)

Set the switch that controls the function that will be integrated.

This method is only used for testing the methods in this class. This parameter is limited to the values 0, 1, 2, and 3.

Parameters
atmswitchInternal atmospheric function parameter, there is no default
Exceptions
Isis::IException::User"Invalid value of atmospheric atmswitch"

Definition at line 773 of file AtmosModel.cpp.

References _FILEINFO_.

◆ SetAtmosBha()

void Isis::AtmosModel::SetAtmosBha ( const double  bha)

Set the Anisotropic Atmospheric function parameter.

This is the coefficient of the single particle Legendre phase function. This parameter is limited to values that are >=-1 and <=1.

Parameters
bhaAnisotropic atmospheric function parameter, default is 0.85
Exceptions
Isis::IException::User"Invalid value of atmospheric bha"

Definition at line 793 of file AtmosModel.cpp.

References _FILEINFO_.

◆ SetAtmosEstTau()

void Isis::AtmosModel::SetAtmosEstTau ( const string  esttau)

Estimate the optical depth tau using shadows.

Author
Janet Barrett (12/16/2011)
Parameters
esttautrue/false

Definition at line 996 of file AtmosModel.cpp.

References _FILEINFO_, and Isis::IString::UpCase().

◆ SetAtmosHga()

void Isis::AtmosModel::SetAtmosHga ( const double  hga)

Set the Hapke atmospheric function parameter.

This is the coefficient of the single particle Henyey-Greenstein phase function. This parameter is limited to values that are >-1 and <1.

Parameters
hgaHapke atmospheric function parameter, default is 0.68
Exceptions
Isis::IException::User"Invalid value of atmospheric hga"

Definition at line 814 of file AtmosModel.cpp.

References _FILEINFO_.

◆ SetAtmosHnorm()

void Isis::AtmosModel::SetAtmosHnorm ( const double  hnorm)

Set the Atmospheric function parameter.

This is the atmospheric shell thickness normalized to the planet radius and is used to modify angles to get more accurate path lengths near the terminator (ratio of scale height to the planetary radius). This parameter is limited to values that are >=0.

Parameters
hnormAtmospheric function parameter, default is 0.003

Definition at line 962 of file AtmosModel.cpp.

References _FILEINFO_, and Isis::toString().

◆ SetAtmosInc()

void Isis::AtmosModel::SetAtmosInc ( const double  inc)

Set the incidence angle.

This method is only used for testing the methods in this class. This parameter is limited to values >=0 and <=90.

Parameters
incInternal atmospheric function parameter, there is no default
Exceptions
Isis::IException::User"Invalid value of atmospheric inc"

Definition at line 833 of file AtmosModel.cpp.

References _FILEINFO_, and Isis::PI.

◆ SetAtmosIord()

void Isis::AtmosModel::SetAtmosIord ( const string  offset)

Set additive offset in fit.

Author
Sharmila Prasad (8/18/2011)
Parameters
offsettrue/false

Definition at line 977 of file AtmosModel.cpp.

References _FILEINFO_, and Isis::IString::UpCase().

◆ SetAtmosNulneg()

void Isis::AtmosModel::SetAtmosNulneg ( const string  nulneg)

Set the Atmospheric function parameter.

This determines if negative values after removal of atmospheric effects will be set to NULL. This parameter is limited to values of YES or NO.

Parameters
nulnegAtmospheric function parameter, default is NO
Exceptions
Isis::IException::User"Invalid value of atmospheric nulneg"

Definition at line 855 of file AtmosModel.cpp.

References _FILEINFO_, and Isis::IString::UpCase().

◆ SetAtmosPhi()

void Isis::AtmosModel::SetAtmosPhi ( const double  phi)

Set the azimuth angle.

This method is only used for testing the methods in this class. This parameter is limited to values >=0 and <=360.

Parameters
phiInternal atmospheric function parameter, there is no default
Exceptions
Isis::IException::User"Invalid value of atmospheric phi"

Definition at line 878 of file AtmosModel.cpp.

References _FILEINFO_, and Isis::PI.

◆ SetAtmosTau()

void Isis::AtmosModel::SetAtmosTau ( const double  tau)

Set the Atmospheric function parameter.

This specifies the normal optical depth of the atmosphere. This parameter is limited to values that are >=0.

Parameters
tauAtmospheric function parameter, default is 0.28
Exceptions
Isis::IException::User"Invalid value of atmospheric tau"

Definition at line 897 of file AtmosModel.cpp.

References _FILEINFO_.

◆ SetAtmosTauref()

void Isis::AtmosModel::SetAtmosTauref ( const double  tauref)

Set the Atmospheric function parameter.

This specifies the reference optical depth of the atmosphere to which the image will be normalized. This parameter is limited to values that are >=0.

Parameters
taurefAtmospheric function parameter, default is 0.0
Exceptions
Isis::IException::User"Invalid value of atmospheric tauref"

Definition at line 916 of file AtmosModel.cpp.

References _FILEINFO_.

◆ SetAtmosWha()

void Isis::AtmosModel::SetAtmosWha ( const double  wha)

Set the Atmospheric function parameter.

This is the single- scattering albedo of atmospheric particles. This parameter is limited to values that are >0 and <=1.

Parameters
whaAtmospheric function parameter, default is 0.95
Exceptions
Isis::IException::User"Invalid value of atmospheric wha"

Definition at line 935 of file AtmosModel.cpp.

References _FILEINFO_.

◆ SetStandardConditions()

void Isis::AtmosModel::SetStandardConditions ( bool  standard)
virtual

Used to calculate atmosphere at standard conditions.

Definition at line 492 of file AtmosModel.cpp.

Referenced by Isis::AlbedoAtm::AlbedoAtm().

◆ TauOrWhaChanged()

bool Isis::AtmosModel::TauOrWhaChanged ( ) const
protected

Member Data Documentation

◆ p_atmosAddOffset

bool Isis::AtmosModel::p_atmosAddOffset
protected

Allow additive offset in fit.

Definition at line 284 of file AtmosModel.h.

◆ p_atmosAhSpline

NumericalApproximation Isis::AtmosModel::p_atmosAhSpline
protected

Spline object for the atmospheric Ah Table. Properties are set in GenerateAhTable().

Definition at line 299 of file AtmosModel.h.

◆ p_atmosEstTau

bool Isis::AtmosModel::p_atmosEstTau
protected

Estimate optical depth tau using shadows.

Definition at line 285 of file AtmosModel.h.

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), and Isis::HapkeAtm2::AtmosModelAlgorithm().

◆ p_atmosHahgt0Spline

NumericalApproximation Isis::AtmosModel::p_atmosHahgt0Spline
protected

Spline object for the atmospheric Hahg0 Table. Properties are set in GenerateHahgTables().

Definition at line 303 of file AtmosModel.h.

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), and Isis::HapkeAtm2::AtmosModelAlgorithm().

◆ p_atmosHahgtSpline

NumericalApproximation Isis::AtmosModel::p_atmosHahgtSpline
protected

Spline object for the atmospheric Hahg Table. Properties are set in GenerateHahgTables().

Definition at line 301 of file AtmosModel.h.

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), and Isis::HapkeAtm2::AtmosModelAlgorithm().

◆ p_atmosHnorm

double Isis::AtmosModel::p_atmosHnorm
protected

◆ p_pstd

◆ p_sbar

◆ p_trans

double Isis::AtmosModel::p_trans
protected

◆ p_trans0

double Isis::AtmosModel::p_trans0
protected

Transmission of surface reflected light through the atmosphere with no scatterings in the atmosphere.

Definition at line 276 of file AtmosModel.h.

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), Isis::Isotropic2::AtmosModelAlgorithm(), Isis::HapkeAtm2::AtmosModelAlgorithm(), Isis::Anisotropic1::AtmosModelAlgorithm(), and Isis::Anisotropic2::AtmosModelAlgorithm().

◆ p_transs

double Isis::AtmosModel::p_transs
protected

Transmission of light that must be subtracted from the flat surface model to get the shadow model.

Definition at line 277 of file AtmosModel.h.

Referenced by Isis::HapkeAtm1::AtmosModelAlgorithm(), Isis::Isotropic2::AtmosModelAlgorithm(), Isis::HapkeAtm2::AtmosModelAlgorithm(), Isis::Anisotropic1::AtmosModelAlgorithm(), and Isis::Anisotropic2::AtmosModelAlgorithm().


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