USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::Shade Class Reference

#include <Shade.h>

Inherits Isis::NormModel.

List of all members.

Public Member Functions

 Shade (Pvl &pvl, PhotoModel &pmodel)
virtual ~Shade ()
void SetNormPharef (const double pharef)
 Set parameters needed for albedo normalization.
void SetNormIncref (const double incref)
 Set the normalization function parameter.
void SetNormEmaref (const double emaref)
 Set the normalization function parameter.
void SetNormAlbedo (const double albedo)
 Set the normalization function parameter.
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)
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

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

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

virtual Isis::Shade::~Shade (  )  [inline, virtual]

Member Function Documentation

std::string Isis::NormModel::AlgorithmName (  )  const [inline, inherited]

Return normalization algorithm name.

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

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

AtmosModel* Isis::NormModel::GetAtmosModel (  )  [inline, protected, inherited]

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

PhotoModel* Isis::NormModel::GetPhotoModel (  )  [inline, protected, inherited]

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

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

Implements Isis::NormModel.

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

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

Implements Isis::NormModel.

void Isis::NormModel::SetAlgorithmName ( std::string  name  )  [inline, protected, inherited]
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().

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

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

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

void Isis::NormModel::SetNormWavelength ( double  wavelength  )  [virtual, inherited]

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

double Isis::NormModel::p_normWavelength [protected, inherited]

Referenced by Isis::MoonAlbedo::MoonAlbedo(), Isis::NormModel::NormModel(), and Isis::NormModel::SetNormWavelength().

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