Isis::Shade Class Reference

#include <Shade.h>

Inheritance diagram for Isis::Shade:

Collaboration diagram for Isis::Shade:

Public Member Functions
	Shade (Pvl &pvl, PhotoModel &pmodel)
void	SetNormPharef (const double pharef)
	Set parameters needed for albedo normalization. More...
void	SetNormIncref (const double incref)
	Set the normalization function parameter. More...
void	SetNormEmaref (const double emaref)
	Set the normalization function parameter. More...
void	SetNormAlbedo (const double albedo)
	Set the normalization function parameter. More...
std::string	AlgorithmName () const
	Return normalization algorithm name. More...
void	CalcNrmAlbedo (double pha, double inc, double ema, double dn, double &albedo, double &mult, double &base)
	Calculate the albedo normalization. More...
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. More...
virtual void	SetNormWavelength (double wavelength)
	Set the wavelength parameter. More...

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

2003-04-08 Randy Kirk

History:

2007-07-31 Steven Lambright - Refactored code

History:

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

History:

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

Definition at line 29 of file Shade.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.

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

SetNormAlbedo()

void Isis::Shade::SetNormAlbedo

(

const double

albedo

)

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 124 of file Shade.cpp.

SetNormEmaref()

void Isis::Shade::SetNormEmaref

(

const double

emaref

)

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 106 of file Shade.cpp.

References Isis::IException::User.

SetNormIncref()

void Isis::Shade::SetNormIncref

(

const double

incref

)

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 88 of file Shade.cpp.

References Isis::IException::User.

SetNormPharef()

void Isis::Shade::SetNormPharef

(

const double

pharef

)

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 70 of file Shade.cpp.

References Isis::IException::User.

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.

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

---

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

• src/base/objs/Shade/Shade.h
• src/base/objs/Shade/Shade.cpp