Isis Developer Reference
Isis::AlbedoAtm Class Reference

Albedo normalization with atmosphere. More...

#include <AlbedoAtm.h>

Inheritance diagram for Isis::AlbedoAtm:
Inheritance graph
Collaboration diagram for Isis::AlbedoAtm:
Collaboration graph

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)
 Performs the normalization.
 
virtual void NormModelAlgorithm (double pha, double inc, double ema, double deminc, double demema, double dn, double &albedo, double &mult, double &base)
 Performs the normalization.
 
void SetAlgorithmName (std::string name)
 
PhotoModelGetPhotoModel ()
 
AtmosModelGetAtmosModel ()
 

Protected Attributes

double p_normWavelength
 

Detailed Description

Albedo normalization with atmosphere.

Author
1998-12-21 Randy Kirk

Constructor & Destructor Documentation

◆ AlbedoAtm()

◆ ~AlbedoAtm()

virtual Isis::AlbedoAtm::~AlbedoAtm ( )
inlinevirtual

Empty Destructor.

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
phainput phase angle
incinput incidence angle for ellipsoid
emainput emission angle for ellipsoid
demincinput incidence angle for dem
dememainput emission angle for dem
dninput 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
phainput phase angle
incinput incidence angle
emainput emission angle
dninput albedo value

References Isis::NormModel::NormModelAlgorithm().

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

◆ GetAtmosModel()

AtmosModel * Isis::NormModel::GetAtmosModel ( )
inlineprotectedinherited

◆ GetPhotoModel()

◆ NormModelAlgorithm() [1/2]

void Isis::AlbedoAtm::NormModelAlgorithm ( double phase,
double incidence,
double emission,
double demincidence,
double dememission,
double dn,
double & albedo,
double & mult,
double & base )
protectedvirtual

Performs the normalization.

Parameters
phaseThe phase angle.
incidenceThe incidence angle.
emissionThe emission angle.
demincidenceThe local incidence angle
dememissionThe local emission angle
dnThe DN value
albedo???
multThe multiplier of the image
baseThe base of the image

Implements Isis::NormModel.

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

◆ NormModelAlgorithm() [2/2]

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

Performs the normalization.

Parameters
phaThe phase angle.
incThe incidence angle.
emaThe emission angle.
dnThe DN value
albedo???
multThe multiplier of the image
baseThe 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

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