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)

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)

PhotoModel *	GetPhotoModel ()

AtmosModel *	GetAtmosModel ()

Protected Attributes
double	p_normWavelength

Private Member Functions
void	SetNormPharef (const double pharef)
	Set parameters needed for albedo normalization.

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

void	SetNormEmaref (const double emaref)
	Set the normalization function parameter.

Private Attributes
double	p_normPsurfref

double	p_normPharef

double	p_normIncref

double	p_normEmaref

double	p_normPstdref

double	p_normAhref

double	p_normMunotref

double	p_normTransref

double	p_normTrans0ref

double	p_normTranss

double	p_normSbar

Detailed Description

Albedo normalization with atmosphere.

Author: 1998-12-21 Randy Kirk

History:

2007-08-15 Steven Lambright - Refactored code and fixed unit test

2008-06-18 Christopher Austin - Fixed documentation errors

2008-11-05 Jeannie Walldren - Modified references to NumericalMethods class.

2008-11-07 Jeannie Walldren - Fixed documentation.

2009-05-11 Janet Barrett - Fixed so that the NormModelAlgorithm supporting DEM input is the empty function. DEM input is not yet supported.

2010-11-10 Janet Barrett - Added reference parameters for phase and emission so user can specify normalization conditions in initialization

2010-11-30 Janet Barrett - Added ability to use photometric angles from the ellipsoid and the DEM

Definition at line 53 of file AlbedoAtm.h.

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

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 23 of file AlbedoAtm.cpp.

References Isis::AtmosModel::AtmosAhSpline(), Isis::AtmosModel::CalcAtmEffect(), Isis::PhotoModel::CalcSurfAlbedo(), Isis::NumericalApproximation::Extrapolate, Isis::PvlObject::findObject(), Isis::AtmosModel::GenerateAhTable(), Isis::PvlContainer::hasKeyword(), Isis::PI(), SetNormEmaref(), SetNormIncref(), SetNormPharef(), Isis::PhotoModel::SetStandardConditions(), Isis::AtmosModel::SetStandardConditions(), and Isis::PvlObject::Traverse.

virtual Isis::AlbedoAtm::~AlbedoAtm ( )

inlinevirtual

Empty Destructor.

Definition at line 57 of file AlbedoAtm.h.

Member Function Documentation

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

inlineinherited

Return normalization algorithm name.

Definition at line 59 of file NormModel.h.

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

Definition at line 58 of file NormModel.cpp.

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

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::AlbedoAtm::NormModelAlgorithm	(	double	phase,
		double	incidence,
		double	emission,
		double	demincidence,
		double	dememission,
		double	dn,
		double &	albedo,
		double &	mult,
		double &	base
	)

protectedvirtual

Parameters

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

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 82 of file AlbedoAtm.cpp.

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

void Isis::AlbedoAtm::SetNormEmaref ( const double emaref )

private

Set the normalization function parameter.

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

Parameters

emaref Normalization function parameter, default is 0.0

Definition at line 213 of file AlbedoAtm.cpp.

References _FILEINFO_, Isis::toString(), and Isis::IException::User.

Referenced by AlbedoAtm().

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 194 of file AlbedoAtm.cpp.

References _FILEINFO_, Isis::toString(), and Isis::IException::User.

Referenced by AlbedoAtm().

void Isis::AlbedoAtm::SetNormPharef ( const double pharef )

private

Set parameters needed for albedo normalization.

Set the normalization function parameter.

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

Parameters

pharef Normalization function parameter, default is 0.0

Definition at line 175 of file AlbedoAtm.cpp.

References _FILEINFO_, Isis::toString(), and Isis::IException::User.

Referenced by AlbedoAtm().

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.

Definition at line 45 of file NormModel.cpp.

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

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

src/base/objs/AlbedoAtm/AlbedoAtm.h
src/base/objs/AlbedoAtm/AlbedoAtm.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation