USGS

Isis 3.0 Object Programmers' Reference

 Home
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Isis::MinnaertEmpirical Class Reference

Empirical Minnaert photometric model Derive model albedo using phase dependent Minnaert equation and calculated empirically. More...

#include <MinnaertEmpirical.h>

Inheritance diagram for Isis::MinnaertEmpirical:
Inheritance graph
Collaboration diagram for Isis::MinnaertEmpirical:
Collaboration graph

Public Member Functions

 MinnaertEmpirical (Pvl &pvl)
 
void SetPhotoPhaseList (QString phasestrlist)
 Set the empirical Minnaert function phase angle list.
 
void SetPhotoKList (QString kstrlist)
 Set the empirical Minnaert function K exponent list.
 
void SetPhotoPhaseCurveList (QString phasecurvestrlist)
 Set the empirical Minnaert function phase curve list.
 
virtual double PhotoModelAlgorithm (double phase, double incidence, double emission)
 Return photometric phase angle list.
 
QString AlgorithmName () const
 Return algorithm name found in Pvl file from constructor.
 
virtual void SetStandardConditions (bool standard)
 Sets whether standard conditions will be used.
 
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.
 
double PhtTopder (double phase, double incidence, double emission)
 Obtain topographic derivative of an arbitrary photometric function.
 
double CalcSurfAlbedo (double pha, double inc, double ema)
 Calculate the surface brightness using photometric angle information.
 
virtual void SetPhotoL (const double l)
 
double PhotoL () const
 Return photometric L value.
 
virtual void SetPhotoK (const double k)
 
double PhotoK () const
 Return photometric K value.
 
virtual void SetPhotoHg1 (const double hg1)
 
double PhotoHg1 () const
 Return photometric Hg1 value.
 
virtual void SetPhotoHg2 (const double hg2)
 
double PhotoHg2 () const
 Return photometric Hg2 value.
 
virtual void SetPhotoBh (const double bh)
 
double PhotoBh () const
 Return photometric Bh value.
 
virtual void SetPhotoCh (const double ch)
 
double PhotoCh () const
 Return photometric Ch value.
 
virtual void SetPhotoWh (const double wh)
 
double PhotoWh () const
 Return photometric Wh value.
 
virtual void SetPhotoHh (const double hh)
 
double PhotoHh () const
 Return photometric Hh value.
 
virtual void SetPhotoB0 (const double b0)
 
double PhotoB0 () const
 Return photometric B0 value.
 
virtual void SetPhotoTheta (const double theta)
 
double PhotoTheta () const
 Return photometric Theta value.
 
virtual void SetOldTheta (double theta)
 
virtual void SetPhoto0B0Standard (const std::string &b0standard)
 
std::string Photo0B0Standard () const
 Return photometric B0 standardization value.
 
double Hfunc (double u, double gamma)
 Hapke's approximation to Chandra's H function.
 
virtual void SetPhotoPhaseList (const std::string phasestrlist)
 
virtual void SetPhotoKList (const std::string kstrlist)
 
virtual void SetPhotoLList (const std::string kstrlist)
 
virtual void SetPhotoPhaseCurveList (const std::string phasecurvestrlist)
 
std::vector< double > PhotoPhaseList () const
 Return photometric phase angle list.
 
std::vector< double > PhotoKList () const
 Return photometric k value list.
 
std::vector< double > PhotoLList () const
 Return photometric l value list.
 
std::vector< double > PhotoPhaseCurveList () const
 Return photometric phase curve value list.
 

Static Public Member Functions

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

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
 
std::string 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
 

Detailed Description

Empirical Minnaert photometric model Derive model albedo using phase dependent Minnaert equation and calculated empirically.

Limb-darkening k and phase function are arbitrary polynomials in phase angle.

albedo = brightness*[mu / (mu*munot)**k)]
assumptions:
1. bidirectional reflectance
2. semi-infinite medium
k k-1
reflectance (inc,ema,phase)=albedo * munot * mu
Minnaert Minnaert

Where k is the Minnaert index, an empirical constant (called nu in Hapke)

If k (nu) = 1, Minnaert's law reduces to Lambert's law. See Theory of Reflectance and Emittance Spectroscopy, 1993; Bruce Hapke; pg. 191-192.

Author
1999-01-08 Randy Kirk
History:
2011-08-17 Janet Barrett - Ported from ISIS2 to ISIS3.

Definition at line 59 of file MinnaertEmpirical.h.

Member Function Documentation

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

Return algorithm name found in Pvl file from constructor.

Definition at line 61 of file PhotoModel.h.

References Isis::PhotoModel::p_photoAlgorithmName.

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 171 of file PhotoModel.cpp.

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

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

Hapke's approximation to Chandra's H function.

Definition at line 160 of file PhotoModel.h.

std::string Isis::PhotoModel::Photo0B0Standard ( ) const
inlineinherited

Return photometric B0 standardization value.

Definition at line 155 of file PhotoModel.h.

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

Return photometric B0 value.

Definition at line 139 of file PhotoModel.h.

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

Return photometric Bh value.

Definition at line 111 of file PhotoModel.h.

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

Return photometric Ch value.

Definition at line 118 of file PhotoModel.h.

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

Return photometric Hg1 value.

Definition at line 97 of file PhotoModel.h.

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

Return photometric Hg2 value.

Definition at line 104 of file PhotoModel.h.

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

Return photometric Hh value.

Definition at line 132 of file PhotoModel.h.

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

Return photometric K value.

Definition at line 90 of file PhotoModel.h.

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

Return photometric k value list.

Definition at line 175 of file PhotoModel.h.

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

Return photometric L value.

Definition at line 83 of file PhotoModel.h.

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

Return photometric l value list.

Definition at line 180 of file PhotoModel.h.

double Isis::MinnaertEmpirical::PhotoModelAlgorithm ( double  phase,
double  incidence,
double  emission 
)
virtual

Return photometric phase angle list.

Return photometric k value list Return photometric phase curve value list

Implements Isis::PhotoModel.

Definition at line 132 of file MinnaertEmpirical.cpp.

References Isis::NumericalApproximation::Evaluate(), Isis::NumericalApproximation::Extrapolate, and Isis::PI().

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

Return photometric phase curve value list.

Definition at line 185 of file PhotoModel.h.

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

Return photometric phase angle list.

Definition at line 170 of file PhotoModel.h.

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

Return photometric Theta value.

Definition at line 146 of file PhotoModel.h.

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

Return photometric Wh value.

Definition at line 125 of file PhotoModel.h.

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 144 of file PhotoModel.cpp.

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 58 of file PhotoModel.cpp.

References Isis::PI().

void Isis::MinnaertEmpirical::SetPhotoKList ( QString  kstrlist)

Set the empirical Minnaert function K exponent list.

This is used to govern the limb-darkening in the Minnaert photometric function. Values of the Minnaert exponent generally fall in the range from 0.5 ("lunar-like", almost no limb darkening) to 1.0 (Lambert function). This parameter is limited to values that are >=0.

Parameters
klistList of Minnaert function exponents to interpolate

Definition at line 98 of file MinnaertEmpirical.cpp.

References _FILEINFO_, Isis::IString::Token(), and Isis::IException::User.

void Isis::MinnaertEmpirical::SetPhotoPhaseCurveList ( QString  phasecurvestrlist)

Set the empirical Minnaert function phase curve list.

This list provides the brightness values that correspond to the limb-darkening values in the empirical Minnaert photometric function.

Parameters
phasecurvelistList of brightness values corresponding to Minnaert function exponents

Definition at line 121 of file MinnaertEmpirical.cpp.

References Isis::IString::Token().

void Isis::MinnaertEmpirical::SetPhotoPhaseList ( QString  phasestrlist)

Set the empirical Minnaert function phase angle list.

This is the list of phase angles that Minnaert K values and phase curve list values will be provided for. A spline curve will be used to interpolate K values and phase curve values that exist between the given phase angles. The values in the phase angle list are limited to values that are >=0 and <=180.

Parameters
phaselistList of phase angles to interpolate

Definition at line 73 of file MinnaertEmpirical.cpp.

References _FILEINFO_, Isis::IString::Token(), and Isis::IException::User.

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 44 of file PhotoModel.cpp.

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

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 67 of file PhotoModel.h.

References Isis::PhotoModel::p_standardConditions.

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