#include <Shade.h>

Inheritance diagram for Isis::Shade:

Collaboration diagram for Isis::Shade:

Public Member Functions
	Shade (Pvl &pvl, PhotoModel &pmodel)

virtual	~Shade ()

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

Detailed Description

Author: 2003-04-08 Randy Kirk

Constructor & Destructor Documentation

◆ Shade()

Isis::Shade::Shade	(	Pvl &	pvl,
		PhotoModel &	pmodel
	)

References Isis::PvlObject::findObject(), Isis::PvlContainer::hasKeyword(), SetNormAlbedo(), SetNormEmaref(), SetNormIncref(), SetNormPharef(), and Isis::PvlObject::Traverse.

◆ ~Shade()

virtual Isis::Shade::~Shade ( )

inlinevirtual

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	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().

◆ CalcNrmAlbedo() [2/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().

◆ GetAtmosModel()

AtmosModel* Isis::NormModel::GetAtmosModel ( )

inlineprotectedinherited

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

◆ GetPhotoModel()

PhotoModel* Isis::NormModel::GetPhotoModel ( )

inlineprotectedinherited

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

◆ NormModelAlgorithm() [1/2]

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

inlineprotectedvirtual

Implements Isis::NormModel.

◆ NormModelAlgorithm() [2/2]

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

protectedvirtual

Implements Isis::NormModel.

References _FILEINFO_, Isis::PhotoModel::CalcSurfAlbedo(), Isis::NormModel::GetPhotoModel(), Isis::PhotoModel::SetStandardConditions(), and Isis::IException::Unknown.

◆ SetAlgorithmName()

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

inlineprotectedinherited

◆ 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

Referenced by Shade().

◆ 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

References _FILEINFO_, and Isis::IException::User.

Referenced by Shade().

◆ 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

References _FILEINFO_, and Isis::IException::User.

Referenced by Shade().

◆ 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

References _FILEINFO_, and Isis::IException::User.

Referenced by Shade().

◆ 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(), and Isis::NormModel::SetNormWavelength().

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

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/Shade/Shade.h
/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/Shade/Shade.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Shade()

◆ ~Shade()

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_normWavelength