USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::NormModel Class Reference

#include <NormModel.h>

Inherited by Isis::Albedo, Isis::AlbedoAtm, Isis::Mixed, Isis::MoonAlbedo, Isis::NoNormalization, Isis::Shade, Isis::ShadeAtm, Isis::Topo, and Isis::TopoAtm.

List of all members.

Public Member Functions

 NormModel (Pvl &pvl, PhotoModel &pmodel)
 Create a NormModel object.
 NormModel (Pvl &pvl, PhotoModel &pmodel, AtmosModel &amodel)
 Create a NormModel object.
virtual ~NormModel ()
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)=0
virtual void NormModelAlgorithm (double pha, double inc, double ema, double deminc, double demema, double dn, double &albedo, double &mult, double &base)=0
void SetAlgorithmName (std::string name)
PhotoModelGetPhotoModel ()
AtmosModelGetAtmosModel ()

Protected Attributes

double p_normWavelength

Detailed Description

Author:
1998-12-21 Randy Kirk

Constructor & Destructor Documentation

Isis::NormModel::NormModel ( Pvl pvl,
PhotoModel pmodel 
)

Create a NormModel object.

Because this is a pure virtual class you can not create a NormModel class directly. Instead, see the NormModelFactory class.

Parameters:
pvl A pvl object containing a valid NormModel specification
See also:
normalizationModels.doc

References p_normWavelength.

Isis::NormModel::NormModel ( Pvl pvl,
PhotoModel pmodel,
AtmosModel amodel 
)

Create a NormModel object.

Because this is a pure virtual class you can not create a NormModel class directly. Instead, see the NormModelFactory class.

Parameters:
pvl A pvl object containing a valid NormModel specification
See also:
normalizationModels.doc

References p_normWavelength.

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

Member Function Documentation

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

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 
)

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

void Isis::NormModel::CalcNrmAlbedo ( double  pha,
double  inc,
double  ema,
double  dn,
double &  albedo,
double &  mult,
double &  base 
)

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

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

AtmosModel* Isis::NormModel::GetAtmosModel (  )  [inline, protected]
PhotoModel* Isis::NormModel::GetPhotoModel (  )  [inline, protected]
virtual void Isis::NormModel::NormModelAlgorithm ( double  pha,
double  inc,
double  ema,
double  deminc,
double  demema,
double  dn,
double &  albedo,
double &  mult,
double &  base 
) [protected, pure virtual]
virtual void Isis::NormModel::NormModelAlgorithm ( double  pha,
double  inc,
double  ema,
double  dn,
double &  albedo,
double &  mult,
double &  base 
) [protected, pure virtual]
void Isis::NormModel::SetAlgorithmName ( std::string  name  )  [inline, protected]
void Isis::NormModel::SetNormWavelength ( double  wavelength  )  [virtual]

Set the wavelength parameter.

This value is obtained from the BandBin Center keyword of the image. This must be set by the application.

References p_normWavelength.

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


Member Data Documentation


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