isofit.configs.sections.radiative_transfer_config

Classes

`RadiativeTransferEngineConfig`	Radiative transfer unknowns configuration.
`RadiativeTransferUnknownsConfig`	Radiative transfer unknowns configuration.
`RadiativeTransferConfig`	Forward model configuration.

Module Contents

class RadiativeTransferEngineConfig(sub_configdic: dict = None, name: str = None)[source]

Bases: isofit.configs.base_config.BaseConfigSection

Radiative transfer unknowns configuration.

_name_type[source]

name = None[source]

Name of config - optional, and not currently used.

Type:: str

_engine_name_type[source]

engine_name = None[source]

Name of radiative transfer engine to use - options [‘modtran’, ‘6s’, ‘sRTMnet’].

Type:: str

_engine_base_dir_type[source]

engine_base_dir = None[source]

base directory of the given radiative transfer engine on user’s OS.

Type:: str

_engine_lut_file_type[source]

engine_lut_file = None[source]

File containing the prebuilt LUT file (hdf5).

Type:: str

_wavelength_file_type[source]

wavelength_file = None[source]

Optional path to wavelength file for high-res atmospheric calculations

Type:: str

_wavelength_range_type = [][source]

wavelength_range = None[source]

The wavelength range to execute this radiative transfer engine over.

Type:: List

_environment_type[source]

environment = None[source]

Additional environment directives for the shell script.

Type:: str

_lut_path_type[source]

lut_path = None[source]

The path to the look up table directory used by the radiative transfer engine.

Type:: str

_sim_path_type[source]

sim_path = None[source]

Path to the simulation outputs for the radiative transfer engine.

Type:: str

_template_file_type[source]

template_file = None[source]

A template file to be used as the base-configuration for the given radiative transfer engine.

Type:: str

_treat_as_emissive_type[source]

treat_as_emissive = False[source]

Run the simulation in emission mode

Type:: bool

_glint_model_type[source]

glint_model = False[source]: Flag to indicate whether to use the sun and sky glint model from Gege (2012, 2014) in the forward model. Only currently functional with multipart MODTRAN.

_rt_mode_type[source]

rt_mode = 'transm'[source]

Radiative transfer mode of LUT simulations. ‘transm’ for transmittances, ‘rdn’ for reflected radiance.

Type:: str

_lut_names_type[source]

lut_names = None[source]

Names of the elements to run this radiative transfer element on. Must be a subset of the keys in radiative_transfer->lut_grid. If not specified, uses all keys from radiative_transfer-> lut_grid. Auto-sorted (alphabetically) below.

Type:: Dictionary

_statevector_names_type = [][source]

statevector_names = None[source]

Names of the statevector elements to use with this radiative transfer engine. Must be a subset of the keys in radiative_transfer->statevector. If not specified, uses all keys from radiative_transfer->statevector. Auto-sorted (alphabetically) below.

Type:: List

_lut_compression_type[source]

lut_compression = 'zlib'[source]

Compression method to use for the LUT NetCDF

Type:: str

_lut_complevel_type[source]

lut_complevel = None[source]

The compression level to use for the chosen method

Type:: int

_aerosol_template_file_type[source]

aerosol_template_file = None[source]

Aerosol template file, currently only implemented for MODTRAN.

Type:: str

_aerosol_model_file_type[source]

aerosol_model_file = None[source]

Aerosol model file, currently only implemented for MODTRAN.

Type:: str

_multipart_transmittance_type[source]

multipart_transmittance = False[source]

Use True to specify triple-run diffuse & direct transmittance estimation. Only implemented for MODTRAN.

Type:: str

_emulator_file_type[source]

emulator_file = None[source]

Path to emulator model file

Type:: str

_emulator_aux_file_type[source]

emulator_aux_file = None[source]

path to emulator auxiliary data - expected npz format

Type:: str

_parallel_layer_read_type[source]

parallel_layer_read = True[source]

Flag for how to load and run sRTMnet prediction. If True, will read in the weights/biases per layer per worker. If False, will load entire model into shared memory Model doesn’t always fit in shared memory for smaller systems

Type:: bool

_predict_parallel_chunks_type[source]

predict_parallel_chunks = 20[source]

If emulator predictions are in parallel. How many chunks to run. Keep to a small number for systems with little memory and slow read.

Type:: int

_day_type[source]

day = None[source]

6s-only day parameter.

Type:: int

_month_type[source]

month = None[source]

6s-only month parameter.

Type:: int

_elev_type[source]

elev = None[source]

6s-only elevation parameter.

Type:: float

_alt_type[source]

alt = None[source]

6s-only altitude parameter.

Type:: float

_obs_file_type[source]

obs_file = None[source]

6s-only observation file.

Type:: str

_solzen_type[source]

solzen = None[source]

6s-only solar zenith.

Type:: float

_solaz_type[source]

solaz = None[source]

6s-only solar azimuth.

Type:: float

_viewzen_type[source]

viewzen = None[source]

6s-only view zenith.

Type:: float

_viewaz_type[source]

viewaz = None[source]

6s-only view azimuth.

Type:: float

_earth_sun_distance_file_type[source]

earth_sun_distance_file = ''[source]

6s-only earth-to-sun distance file.

Type:: str

_irradiance_file_type[source]

irradiance_file = ''[source]

6s-only irradiance file.

Type:: str

_rte_configure_and_exit_type[source]

rte_configure_and_exit = False[source]

Indicates that code should terminate as soon as all radiative transfer engine configuration files are written (without running them)

Type:: bool

_check_config_validity() → List[str][source]

class RadiativeTransferUnknownsConfig(sub_configdic: dict = None)[source]

Bases: isofit.configs.base_config.BaseConfigSection

Radiative transfer unknowns configuration.

_H2O_ABSCO_type[source]

H2O_ABSCO = None[source]

_check_config_validity() → List[str][source]

class RadiativeTransferConfig(sub_configdic: dict = None)[source]

Bases: isofit.configs.base_config.BaseConfigSection

Forward model configuration.

_statevector_type[source]

statevector: isofit.configs.sections.statevector_config.StateVectorConfig[source]

_lut_grid_type[source]

lut_grid = None[source]

_unknowns_type[source]

unknowns: RadiativeTransferUnknownsConfig = None[source]

_interpolator_style_type[source]

interpolator_style = 'mlg'[source]

Style of interpolation. - mlg = Multilinear Grid - rg = RegularGrid Speed performance:

mlg >> stacked rg >> unstacked rg

Caching provides significant gains for rg, marginal for mlg

Type:: str

_overwrite_interpolator_type[source]

overwrite_interpolator = False[source]

Overwrite any existing interpolator pickles

Type:: bool

_cache_size_type[source]

cache_size = 16[source]

Size of the cache to store interpolation lookups. Defaults to 16 which provides the most significant gains. Setting higher may provide marginal gains.

Type:: int

_radiative_transfer_engines_type = [][source]

radiative_transfer_engines = [][source]

_set_rt_config_options(subconfig)[source]

_check_config_validity() → List[str][source]