HiRISE

HiRISE.HiPlan.HIPHOP
Class Atmospheric_Data

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

public class Atmospheric_Data
extends Object

A set of data characterizing the Mars atmosphere.

Version:
1.6
Author:
Christian Schaller - UA/PIRL

Nested Class Summary
 class Atmospheric_Data.Atmospheric_Values
          A set of values from the atmospheric data for a set of input parameters.
 
Field Summary
static String DUST_DATA_FILENAME
          The filename for the atmospheric optical depth data with dust as the data_source of scattering.
static String ICE_DATA_FILENAME
          The filename for the atmospheric optical depth data with ice as the data_source of scattering.
static String ID
          Class identification name with data_source code version and date.
 
Constructor Summary
Atmospheric_Data(Model.Scattering_Source scattering_source)
           
 
Method Summary
 double[] albedo()
           
 double[] flux_actual()
           
 double[] flux_down()
           
 double[] flux_up()
           
 Atmospheric_Data.Atmospheric_Values get_values(double mu_0, double mu, double phi, double[] albedos, double tau)
          Gets a set of atmospheric values for the given input angles, albedos, and optical depth.
 Atmospheric_Data.Atmospheric_Values get_values(double mu_0, double mu, double phi, double blu_albedo, double red_albedo, double nir_albedo, double tau)
          Gets a set of atmospheric values for the given input angles, albedos, and optical depth.
 double[] isa_is_surface()
           
 double[] isa_is_top()
           
 double[] mu_0()
           
 double[] mu()
           
 double[] phi()
           
 double[] radiance()
           
 Model.Scattering_Source scattering_source()
           
 double[] tau()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

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

See Also:
Constant Field Values

DUST_DATA_FILENAME

public static final String DUST_DATA_FILENAME
The filename for the atmospheric optical depth data with dust as the data_source of scattering. This file is loaded when the atmospheric data are created with Model.Scattering_Source.DUST. The class loader expects to find this file in the directory named by Constants.RESOURCES_DIRECTORY.

See Also:
Constant Field Values

ICE_DATA_FILENAME

public static final String ICE_DATA_FILENAME
The filename for the atmospheric optical depth data with ice as the data_source of scattering. This file is loaded when the atmospheric data are created with Model.Scattering_Source.ICE. The class loader expects to find this file in the directory named by Constants.RESOURCES_DIRECTORY.

See Also:
Constant Field Values
Constructor Detail

Atmospheric_Data

public Atmospheric_Data(Model.Scattering_Source scattering_source)
                 throws HIPHOP_Exception
Throws:
HIPHOP_Exception
Method Detail

scattering_source

public Model.Scattering_Source scattering_source()

mu_0

public double[] mu_0()

mu

public double[] mu()

phi

public double[] phi()

albedo

public double[] albedo()

tau

public double[] tau()

isa_is_top

public double[] isa_is_top()

radiance

public double[] radiance()

isa_is_surface

public double[] isa_is_surface()

flux_up

public double[] flux_up()

flux_down

public double[] flux_down()

flux_actual

public double[] flux_actual()

get_values

public Atmospheric_Data.Atmospheric_Values get_values(double mu_0,
                                                      double mu,
                                                      double phi,
                                                      double blu_albedo,
                                                      double red_albedo,
                                                      double nir_albedo,
                                                      double tau)
Gets a set of atmospheric values for the given input angles, albedos, and optical depth.

Parameters:
mu_0 - the cosine of the incidence angle i.
mu - the cosine of the emission angle e.
phi - the angle φ
blu_albedo - the albedo for the HiRISE blue-green CCDs.
red_albedo - the albedo for the HiRISE red CCDs.
nir_albedo - the albedo for the HiRISE near-IR CCDs.
tau - the optical depth.
Returns:
a set of atmospheric parameters.

get_values

public Atmospheric_Data.Atmospheric_Values get_values(double mu_0,
                                                      double mu,
                                                      double phi,
                                                      double[] albedos,
                                                      double tau)
Gets a set of atmospheric values for the given input angles, albedos, and optical depth.

Parameters:
mu_0 - the cosine of the incidence angle i.
mu - the cosine of the emission angle e.
phi - the angle φ
albedos - a three-element array of albedos.
tau - the optical depth.
Returns:
a set of atmospheric parameters.

HiRISE

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