Isis 3 Programmer Reference
Isis::Shade Class Reference

#include <Shade.h>

Inheritance diagram for Isis::Shade:
Inheritance graph
Collaboration diagram for Isis::Shade:
Collaboration graph

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)
 
PhotoModelGetPhotoModel ()
 
AtmosModelGetAtmosModel ()
 

Protected Attributes

double p_normWavelength
 

Private Attributes

double p_normPharef
 
double p_normIncref
 
double p_normEmaref
 
double p_normAlbedo
 

Detailed Description

Author
2003-04-08 Randy Kirk
History:

2007-07-31 Steven Lambright - Refactored code

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 the photometric angles from the ellipsoid or the DEM

Definition at line 45 of file Shade.h.

Member Function Documentation

◆ AlgorithmName()

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

Return normalization algorithm name.

Definition at line 59 of file NormModel.h.

◆ 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
phainput phase angle
incinput incidence angle
emainput emission angle
dninput albedo value

Definition at line 58 of file NormModel.cpp.

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

Definition at line 83 of file NormModel.cpp.

◆ 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
albedoNormalization function parameter

Definition at line 118 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
emarefNormalization function parameter, default is 0.0

Definition at line 100 of file Shade.cpp.

References _FILEINFO_, and 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
increfNormalization function parameter, default is 0.0

Definition at line 82 of file Shade.cpp.

References _FILEINFO_, and 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
pharefNormalization function parameter, default is 0.0

Definition at line 64 of file Shade.cpp.

References _FILEINFO_, and 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 45 of file NormModel.cpp.

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


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