Isis Developer Reference
Isis::Hapke Class Reference

Hapke-Henyey-Greenstein photometric model. More...

#include <Hapke.h>

Inheritance diagram for Isis::Hapke:
Inheritance graph
Collaboration diagram for Isis::Hapke:
Collaboration graph

Public Member Functions

 Hapke (Pvl &pvl)
 
virtual ~Hapke ()
 
void SetPhotoHg1 (const double hg1)
 Set the Hapke Henyey Greenstein coefficient for the single particle phase function.
 
void SetPhotoHg2 (const double hg2)
 Return photometric Hg1 value.
 
void SetPhotoBh (const double bh)
 Return photometric Hg2 value.
 
void SetPhotoCh (const double ch)
 Return photometric Bh value.
 
void SetPhotoWh (const double wh)
 Return photometric Ch value.
 
void SetPhotoHh (const double hh)
 Return photometric Wh value.
 
void SetPhotoB0 (const double b0)
 Return photometric Hh value.
 
void SetPhotoTheta (const double theta)
 Return photometric B0 value.
 
void SetOldTheta (double theta)
 Return photometric Theta value.
 
void SetPhoto0B0Standard (const QString &b0standard)
 Determine if the Hapke opposition surge component is initialized to zero during the SetStandardConditions phase.
 
void SetStandardConditions (bool standard)
 Sets whether standard conditions will be used.
 
virtual double PhotoModelAlgorithm (double phase, double incidence, double emission)
 
QString AlgorithmName () const
 Return algorithm name found in Pvl file from constructor.
 
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.
 
double PhotoHg1 () const
 Return photometric Hg1 value.
 
double PhotoHg2 () const
 Return photometric Hg2 value.
 
double PhotoBh () const
 Return photometric Bh value.
 
double PhotoCh () const
 Return photometric Ch value.
 
double PhotoWh () const
 Return photometric Wh value.
 
double PhotoHh () const
 Return photometric Hh value.
 
double PhotoB0 () const
 Return photometric B0 value.
 
double PhotoTheta () const
 Return photometric Theta value.
 
QString 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 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.
 
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
 
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
 

Detailed Description

Hapke-Henyey-Greenstein photometric model.

Derive model albedo using complete Hapke model with Henyey-Greenstein single-particle phase function whose coefficients are hg1 and hg2, plus single scattering albedo wh, opposition surge parameters hh and b0, and macroscopic roughness theta.

Author
1989-08-02 Unknown

Constructor & Destructor Documentation

◆ Hapke()

◆ ~Hapke()

virtual Isis::Hapke::~Hapke ( )
inlinevirtual

Member Function Documentation

◆ AlgorithmName()

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

Return algorithm name found in Pvl file from constructor.

Referenced by Isis::AtmosModel::GenerateAhTable(), and Hapke().

◆ CalcSurfAlbedo()

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

◆ Hfunc()

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

Hapke's approximation to Chandra's H function.

Referenced by PhotoModelAlgorithm().

◆ Photo0B0Standard()

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

Return photometric B0 standardization value.

References Isis::PhotoModel::p_photo0B0Standard.

◆ PhotoB0()

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

Return photometric B0 value.

References Isis::PhotoModel::p_photoB0.

◆ PhotoBh()

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

Return photometric Bh value.

References Isis::PhotoModel::p_photoBh.

◆ PhotoCh()

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

Return photometric Ch value.

References Isis::PhotoModel::p_photoCh.

◆ PhotoHg1()

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

Return photometric Hg1 value.

References Isis::PhotoModel::p_photoHg1.

◆ PhotoHg2()

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

Return photometric Hg2 value.

References Isis::PhotoModel::p_photoHg2.

◆ PhotoHh()

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

Return photometric Hh value.

References Isis::PhotoModel::p_photoHh.

◆ PhotoK()

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

Return photometric K value.

References Isis::PhotoModel::p_photoK.

◆ PhotoKList()

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

Return photometric k value list.

References Isis::PhotoModel::p_photoKList.

◆ PhotoL()

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

Return photometric L value.

References Isis::PhotoModel::p_photoL.

◆ PhotoLList()

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

Return photometric l value list.

References Isis::PhotoModel::p_photoLList.

◆ PhotoModelAlgorithm()

◆ PhotoPhaseCurveList()

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

Return photometric phase curve value list.

References Isis::PhotoModel::p_photoPhaseCurveList.

◆ PhotoPhaseList()

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

Return photometric phase angle list.

References Isis::PhotoModel::p_photoPhaseList.

◆ PhotoTheta()

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

Return photometric Theta value.

References Isis::PhotoModel::p_photoTheta.

◆ PhotoWh()

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

Return photometric Wh value.

References Isis::PhotoModel::p_photoWh.

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

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

◆ 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

References Isis::PhotoModel::CalcSurfAlbedo(), Isis::PhotoModel::PhtAcos(), and Isis::PI.

Referenced by Isis::Mixed::Mixed(), Isis::Mixed::NormModelAlgorithm(), Isis::Topo::NormModelAlgorithm(), Isis::TopoAtm::NormModelAlgorithm(), and Isis::TopoAtm::TopoAtm().

◆ SetOldTheta()

void Isis::Hapke::SetOldTheta ( double theta)
inline

Return photometric Theta value.

References Isis::PhotoModel::p_photoThetaold.

Referenced by PhotoModelAlgorithm().

◆ SetPhoto0B0Standard()

void Isis::Hapke::SetPhoto0B0Standard ( const QString & b0standard)
virtual

Determine if the Hapke opposition surge component is initialized to zero during the SetStandardConditions phase.

This parameter is limited to values that are true or false.

Parameters
b0standardHapke opposition surge initialization, default is true

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photo0B0Standard, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoB0()

void Isis::Hapke::SetPhotoB0 ( const double b0)
virtual

Return photometric Hh value.

Set the Hapke opposition surge component.

This is one of two opposition surge components needed for the Hapke model. This parameter is limited to values that are >=0.

Parameters
b0Hapke opposition surge component, default is 0.0

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoB0, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoBh()

void Isis::Hapke::SetPhotoBh ( const double bh)
virtual

Return photometric Hg2 value.

Set the Hapke Legendre coefficient for the single particle phase function.

This is one of two coefficients needed for the single particle phase function. This parameter is limited to values that are >=-1 and <=1.

Parameters
bhHapke Legendre coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoBh, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoCh()

void Isis::Hapke::SetPhotoCh ( const double ch)
virtual

Return photometric Bh value.

Set the Hapke Legendre coefficient for the single particle phase function.

This is one of two coefficients needed for the single particle phase function. This parameter is limited to values that are >=-1 and <=1.

Parameters
chHapke Legendre coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoCh, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoHg1()

void Isis::Hapke::SetPhotoHg1 ( const double hg1)
virtual

Set the Hapke Henyey Greenstein coefficient for the single particle phase function.

This is one of two coefficients needed for the single particle phase function. This parameter is limited to values that are >-1 and <1.

Parameters
hg1Hapke Henyey Greenstein coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoHg1, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoHg2()

void Isis::Hapke::SetPhotoHg2 ( const double hg2)
virtual

Return photometric Hg1 value.

Set the Hapke Henyey Greenstein coefficient for the single particle phase function.

This is one of two coefficients needed for the single particle phase function. This parameter is limited to values that are >=0 and <=1.

Parameters
hg2Hapke Henyey Greenstein coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoHg2, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoHh()

void Isis::Hapke::SetPhotoHh ( const double hh)
virtual

Return photometric Wh value.

Set the Hapke opposition surge component.

This is one of two opposition surge components needed for the Hapke model. This parameter is limited to values that are >=0.

Parameters
hhHapke opposition surge component, default is 0.0

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoHh, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoK()

virtual void Isis::PhotoModel::SetPhotoK ( const double k)
inlinevirtualinherited

Reimplemented in Isis::Minnaert.

References Isis::PhotoModel::p_photoK.

◆ SetPhotoKList()

virtual void Isis::PhotoModel::SetPhotoKList ( const QString )
inlinevirtualinherited

Reimplemented in Isis::MinnaertEmpirical.

◆ SetPhotoL()

virtual void Isis::PhotoModel::SetPhotoL ( const double l)
inlinevirtualinherited

Reimplemented in Isis::LunarLambert.

References Isis::PhotoModel::p_photoL.

◆ SetPhotoLList()

virtual void Isis::PhotoModel::SetPhotoLList ( const QString )
inlinevirtualinherited

Reimplemented in Isis::LunarLambertEmpirical.

◆ SetPhotoPhaseCurveList()

virtual void Isis::PhotoModel::SetPhotoPhaseCurveList ( const QString )
inlinevirtualinherited

◆ SetPhotoPhaseList()

virtual void Isis::PhotoModel::SetPhotoPhaseList ( const QString )
inlinevirtualinherited

◆ SetPhotoTheta()

void Isis::Hapke::SetPhotoTheta ( const double theta)
virtual

Return photometric B0 value.

Set the Hapke macroscopic roughness component.

This parameter is limited to values that are >=0 and <=90.

Parameters
thetaHapke macroscopic roughness component, default is 0.0

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoTheta, and Isis::IException::User.

Referenced by Hapke().

◆ SetPhotoWh()

void Isis::Hapke::SetPhotoWh ( const double wh)
virtual

Return photometric Ch value.

Set the Hapke single scattering albedo component.

This parameter is limited to values that are >0 and <=1.

Parameters
whHapke single scattering albedo component, default is 0.5

Reimplemented from Isis::PhotoModel.

References _FILEINFO_, Isis::PhotoModel::p_photoWh, and Isis::IException::User.

Referenced by Hapke().

◆ SetStandardConditions()

void Isis::Hapke::SetStandardConditions ( bool standard)
virtual

Sets whether standard conditions will be used.

Parameters
standardTrue if standard conditions are used.

Reimplemented from Isis::PhotoModel.

References Isis::PhotoModel::p_photo0B0Standard, Isis::PhotoModel::p_photoB0, Isis::PhotoModel::p_photoB0save, and Isis::PhotoModel::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.

Member Data Documentation

◆ p_algName

QString Isis::PhotoModel::p_algName
protectedinherited

Referenced by Hapke(), and PhotoModelAlgorithm().

◆ p_photo0B0Standard

QString Isis::PhotoModel::p_photo0B0Standard
protectedinherited

◆ p_photoB0

double Isis::PhotoModel::p_photoB0
protectedinherited

◆ p_photoB0save

double Isis::PhotoModel::p_photoB0save
protectedinherited

Referenced by Hapke(), and SetStandardConditions().

◆ p_photoBh

double Isis::PhotoModel::p_photoBh
protectedinherited

◆ p_photoBSpline

◆ p_photoCh

double Isis::PhotoModel::p_photoCh
protectedinherited

◆ p_photoCot2t

double Isis::PhotoModel::p_photoCot2t
protectedinherited

Referenced by PhotoModelAlgorithm().

◆ p_photoCott

double Isis::PhotoModel::p_photoCott
protectedinherited

Referenced by PhotoModelAlgorithm().

◆ p_photoHg1

double Isis::PhotoModel::p_photoHg1
protectedinherited

◆ p_photoHg2

double Isis::PhotoModel::p_photoHg2
protectedinherited

◆ p_photoHh

double Isis::PhotoModel::p_photoHh
protectedinherited

◆ p_photoK

double Isis::PhotoModel::p_photoK
protectedinherited

◆ p_photoKList

◆ p_photoKSpline

◆ p_photoL

◆ p_photoLList

◆ p_photoLSpline

◆ p_photoOsr

double Isis::PhotoModel::p_photoOsr
protectedinherited

Referenced by PhotoModelAlgorithm().

◆ p_photoPhaseAngleCount

int Isis::PhotoModel::p_photoPhaseAngleCount
protectedinherited

◆ p_photoPhaseCurveList

◆ p_photoPhaseList

◆ p_photoSr

double Isis::PhotoModel::p_photoSr
protectedinherited

Referenced by PhotoModelAlgorithm().

◆ p_photoTant

double Isis::PhotoModel::p_photoTant
protectedinherited

Referenced by PhotoModelAlgorithm().

◆ p_photoTheta

double Isis::PhotoModel::p_photoTheta
protectedinherited

◆ p_photoThetaold

double Isis::PhotoModel::p_photoThetaold
protectedinherited

◆ p_photoWh

double Isis::PhotoModel::p_photoWh
protectedinherited

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