#include <ShadeAtm.h>

Inheritance diagram for Isis::ShadeAtm:

Collaboration diagram for Isis::ShadeAtm:

Public Member Functions
	ShadeAtm (Pvl &pvl, PhotoModel &pmodel, AtmosModel &amodel)

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 the normalization function parameter.

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

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

void	SetNormAlbedo (const double albedo)
	Set the normalization function parameter.

Private Attributes
double	p_normPharef

double	p_normIncref

double	p_normEmaref

double	p_normAlbedo

std::string	p_normAlgorithmName

PhotoModel *	p_normPM

AtmosModel *	p_normAM

Detailed Description

Author: 1998-12-21 Randy Kirk

History

2007-08-15 Steven Lambright - Refactored code

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

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 ellisoid and the DEM

Definition at line 35 of file ShadeAtm.h.

Constructor & Destructor Documentation

◆ ShadeAtm()

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

Definition at line 14 of file ShadeAtm.cpp.

◆ ~ShadeAtm()

virtual Isis::ShadeAtm::~ShadeAtm ( )

inlinevirtual

Definition at line 38 of file ShadeAtm.h.

Member Function Documentation

◆ AlgorithmName()

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

inlineinherited

Return normalization algorithm name.

Definition at line 43 of file NormModel.h.

◆ 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

Definition at line 89 of file NormModel.cpp.

◆ 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

Definition at line 64 of file NormModel.cpp.

◆ GetAtmosModel()

AtmosModel * Isis::NormModel::GetAtmosModel ( )

inlineprotectedinherited

Definition at line 69 of file NormModel.h.

◆ GetPhotoModel()

PhotoModel * Isis::NormModel::GetPhotoModel ( )

inlineprotectedinherited

Definition at line 66 of file NormModel.h.

◆ NormModelAlgorithm() [1/2]

void Isis::ShadeAtm::NormModelAlgorithm	(	double	pha,
		double	inc,
		double	ema,
		double	deminc,
		double	demema,
		double	dn,
		double &	albedo,
		double &	mult,
		double &	base )

protectedvirtual

Implements Isis::NormModel.

Definition at line 55 of file ShadeAtm.cpp.

◆ NormModelAlgorithm() [2/2]

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

inlineprotectedvirtual

Implements Isis::NormModel.

Definition at line 41 of file ShadeAtm.h.

◆ SetAlgorithmName()

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

inlineprotectedinherited

Definition at line 63 of file NormModel.h.

◆ SetNormAlbedo()

void Isis::ShadeAtm::SetNormAlbedo ( const double albedo )

private

Set the normalization function parameter.

This is the albedo (I/F value at incidence p_normIncref and zero phase) used to simulate a shaded relief image. To construct mosaics, the same value of albedo should be used for all images to achieve a uniform result.

Parameters

albedo Normalization function parameter

Definition at line 178 of file ShadeAtm.cpp.

References SetNormAlbedo().

Referenced by SetNormAlbedo().

◆ SetNormEmaref()

void Isis::ShadeAtm::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 160 of file ShadeAtm.cpp.

References SetNormEmaref(), and Isis::IException::User.

Referenced by SetNormEmaref().

◆ SetNormIncref()

void Isis::ShadeAtm::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 ShadeAtm.cpp.

References SetNormIncref(), and Isis::IException::User.

Referenced by SetNormIncref().

◆ SetNormPharef()

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

private

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 122 of file ShadeAtm.cpp.

References SetNormPharef(), and Isis::IException::User.

Referenced by SetNormPharef().

◆ 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.

Definition at line 51 of file NormModel.cpp.

Member Data Documentation

◆ p_normAlbedo

double Isis::ShadeAtm::p_normAlbedo

private

Definition at line 56 of file ShadeAtm.h.

◆ p_normAlgorithmName

std::string Isis::NormModel::p_normAlgorithmName

privateinherited

Definition at line 76 of file NormModel.h.

◆ p_normAM

AtmosModel* Isis::NormModel::p_normAM

privateinherited

Definition at line 78 of file NormModel.h.

◆ p_normEmaref

double Isis::ShadeAtm::p_normEmaref

private

Definition at line 55 of file ShadeAtm.h.

◆ p_normIncref

double Isis::ShadeAtm::p_normIncref

private

Definition at line 54 of file ShadeAtm.h.

◆ p_normPharef

double Isis::ShadeAtm::p_normPharef

private

Definition at line 53 of file ShadeAtm.h.

◆ p_normPM

PhotoModel* Isis::NormModel::p_normPM

privateinherited

Definition at line 77 of file NormModel.h.

◆ p_normWavelength

double Isis::NormModel::p_normWavelength

protectedinherited

Definition at line 73 of file NormModel.h.

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

src/base/objs/ShadeAtm/ShadeAtm.h
src/base/objs/ShadeAtm/ShadeAtm.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShadeAtm()

◆ ~ShadeAtm()

Member Function Documentation

◆ AlgorithmName()

◆ CalcNrmAlbedo() [1/2]

◆ CalcNrmAlbedo() [2/2]

◆ GetAtmosModel()

◆ GetPhotoModel()

◆ NormModelAlgorithm() [1/2]

◆ NormModelAlgorithm() [2/2]

◆ SetAlgorithmName()

◆ SetNormAlbedo()

◆ SetNormEmaref()

◆ SetNormIncref()

◆ SetNormPharef()

◆ SetNormWavelength()

Member Data Documentation

◆ p_normAlbedo

◆ p_normAlgorithmName

◆ p_normAM

◆ p_normEmaref

◆ p_normIncref

◆ p_normPharef

◆ p_normPM

◆ p_normWavelength