Isis::Hapke Class Reference
[Radiometric And Photometric Correction]

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

#include <Hapke.h>

Inheritance diagram for Isis::Hapke:

[legend]

Collaboration diagram for Isis::Hapke:

[legend]

List of all members.

Public Member Functions
	Hapke (Pvl &pvl)
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)
	Return photometric B0 standardization value.
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.
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

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

For internal use only.

History:

2008-01-14 Janet Barret - Imported into Isis3 from Isis2.

History:

2008-03-07 Janet Barrett - Moved variables and related methods that pertain to Hapke specific parameters to the PhotoModel class.

History:

2008-06-18 Stuart Sides - Fixed doc error

History:

2008-10-17 Steven Lambright - Changed inheritance, moved HapkeHen specific methods into this class from the base class.

History:

2008-11-05 Jeannie Walldren - Added documentation from Isis2 files

History:

2012-10-15 Janet Barrett - Shortened the ZEROB0STANDARD parameter name to ZEROB0ST. This was done so that the GUI interface does not have to be resized every time it is opened. The shortened name helps to keep the parameters within the default GUI size when it is first opened. References #453. Fixes #1288.

Definition at line 61 of file Hapke.h.

---

Member Function Documentation

QString Isis::PhotoModel::AlgorithmName

(

)

const [inline, inherited]

Return algorithm name found in Pvl file from constructor.

Definition at line 61 of file PhotoModel.h.

References Isis::PhotoModel::p_photoAlgorithmName.

Referenced by Isis::AtmosModel::GenerateAhTable().

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

Calculate the surface brightness using photometric angle information.

Parameters:

	pha	Phase angle
	inc	Incidence angle
	ema	Emission angle

Returns:

double Surface brightness calculated by the photometric function

Definition at line 171 of file PhotoModel.cpp.

References albedo.

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

double Isis::PhotoModel::Hfunc	(	double	u,
		double	gamma
	)			[inline, inherited]

Hapke's approximation to Chandra's H function.

Definition at line 160 of file PhotoModel.h.

std::string Isis::PhotoModel::Photo0B0Standard

(

)

const [inline, inherited]

Return photometric B0 standardization value.

Definition at line 155 of file PhotoModel.h.

double Isis::PhotoModel::PhotoB0

(

)

const [inline, inherited]

Return photometric B0 value.

Definition at line 139 of file PhotoModel.h.

double Isis::PhotoModel::PhotoBh

(

)

const [inline, inherited]

Return photometric Bh value.

Definition at line 111 of file PhotoModel.h.

double Isis::PhotoModel::PhotoCh

(

)

const [inline, inherited]

Return photometric Ch value.

Definition at line 118 of file PhotoModel.h.

double Isis::PhotoModel::PhotoHg1

(

)

const [inline, inherited]

Return photometric Hg1 value.

Definition at line 97 of file PhotoModel.h.

double Isis::PhotoModel::PhotoHg2

(

)

const [inline, inherited]

Return photometric Hg2 value.

Definition at line 104 of file PhotoModel.h.

double Isis::PhotoModel::PhotoHh

(

)

const [inline, inherited]

Return photometric Hh value.

Definition at line 132 of file PhotoModel.h.

double Isis::PhotoModel::PhotoK

(

)

const [inline, inherited]

Return photometric K value.

Definition at line 90 of file PhotoModel.h.

std::vector<double> Isis::PhotoModel::PhotoKList

(

)

const [inline, inherited]

Return photometric k value list.

Definition at line 175 of file PhotoModel.h.

double Isis::PhotoModel::PhotoL

(

)

const [inline, inherited]

Return photometric L value.

Definition at line 83 of file PhotoModel.h.

std::vector<double> Isis::PhotoModel::PhotoLList

(

)

const [inline, inherited]

Return photometric l value list.

Definition at line 180 of file PhotoModel.h.

std::vector<double> Isis::PhotoModel::PhotoPhaseCurveList

(

)

const [inline, inherited]

Return photometric phase curve value list.

Definition at line 185 of file PhotoModel.h.

std::vector<double> Isis::PhotoModel::PhotoPhaseList

(

)

const [inline, inherited]

Return photometric phase angle list.

Definition at line 170 of file PhotoModel.h.

double Isis::PhotoModel::PhotoTheta

(

)

const [inline, inherited]

Return photometric Theta value.

Definition at line 146 of file PhotoModel.h.

double Isis::PhotoModel::PhotoWh

(

)

const [inline, inherited]

Return photometric Wh value.

Definition at line 125 of file PhotoModel.h.

double Isis::PhotoModel::PhtAcos

(

double

cosang

)

[static, inherited]

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:

cosang

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

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

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

Obtain topographic derivative of an arbitrary photometric function.

Parameters:

	phase	Input phase angle
	incidence	Input incidence angle
	emission	Input emission angle

Returns:

double Gradient

Definition at line 58 of file PhotoModel.cpp.

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

void Isis::Hapke::SetOldTheta

(

double

theta

)

[inline, virtual]

Return photometric Theta value.

Reimplemented from Isis::PhotoModel.

Definition at line 114 of file Hapke.h.

void Isis::Hapke::SetPhoto0B0Standard

(

const QString &

b0standard

)

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:

b0standard

Hapke opposition surge initialization, default is true

Definition at line 416 of file Hapke.cpp.

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

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:

b0

Hapke opposition surge component, default is 0.0

Reimplemented from Isis::PhotoModel.

Definition at line 400 of file Hapke.cpp.

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

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:

bh

Hapke Legendre coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

Definition at line 335 of file Hapke.cpp.

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

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:

ch

Hapke Legendre coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

Definition at line 352 of file Hapke.cpp.

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

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:

hg1

Hapke Henyey Greenstein coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

Definition at line 301 of file Hapke.cpp.

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

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:

hg2

Hapke Henyey Greenstein coefficient, default is 0.0

Reimplemented from Isis::PhotoModel.

Definition at line 318 of file Hapke.cpp.

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

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:

hh

Hapke opposition surge component, default is 0.0

Reimplemented from Isis::PhotoModel.

Definition at line 384 of file Hapke.cpp.

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

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:

theta

Hapke macroscopic roughness component, default is 0.0

Reimplemented from Isis::PhotoModel.

Definition at line 435 of file Hapke.cpp.

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

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:

wh

Hapke single scattering albedo component, default is 0.5

Reimplemented from Isis::PhotoModel.

Definition at line 368 of file Hapke.cpp.

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

void Isis::Hapke::SetStandardConditions

(

bool

standard

)

[virtual]

Return photometric B0 standardization value.

Hapke's approximation to Chandra's H function

Reimplemented from Isis::PhotoModel.

Definition at line 445 of file Hapke.cpp.

bool Isis::PhotoModel::StandardConditions

(

)

const [inline, inherited]

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:

• src/base/objs/Hapke/Hapke.h
• src/base/objs/Hapke/Hapke.cpp