isofit.configs.sections.radiative_transfer_config ================================================= .. py:module:: isofit.configs.sections.radiative_transfer_config Classes ------- .. autoapisummary:: isofit.configs.sections.radiative_transfer_config.RadiativeTransferEngineConfig isofit.configs.sections.radiative_transfer_config.RadiativeTransferUnknownsConfig isofit.configs.sections.radiative_transfer_config.RadiativeTransferConfig Module Contents --------------- .. py:class:: RadiativeTransferEngineConfig(sub_configdic: dict = None, name: str = None) Bases: :py:obj:`isofit.configs.base_config.BaseConfigSection` Radiative transfer unknowns configuration. .. py:attribute:: _name_type .. py:attribute:: name :value: None Name of config - optional, and not currently used. :type: str .. py:attribute:: _engine_name_type .. py:attribute:: engine_name :value: None Name of radiative transfer engine to use - options ['modtran', '6s', 'sRTMnet']. :type: str .. py:attribute:: _engine_base_dir_type .. py:attribute:: engine_base_dir :value: None base directory of the given radiative transfer engine on user's OS. :type: str .. py:attribute:: _engine_lut_file_type .. py:attribute:: engine_lut_file :value: None File containing the prebuilt LUT file (hdf5). :type: str .. py:attribute:: _wavelength_file_type .. py:attribute:: wavelength_file :value: None Optional path to wavelength file for high-res atmospheric calculations :type: str .. py:attribute:: _wavelength_range_type :value: [] .. py:attribute:: wavelength_range :value: None The wavelength range to execute this radiative transfer engine over. :type: List .. py:attribute:: _environment_type .. py:attribute:: environment :value: None Additional environment directives for the shell script. :type: str .. py:attribute:: _lut_path_type .. py:attribute:: lut_path :value: None The path to the look up table directory used by the radiative transfer engine. :type: str .. py:attribute:: _sim_path_type .. py:attribute:: sim_path :value: None Path to the simulation outputs for the radiative transfer engine. :type: str .. py:attribute:: _template_file_type .. py:attribute:: template_file :value: None A template file to be used as the base-configuration for the given radiative transfer engine. :type: str .. py:attribute:: _treat_as_emissive_type .. py:attribute:: treat_as_emissive :value: False Run the simulation in emission mode :type: bool .. py:attribute:: _glint_model_type .. py:attribute:: glint_model :value: False 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. .. py:attribute:: _rt_mode_type .. py:attribute:: rt_mode :value: 'transm' Radiative transfer mode of LUT simulations. 'transm' for transmittances, 'rdn' for reflected radiance. :type: str .. py:attribute:: _lut_names_type .. py:attribute:: lut_names :value: None 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 .. py:attribute:: _statevector_names_type :value: [] .. py:attribute:: statevector_names :value: None 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 .. py:attribute:: _lut_compression_type .. py:attribute:: lut_compression :value: 'zlib' Compression method to use for the LUT NetCDF :type: str .. py:attribute:: _lut_complevel_type .. py:attribute:: lut_complevel :value: None The compression level to use for the chosen method :type: int .. py:attribute:: _aerosol_template_file_type .. py:attribute:: aerosol_template_file :value: None Aerosol template file, currently only implemented for MODTRAN. :type: str .. py:attribute:: _aerosol_model_file_type .. py:attribute:: aerosol_model_file :value: None Aerosol model file, currently only implemented for MODTRAN. :type: str .. py:attribute:: _multipart_transmittance_type .. py:attribute:: multipart_transmittance :value: False Use True to specify triple-run diffuse & direct transmittance estimation. Only implemented for MODTRAN. :type: str .. py:attribute:: _emulator_file_type .. py:attribute:: emulator_file :value: None Path to emulator model file :type: str .. py:attribute:: _emulator_aux_file_type .. py:attribute:: emulator_aux_file :value: None path to emulator auxiliary data - expected npz format :type: str .. py:attribute:: _parallel_layer_read_type .. py:attribute:: parallel_layer_read :value: True 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 .. py:attribute:: _predict_parallel_chunks_type .. py:attribute:: predict_parallel_chunks :value: 20 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 .. py:attribute:: _day_type .. py:attribute:: day :value: None 6s-only day parameter. :type: int .. py:attribute:: _month_type .. py:attribute:: month :value: None 6s-only month parameter. :type: int .. py:attribute:: _elev_type .. py:attribute:: elev :value: None 6s-only elevation parameter. :type: float .. py:attribute:: _alt_type .. py:attribute:: alt :value: None 6s-only altitude parameter. :type: float .. py:attribute:: _obs_file_type .. py:attribute:: obs_file :value: None 6s-only observation file. :type: str .. py:attribute:: _solzen_type .. py:attribute:: solzen :value: None 6s-only solar zenith. :type: float .. py:attribute:: _solaz_type .. py:attribute:: solaz :value: None 6s-only solar azimuth. :type: float .. py:attribute:: _viewzen_type .. py:attribute:: viewzen :value: None 6s-only view zenith. :type: float .. py:attribute:: _viewaz_type .. py:attribute:: viewaz :value: None 6s-only view azimuth. :type: float .. py:attribute:: _earth_sun_distance_file_type .. py:attribute:: earth_sun_distance_file :value: '' 6s-only earth-to-sun distance file. :type: str .. py:attribute:: _irradiance_file_type .. py:attribute:: irradiance_file :value: '' 6s-only irradiance file. :type: str .. py:attribute:: _rte_configure_and_exit_type .. py:attribute:: rte_configure_and_exit :value: False Indicates that code should terminate as soon as all radiative transfer engine configuration files are written (without running them) :type: bool .. py:method:: _check_config_validity() -> List[str] .. py:class:: RadiativeTransferUnknownsConfig(sub_configdic: dict = None) Bases: :py:obj:`isofit.configs.base_config.BaseConfigSection` Radiative transfer unknowns configuration. .. py:attribute:: _H2O_ABSCO_type .. py:attribute:: H2O_ABSCO :value: None .. py:method:: _check_config_validity() -> List[str] .. py:class:: RadiativeTransferConfig(sub_configdic: dict = None) Bases: :py:obj:`isofit.configs.base_config.BaseConfigSection` Forward model configuration. .. py:attribute:: _statevector_type .. py:attribute:: statevector :type: isofit.configs.sections.statevector_config.StateVectorConfig .. py:attribute:: _lut_grid_type .. py:attribute:: lut_grid :value: None .. py:attribute:: _unknowns_type .. py:attribute:: unknowns :type: RadiativeTransferUnknownsConfig :value: None .. py:attribute:: _interpolator_style_type .. py:attribute:: interpolator_style :value: 'mlg' 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 .. py:attribute:: _overwrite_interpolator_type .. py:attribute:: overwrite_interpolator :value: False Overwrite any existing interpolator pickles :type: bool .. py:attribute:: _cache_size_type .. py:attribute:: cache_size :value: 16 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 .. py:attribute:: _radiative_transfer_engines_type :value: [] .. py:attribute:: radiative_transfer_engines :value: [] .. py:method:: _set_rt_config_options(subconfig) .. py:method:: _check_config_validity() -> List[str]