Isis 3 Programmer Reference
Isis::LunarLambert Class Reference

Lunar (Lommel-Seeliger)-Lambert law photometric model Derive model albedo for Lunar (Lommel-Seeliger)-Lambert law. More...

#include <LunarLambert.h>

Inheritance diagram for Isis::LunarLambert:
Inheritance graph
Collaboration diagram for Isis::LunarLambert:
Collaboration graph

Public Member Functions

 LunarLambert (Pvl &pvl)
 
void SetPhotoL (const double l)
 Set the Lunar-Lambert function weight. More...
 
QString AlgorithmName () const
 Return algorithm name found in Pvl file from constructor. More...
 
virtual void SetStandardConditions (bool standard)
 Sets whether standard conditions will be used. More...
 
bool StandardConditions () const
 Returns true if standard conditions are used, i.e., if SetStandardConditions(true) has been called. This is initialized to false in the constructor. More...
 
double PhtTopder (double phase, double incidence, double emission)
 Obtain topographic derivative of an arbitrary photometric function. More...
 
double CalcSurfAlbedo (double pha, double inc, double ema)
 Calculate the surface brightness using photometric angle information. More...
 
double PhotoL () const
 Return photometric L value. More...
 
virtual void SetPhotoK (const double k)
 
double PhotoK () const
 Return photometric K value. More...
 
virtual void SetPhotoHg1 (const double hg1)
 
double PhotoHg1 () const
 Return photometric Hg1 value. More...
 
virtual void SetPhotoHg2 (const double hg2)
 
double PhotoHg2 () const
 Return photometric Hg2 value. More...
 
virtual void SetPhotoBh (const double bh)
 
double PhotoBh () const
 Return photometric Bh value. More...
 
virtual void SetPhotoCh (const double ch)
 
double PhotoCh () const
 Return photometric Ch value. More...
 
virtual void SetPhotoWh (const double wh)
 
double PhotoWh () const
 Return photometric Wh value. More...
 
virtual void SetPhotoHh (const double hh)
 
double PhotoHh () const
 Return photometric Hh value. More...
 
virtual void SetPhotoB0 (const double b0)
 
double PhotoB0 () const
 Return photometric B0 value. More...
 
virtual void SetPhotoTheta (const double theta)
 
double PhotoTheta () const
 Return photometric Theta value. More...
 
virtual void SetPhoto0B0Standard (const QString &b0standard)
 
QString Photo0B0Standard () const
 Return photometric B0 standardization value. More...
 
double Hfunc (double u, double gamma)
 Hapke's approximation to Chandra's H function. More...
 
virtual void SetPhotoPhaseList (const QString)
 
virtual void SetPhotoKList (const QString)
 
virtual void SetPhotoLList (const QString)
 
virtual void SetPhotoPhaseCurveList (const QString)
 
std::vector< double > PhotoPhaseList () const
 Return photometric phase angle list. More...
 
std::vector< double > PhotoKList () const
 Return photometric k value list. More...
 
std::vector< double > PhotoLList () const
 Return photometric l value list. More...
 
std::vector< double > PhotoPhaseCurveList () const
 Return photometric phase curve value list. More...
 

Static Public Member Functions

static double PhtAcos (double cosang)
 Obtain arccosine of input value. More...
 

Protected Member Functions

virtual double PhotoModelAlgorithm (double phase, double incidence, double emission)
 Return photometric L value. More...
 

Protected Attributes

double p_photoL
 
double p_photoK
 
double p_photoHg1
 
double p_photoHg2
 
double p_photoBh
 
double p_photoCh
 
double p_photoCott
 
double p_photoCot2t
 
double p_photoTant
 
double p_photoSr
 
double p_photoOsr
 
QString p_algName
 
QString p_photo0B0Standard
 
double p_photoWh
 
double p_photoHh
 
double p_photoB0
 
double p_photoB0save
 
double p_photoTheta
 
double p_photoThetaold
 
std::vector< double > p_photoPhaseList
 
std::vector< double > p_photoKList
 
std::vector< double > p_photoLList
 
std::vector< double > p_photoPhaseCurveList
 
int p_photoPhaseAngleCount
 
NumericalApproximation p_photoKSpline
 
NumericalApproximation p_photoLSpline
 
NumericalApproximation p_photoBSpline
 

Private Attributes

QString p_photoAlgorithmName
 Unique name of the photometric model. More...
 
bool p_standardConditions
 Indicates whether standard conditions are used. More...
 

Detailed Description

Lunar (Lommel-Seeliger)-Lambert law photometric model Derive model albedo for Lunar (Lommel-Seeliger)-Lambert law.

Phase independent and calculated analytically. Lommel-Seeliger law:

Reflectance=1/(1+cos(E)/cos(I))

Where: E=the angle between the observer and the slope normal I=the angle between the sun and the slope normal

Author
1999-01-08 Randy Kirk
History:
2007-07-31 Steven Lambright - Moved PhotoL from base PhotoModel class to this child.

Definition at line 32 of file LunarLambert.h.

Member Function Documentation

◆ AlgorithmName()

QString Isis::PhotoModel::AlgorithmName ( ) const
inlineinherited

Return algorithm name found in Pvl file from constructor.

Definition at line 47 of file PhotoModel.h.

References Isis::PhotoModel::p_photoAlgorithmName.

◆ CalcSurfAlbedo()

double Isis::PhotoModel::CalcSurfAlbedo ( double  pha,
double  inc,
double  ema 
)
inherited

Calculate the surface brightness using photometric angle information.

Parameters
phaPhase angle
incIncidence angle
emaEmission angle
Returns
double Surface brightness calculated by the photometric function

Definition at line 177 of file PhotoModel.cpp.

Referenced by Isis::Albedo::Albedo(), Isis::AlbedoAtm::AlbedoAtm(), Isis::NumericalAtmosApprox::InrFunc2Bint(), Isis::Albedo::NormModelAlgorithm(), and Isis::AlbedoAtm::NormModelAlgorithm().

◆ Hfunc()

double Isis::PhotoModel::Hfunc ( double  u,
double  gamma 
)
inlineinherited

Hapke's approximation to Chandra's H function.

Definition at line 168 of file PhotoModel.h.

◆ Photo0B0Standard()

QString Isis::PhotoModel::Photo0B0Standard ( ) const
inlineinherited

Return photometric B0 standardization value.

Definition at line 163 of file PhotoModel.h.

◆ PhotoB0()

double Isis::PhotoModel::PhotoB0 ( ) const
inlineinherited

Return photometric B0 value.

Definition at line 143 of file PhotoModel.h.

◆ PhotoBh()

double Isis::PhotoModel::PhotoBh ( ) const
inlineinherited

Return photometric Bh value.

Definition at line 107 of file PhotoModel.h.

◆ PhotoCh()

double Isis::PhotoModel::PhotoCh ( ) const
inlineinherited

Return photometric Ch value.

Definition at line 116 of file PhotoModel.h.

◆ PhotoHg1()

double Isis::PhotoModel::PhotoHg1 ( ) const
inlineinherited

Return photometric Hg1 value.

Definition at line 89 of file PhotoModel.h.

◆ PhotoHg2()

double Isis::PhotoModel::PhotoHg2 ( ) const
inlineinherited

Return photometric Hg2 value.

Definition at line 98 of file PhotoModel.h.

◆ PhotoHh()

double Isis::PhotoModel::PhotoHh ( ) const
inlineinherited

Return photometric Hh value.

Definition at line 134 of file PhotoModel.h.

◆ PhotoK()

double Isis::PhotoModel::PhotoK ( ) const
inlineinherited

Return photometric K value.

Definition at line 80 of file PhotoModel.h.

◆ PhotoKList()

std::vector<double> Isis::PhotoModel::PhotoKList ( ) const
inlineinherited

Return photometric k value list.

Definition at line 183 of file PhotoModel.h.

◆ PhotoL()

double Isis::PhotoModel::PhotoL ( ) const
inlineinherited

Return photometric L value.

Definition at line 71 of file PhotoModel.h.

◆ PhotoLList()

std::vector<double> Isis::PhotoModel::PhotoLList ( ) const
inlineinherited

Return photometric l value list.

Definition at line 188 of file PhotoModel.h.

◆ PhotoModelAlgorithm()

double Isis::LunarLambert::PhotoModelAlgorithm ( double  phase,
double  incidence,
double  emission 
)
protectedvirtual

Return photometric L value.

Implements Isis::PhotoModel.

Definition at line 35 of file LunarLambert.cpp.

References Isis::PI.

◆ PhotoPhaseCurveList()

std::vector<double> Isis::PhotoModel::PhotoPhaseCurveList ( ) const
inlineinherited

Return photometric phase curve value list.

Definition at line 193 of file PhotoModel.h.

◆ PhotoPhaseList()

std::vector<double> Isis::PhotoModel::PhotoPhaseList ( ) const
inlineinherited

Return photometric phase angle list.

Definition at line 178 of file PhotoModel.h.

◆ PhotoTheta()

double Isis::PhotoModel::PhotoTheta ( ) const
inlineinherited

Return photometric Theta value.

Definition at line 152 of file PhotoModel.h.

◆ PhotoWh()

double Isis::PhotoModel::PhotoWh ( ) const
inlineinherited

Return photometric Wh value.

Definition at line 125 of file PhotoModel.h.

◆ PhtAcos()

double Isis::PhotoModel::PhtAcos ( double  cosang)
staticinherited

Obtain arccosine of input value.

If the input value is outside of the valid range (-1 to 1), then obtain the arccosine of the closest valid value.

Parameters
cosanginput value to obtain arccosine of (in radians)
Returns
double Arccosine of cosang, if valid.
History:
2008-11-05 Jeannie Walldren - This method was moved from NumericalMethods class.

Definition at line 150 of file PhotoModel.cpp.

◆ PhtTopder()

double Isis::PhotoModel::PhtTopder ( double  phase,
double  incidence,
double  emission 
)
inherited

Obtain topographic derivative of an arbitrary photometric function.

Parameters
phaseInput phase angle
incidenceInput incidence angle
emissionInput emission angle
Returns
double Gradient

Definition at line 64 of file PhotoModel.cpp.

References Isis::PI.

◆ SetPhotoL()

void Isis::LunarLambert::SetPhotoL ( const double  l)
virtual

Set the Lunar-Lambert function weight.

This is used to govern the limb-darkening in the Lunar-Lambert photometric function. Values of the Lunar-Lambert weight generally fall in the range from 0.0 (Lambert function) to 1.0 (Lommel-Seeliger or "lunar" function). There are no limits on the value of this parameter, but values far outside the 0 to 1 range will not be very useful.

Parameters
lLunar-Lambert function weight, default is 1.0

Reimplemented from Isis::PhotoModel.

Definition at line 31 of file LunarLambert.cpp.

◆ SetStandardConditions()

void Isis::PhotoModel::SetStandardConditions ( bool  standard)
virtualinherited

Sets whether standard conditions will be used.

Parameters
standardTrue if standard conditions are used.

Reimplemented in Isis::Hapke.

Definition at line 50 of file PhotoModel.cpp.

Referenced by Isis::Albedo::Albedo(), Isis::AlbedoAtm::AlbedoAtm(), and Isis::Hapke::SetStandardConditions().

◆ StandardConditions()

bool Isis::PhotoModel::StandardConditions ( ) const
inlineinherited

Returns true if standard conditions are used, i.e., if SetStandardConditions(true) has been called. This is initialized to false in the constructor.

Definition at line 53 of file PhotoModel.h.

References Isis::PhotoModel::p_standardConditions.

Member Data Documentation

◆ p_photoAlgorithmName

QString Isis::PhotoModel::p_photoAlgorithmName
privateinherited

Unique name of the photometric model.

Definition at line 232 of file PhotoModel.h.

Referenced by Isis::PhotoModel::AlgorithmName().

◆ p_standardConditions

bool Isis::PhotoModel::p_standardConditions
privateinherited

Indicates whether standard conditions are used.

Definition at line 234 of file PhotoModel.h.

Referenced by Isis::PhotoModel::StandardConditions().


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