HiRISE

HiRISE.HiPlan.HIPHOP
Enum Scattering

java.lang.Object
  extended by java.lang.Enum<Scattering>
      extended by HiRISE.HiPlan.HIPHOP.Scattering
All Implemented Interfaces:
Serializable, Comparable<Scattering>

public enum Scattering
extends Enum<Scattering>

An enumeration of scattering functions.

Version:
1.1
Author:
Christian Schaller - UA/PIRL

Enum Constant Summary
BACK
          Indicates backscattering.
DOUBLE_HG
          Indicates a double Henyey-Greenstein scattering function.
FORWARD
          Indicates forward-scattering.
ISOTROPIC
          Indicates isotropic scattering.
LUNAR
          Indicates lunar surface scattering.
RAYLEIGH
          Indicates Rayleigh scattering.
SINGLE_HG
          Indicates a single Henyey-Greenstein scattering function.
 
Field Summary
static String ID
          Class identification name with source code version and date.
 
Method Summary
static Scattering valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Scattering[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ISOTROPIC

public static final Scattering ISOTROPIC
Indicates isotropic scattering. The scattering function returns 1 for all angles.


BACK

public static final Scattering BACK
Indicates backscattering. The scattering function returns 1 + cos (a).


FORWARD

public static final Scattering FORWARD
Indicates forward-scattering. The scattering function returns 1 - cos (a).


LUNAR

public static final Scattering LUNAR
Indicates lunar surface scattering.


RAYLEIGH

public static final Scattering RAYLEIGH
Indicates Rayleigh scattering.


SINGLE_HG

public static final Scattering SINGLE_HG
Indicates a single Henyey-Greenstein scattering function.


DOUBLE_HG

public static final Scattering DOUBLE_HG
Indicates a double Henyey-Greenstein scattering function.

Field Detail

ID

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

See Also:
Constant Field Values
Method Detail

values

public static Scattering[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Scattering c : Scattering.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Scattering valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

HiRISE

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