HiRISE

HiRISE.HiPlan.HIPHOP
Class Mu_Parameters

java.lang.Object
  extended by HiRISE.HiPlan.HIPHOP.Mu_Parameters

public class Mu_Parameters
extends Object

A collection of Hapke μ parameters. These parameters are used in Hapke's rough-surfaced photometric function to compute a shadowing function. They may be computed via Functions.mu_rough(double,double,double,double).

Version:
1.4
Author:
Christian Schaller - UA/PIRL
See Also:
"Hapke, B. 1984. Bidirectional reflectance spectroscopy. 3. Correction for Macroscopic Roughness. Icarus 59, 41-59."

Field Summary
static String ID
          Class identification name with source code version and date.
 
Constructor Summary
Mu_Parameters()
          Creates a default set of Hapke mu parameters.
Mu_Parameters(double mu_prime, double mu_prime_0, double mu_0_prime, double mu_0_prime_0)
          Creates a set of Hapke mu parameters as specified.
 
Method Summary
 double mu_0_prime_0()
          Gets the value of μ0'0.
 void mu_0_prime_0(double mu_0_prime_0)
          Sets the value of μ0'0.
 double mu_0_prime()
          Gets the value of μ0'.
 void mu_0_prime(double mu_0_prime)
          Sets the value of μ0'.
 double mu_prime_0()
          Gets the value of μ'0.
 void mu_prime_0(double mu_prime_0)
          Sets the value of μ'0.
 double mu_prime()
          Gets the value of μ'.
 void mu_prime(double mu_prime)
          Sets the value of μ'.
 String toString()
          Gets a brief description of this set of μ parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values
Constructor Detail

Mu_Parameters

public Mu_Parameters()
Creates a default set of Hapke mu parameters. Each parameter is initialized to 0.


Mu_Parameters

public Mu_Parameters(double mu_prime,
                     double mu_prime_0,
                     double mu_0_prime,
                     double mu_0_prime_0)
Creates a set of Hapke mu parameters as specified.

Parameters:
mu_prime - the value for μ'.
mu_prime_0 - the value for μ'0.
mu_0_prime - the value for μ0'.
mu_0_prime_0 - the value for μ0'0.
Method Detail

mu_prime

public double mu_prime()
Gets the value of μ'.

Returns:
the value of μ'.

mu_prime

public void mu_prime(double mu_prime)
Sets the value of μ'.

Parameters:
mu_prime - the new value of μ'.

mu_prime_0

public double mu_prime_0()
Gets the value of μ'0.

Returns:
the value of μ'0.

mu_prime_0

public void mu_prime_0(double mu_prime_0)
Sets the value of μ'0.

Parameters:
mu_prime_0 - the new value of μ'0.

mu_0_prime

public double mu_0_prime()
Gets the value of μ0'.

Returns:
the value of μ0'.

mu_0_prime

public void mu_0_prime(double mu_0_prime)
Sets the value of μ0'.

Parameters:
mu_0_prime - the new value of μ0'.

mu_0_prime_0

public double mu_0_prime_0()
Gets the value of μ0'0.

Returns:
the value of μ0'0.

mu_0_prime_0

public void mu_0_prime_0(double mu_0_prime_0)
Sets the value of μ0'0.

Parameters:
mu_0_prime_0 - the new value of μ0'0.

toString

public String toString()
Gets a brief description of this set of μ parameters.

Overrides:
toString in class Object
Returns:
a descriptive string.

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona