Isis::AlbedoAtm Class Reference

Albedo normalization with atmosphere. More...

#include <AlbedoAtm.h>

Inheritance diagram for Isis::AlbedoAtm:

Collaboration diagram for Isis::AlbedoAtm:

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 albedo normalization.
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)
	Performs the normalization.
virtual void	NormModelAlgorithm (double pha, double inc, double ema, double deminc, double demema, double dn, double &albedo, double &mult, double &base)
	Performs the normalization.
void	SetAlgorithmName (std::string name)
PhotoModel *	GetPhotoModel ()
AtmosModel *	GetAtmosModel ()

Protected Attributes
double	p_normWavelength

Detailed Description

Albedo normalization with atmosphere.

Author

1998-12-21 Randy Kirk

Constructor & Destructor Documentation

AlbedoAtm()

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

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

Parameters

pvl
pmodel
amodel

References Isis::AtmosModel::AtmosAhSpline(), Isis::AtmosModel::CalcAtmEffect(), Isis::PhotoModel::CalcSurfAlbedo(), Isis::NumericalApproximation::Extrapolate, Isis::AtmosModel::GenerateAhTable(), Isis::NormModel::GetAtmosModel(), Isis::NormModel::GetPhotoModel(), Isis::PI, Isis::AtmosModel::SetStandardConditions(), Isis::PhotoModel::SetStandardConditions(), and Isis::PvlObject::Traverse.

~AlbedoAtm()

virtual Isis::AlbedoAtm::~AlbedoAtm ( )

inlinevirtual

Empty Destructor.

Member Function Documentation

AlgorithmName()

std::string Isis::NormModel::AlgorithmName ( ) const

inlineinherited

Return normalization algorithm name.

CalcNrmAlbedo() [1/2]

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

References Isis::NormModel::NormModelAlgorithm().

CalcNrmAlbedo() [2/2]

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

inherited

Calculate the albedo normalization.

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

References Isis::NormModel::NormModelAlgorithm().

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

GetAtmosModel()

AtmosModel * Isis::NormModel::GetAtmosModel ( )

inlineprotectedinherited

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

GetPhotoModel()

PhotoModel * Isis::NormModel::GetPhotoModel ( )

inlineprotectedinherited

Referenced by Isis::Albedo::Albedo(), AlbedoAtm(), Isis::Mixed::Mixed(), Isis::Albedo::NormModelAlgorithm(), NormModelAlgorithm(), Isis::Mixed::NormModelAlgorithm(), Isis::MoonAlbedo::NormModelAlgorithm(), Isis::NoNormalization::NormModelAlgorithm(), Isis::Shade::NormModelAlgorithm(), Isis::ShadeAtm::NormModelAlgorithm(), Isis::Topo::NormModelAlgorithm(), Isis::TopoAtm::NormModelAlgorithm(), and Isis::TopoAtm::TopoAtm().

NormModelAlgorithm() [1/2]

void Isis::AlbedoAtm::NormModelAlgorithm ( double phase, double incidence, double emission, double demincidence, double dememission, double dn, double & albedo, double & mult, double & base )

protectedvirtual

Performs the normalization.

Parameters

phase	The phase angle.
incidence	The incidence angle.
emission	The emission angle.
demincidence	The local incidence angle
dememission	The local emission angle
dn	The DN value
albedo	???
mult	The multiplier of the image
base	The base of the image

Implements Isis::NormModel.

References _FILEINFO_, Isis::AtmosModel::AtmosAb(), Isis::AtmosModel::AtmosAhSpline(), Isis::AtmosModel::CalcAtmEffect(), Isis::PhotoModel::CalcSurfAlbedo(), Isis::NumericalApproximation::Extrapolate, Isis::NormModel::GetAtmosModel(), Isis::NormModel::GetPhotoModel(), Isis::PI, and Isis::IException::Unknown.

NormModelAlgorithm() [2/2]

virtual void Isis::AlbedoAtm::NormModelAlgorithm ( double pha, double inc, double ema, double dn, double & albedo, double & mult, double & base )

inlineprotectedvirtual

Performs the normalization.

Parameters

pha	The phase angle.
inc	The incidence angle.
ema	The emission angle.
dn	The DN value
albedo	???
mult	The multiplier of the image
base	The base of the image

Implements Isis::NormModel.

SetAlgorithmName()

void Isis::NormModel::SetAlgorithmName ( std::string name )

inlineprotectedinherited

SetNormWavelength()

void Isis::NormModel::SetNormWavelength ( double wavelength )

virtualinherited

Set the wavelength parameter.

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

References Isis::NormModel::p_normWavelength.

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

Member Data Documentation

p_normWavelength

double Isis::NormModel::p_normWavelength

protectedinherited

Referenced by Isis::MoonAlbedo::MoonAlbedo(), Isis::NormModel::NormModel(), Isis::NormModel::NormModel(), and Isis::NormModel::SetNormWavelength().

---

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

• /Users/chkim/repos/ISIS3/isis/src/base/objs/AlbedoAtm/AlbedoAtm.h
• /Users/chkim/repos/ISIS3/isis/src/base/objs/AlbedoAtm/AlbedoAtm.cpp