USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::AlbedoAtm Class Reference
[Radiometric And Photometric Correction]

#include <AlbedoAtm.h>

Inheritance diagram for Isis::AlbedoAtm:

Inheritance graph
[legend]
Collaboration diagram for Isis::AlbedoAtm:

Collaboration graph
[legend]
List of all members.

Detailed Description

Albedo normalization with atmosphere.

Author:
1998-12-21 Randy Kirk

For internal use only.

History:
2007-08-15 Steven Lambright - Refactored code and fixed unit test
History:
2008-06-18 Christopher Austin - Fixed documentation errors
History:
2008-11-05 Jeannie Walldren - Modified references to NumericalMethods class.
History:
2008-11-07 Jeannie Walldren - Fixed documentation.
History:
2009-05-11 Janet Barrett - Fixed so that the NormModelAlgorithm supporting DEM input is the empty function. DEM input is not yet supported.

Definition at line 48 of file AlbedoAtm.h.

Public Member Functions

 AlbedoAtm (Pvl &pvl, PhotoModel &pmodel, AtmosModel &amodel)
 Constructs AlbedoAtm object using a Pvl, PhotoModel, and AtmosModel.
virtual ~AlbedoAtm ()
 Empty Destructor.
std::string AlgorithmName () const
 Return normalization algorithm name.
void CalcNrmAlbedo (double pha, double inc, double ema, double dn, double &albedo, double &mult, double &base)
 Calculate the normalization albedo using photometric angle information.
void CalcNrmAlbedo (double pha, double inc, double ema, double deminc, double demema, double dn, double &albedo, double &mult, double &base)
 Calculate the normalization albedo using photometric angle information.
virtual void SetNormWavelength (double wavelength)
 Set the wavelength parameter.

Protected Member Functions

virtual void NormModelAlgorithm (double pha, double inc, double ema, double dn, double &albedo, double &mult, double &base)
virtual void NormModelAlgorithm (double pha, double inc, double ema, double deminc, double demema, double dn, double &albedo, double &mult, double &base)
void SetAlgorithmName (std::string name)
PhotoModelGetPhotoModel ()
AtmosModelGetAtmosModel ()

Protected Attributes

double p_normWavelength

Private Member Functions

void SetNormIncref (const double incref)
 Set the normalization function parameter.

Private Attributes

double p_normPsurfref
double p_normIncref
double p_normPstdref
double p_normAhref
double p_normMunotref
double p_normTransref
double p_normTrans0ref
double p_normSbar


Constructor & Destructor Documentation

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

Constructs AlbedoAtm object using a Pvl, PhotoModel, and AtmosModel.

Parameters:
pvl 
pmodel 
amodel 

For internal use only.

History:
2008-11-05 Jeannie Walldren - Modified references to NumericalMethods class and replaced Isis::PI with PI since this is in Isis namespace.

Definition at line 22 of file AlbedoAtm.cpp.

References Isis::AtmosModel::AtmosAhSpline(), Isis::AtmosModel::CalcAtmEffect(), Isis::PhotoModel::CalcSurfAlbedo(), Evaluate(), Isis::NumericalApproximation::Extrapolate, Isis::AtmosModel::GenerateAhTable(), Isis::NormModel::GetAtmosModel(), Isis::NormModel::GetPhotoModel(), Isis::PvlContainer::HasKeyword(), p_normAhref, p_normIncref, p_normMunotref, p_normPstdref, p_normPsurfref, p_normSbar, p_normTrans0ref, p_normTransref, Isis::PI(), pvl(), SetNormIncref(), Isis::AtmosModel::SetStandardConditions(), Isis::PhotoModel::SetStandardConditions(), and Isis::PvlObject::Traverse.

virtual Isis::AlbedoAtm::~AlbedoAtm (  )  [inline, virtual]

Empty Destructor.

Definition at line 52 of file AlbedoAtm.h.


Member Function Documentation

std::string Isis::NormModel::AlgorithmName (  )  const [inline, inherited]

Return normalization algorithm name.

Definition at line 59 of file NormModel.h.

References Isis::NormModel::p_normAlgorithmName.

void Isis::NormModel::CalcNrmAlbedo ( double  pha,
double  inc,
double  ema,
double  deminc,
double  demema,
double  dn,
double &  albedo,
double &  mult,
double &  base 
) [inherited]

Calculate the normalization albedo using photometric angle information.

Parameters:
pha input phase angle
inc input incidence angle for ellipsoid
ema input emission angle for ellipsoid
deminc input incidence angle for dem
demema input emission angle for dem
dn input albedo value

Definition at line 83 of file NormModel.cpp.

void Isis::NormModel::CalcNrmAlbedo ( double  pha,
double  inc,
double  ema,
double  dn,
double &  albedo,
double &  mult,
double &  base 
) [inherited]

Calculate the normalization albedo using photometric angle information.

Parameters:
pha input phase angle
inc input incidence angle
ema input emission angle
dn input albedo value

Definition at line 58 of file NormModel.cpp.

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

void Isis::AlbedoAtm::NormModelAlgorithm ( double  phase,
double  incidence,
double  emission,
double  dn,
double &  albedo,
double &  mult,
double &  base 
) [protected, virtual]

Parameters:
phase Value of phase angle.
incidence Value of incidence angle.
emission Value of emission angle.
dn 
albedo 
mult 
base 

For internal use only.

History:
2008-11-05 Jeannie Walldren - Modified references to NumericalMethods class and replaced Isis::PI with PI since this is in Isis namespace.

Implements Isis::NormModel.

Definition at line 67 of file AlbedoAtm.cpp.

References _FILEINFO_, Isis::AtmosModel::AtmosAb(), Isis::AtmosModel::AtmosAhSpline(), Isis::AtmosModel::CalcAtmEffect(), Isis::PhotoModel::CalcSurfAlbedo(), Evaluate(), Isis::NumericalApproximation::Extrapolate, Isis::NormModel::GetAtmosModel(), Isis::NormModel::GetPhotoModel(), Isis::iException::Message(), p_normAhref, p_normMunotref, p_normPstdref, p_normPsurfref, p_normSbar, p_normTrans0ref, p_normTransref, and Isis::PI().

void Isis::AlbedoAtm::SetNormIncref ( const double  incref  )  [private]

Set the normalization function parameter.

This is the reference incidence angle to which the image photometry will be normalized. This parameter is limited to values that are >=0 and <90.

Parameters:
incref Normalization function parameter, default is 0.0

Definition at line 141 of file AlbedoAtm.cpp.

References _FILEINFO_, Isis::iException::Message(), and p_normIncref.

Referenced by AlbedoAtm().

void Isis::NormModel::SetNormWavelength ( double  wavelength  )  [virtual, inherited]

Set the wavelength parameter.

This value is obtained from the BandBin Center keyword of the image. This must be set by the application.

Definition at line 45 of file NormModel.cpp.

References Isis::NormModel::p_normWavelength.

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


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