#include <Albedo.h>

Inheritance diagram for Isis::Albedo:

Collaboration diagram for Isis::Albedo:

Public Member Functions
	Albedo (Pvl &pvl, PhotoModel &pmodel)
	Constructs an Albedo object. More...

virtual	~Albedo ()

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)
	Performs the normalization. More...

virtual void	NormModelAlgorithm (double pha, double inc, double ema, double deminc, double demema, double dn, double &albedo, double &mult, double &base)
	Performs the normalization. More...

void	SetAlgorithmName (std::string name)

PhotoModel *	GetPhotoModel ()

AtmosModel *	GetAtmosModel ()

Protected Attributes
double	p_normWavelength

Detailed Description

Albedo normalization.

Consistent dividing out of photometric model at given an- gles and putting it back in at reference incidence but zero phase. Let the reference incidence default to zero. For Hapke model only, the photometric function multiplied back in will be modified to take out opposition effect. This requires saving the actual value of B0 while temporarily setting it to zero in the common block to compute the over- all normalization.

Author: 1998-12-21 Randy Kirk

Constructor & Destructor Documentation

◆ Albedo()

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

Constructs an Albedo object.

Parameters

pvl
pmodel

References Isis::PhotoModel::CalcSurfAlbedo(), Isis::PvlObject::findObject(), Isis::NormModel::GetPhotoModel(), Isis::PvlContainer::hasKeyword(), Isis::PhotoModel::SetStandardConditions(), and Isis::PvlObject::Traverse.

◆ ~Albedo()

virtual Isis::Albedo::~Albedo ( )

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

◆ GetAtmosModel()

AtmosModel* Isis::NormModel::GetAtmosModel ( )

inlineprotectedinherited

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

◆ GetPhotoModel()

PhotoModel* Isis::NormModel::GetPhotoModel ( )

inlineprotectedinherited

Referenced by Albedo(), Isis::AlbedoAtm::AlbedoAtm(), Isis::Mixed::Mixed(), NormModelAlgorithm(), Isis::AlbedoAtm::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::Albedo::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::PhotoModel::CalcSurfAlbedo(), Isis::NormModel::GetPhotoModel(), Isis::NULL8, and Isis::IException::Unknown.

◆ NormModelAlgorithm() [2/2]

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

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

/home/isis3mgr/repos/ISIS3/isis/src/base/objs/Albedo/Albedo.h
/home/isis3mgr/repos/ISIS3/isis/src/base/objs/Albedo/Albedo.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Albedo()

◆ ~Albedo()

Member Function Documentation

◆ AlgorithmName()

◆ CalcNrmAlbedo() [1/2]

◆ CalcNrmAlbedo() [2/2]

◆ GetAtmosModel()

◆ GetPhotoModel()

◆ NormModelAlgorithm() [1/2]

◆ NormModelAlgorithm() [2/2]

◆ SetAlgorithmName()

◆ SetNormWavelength()

Member Data Documentation

◆ p_normWavelength