eradiate.radprops.AtmosphereRadProfile#
- class eradiate.radprops.AtmosphereRadProfile(absorption_data, thermoprops=_Nothing.NOTHING, has_absorption=True, has_scattering=True, error_handler_config=_Nothing.NOTHING)[source]#
Bases:
RadProfile
Atmospheric radiative profile.
- Parameters:
absorption_data (
Dataset
orlist
ofDataset
orPathLike
) – Absorption coefficient data. If a file path, the absorption coefficient is loaded from the specified file (must be a NetCDF file).If a tuple, the first element is the dataset codename and thesecond is the desired working wavelength range.thermoprops (
Dataset
, default: joseki.make withidentifier
set to"afgl_1986-us_standard"
andz
set to"np.linspace(0.0, 120.0, 121) * ureg.km"
andadditional_molecules
set to"False"
) – Atmosphere’s thermophysical properties.
has_absorption (
bool
, default:True
) – Absorption switch. IfTrue
, the absorption coefficient is computed. Else, the absorption coefficient is not computed and instead set to zero.has_scattering (
bool
, default:True
) – Scattering switch. IfTrue
, the scattering coefficient is computed. Else, the scattering coefficient is not computed and instead set to zero.error_handler_config (
dict
, default:{'x': {'missing': 'ignore', 'scalar': 'ignore', 'bounds': 'raise'}, 'p': {'missing': 'raise', 'scalar': 'raise', 'bounds': 'ignore'}, 't': {'missing': 'raise', 'scalar': 'raise', 'bounds': 'ignore'}}
) – Error handler configuration for absorption data interpolation.
- Fields:
absorption_data (
Dataset
orlist
ofDataset
) – Absorption coefficient data.thermoprops (
Dataset
) – Atmosphere’s thermophysical properties.has_absorption (
bool
) – Absorption switch.has_scattering (
bool
) – Scattering switch.error_handler_config (
dict
) – Error handler configuration for absorption data interpolation.
Notes
The radiative profile is defined by atmospheric thermophysical and absorption coefficient data.
- eval_albedo(si, zgrid=None)#
Evaluate albedo at given spectral index.
- Parameters:
si (
SpectralIndex
) – Spectral index.zgrid (
ZGrid
, optional) – The altitude grid for which the albedo is evaluated. If unset, a profile-specific default is used.
- Returns:
quantity
– Evaluated spectrum as an array with length equal to the number of layers.
- eval_dataset(si, zgrid=None)#
Evaluate radiative properties at given spectral index.
- Parameters:
si (
SpectralIndex
) – Spectral index.zgrid (
ZGrid
, optional) – The altitude grid for which the radiative profile is evaluated. If unset, a profile-specific default is used.
- Returns:
Dataset
– Radiative property dataset.
- eval_sigma_a(si, zgrid=None)#
Evaluate absorption coefficient at given spectral index.
- Parameters:
si (
SpectralIndex
) – Spectral index.zgrid (
ZGrid
, optional) – The altitude grid for which the absorption coefficient is evaluated. If unset, a profile-specific default is used.
- Returns:
quantity
– Evaluated spectrum as an array with length equal to the number of layers.
- eval_sigma_a_mono(w, zgrid)[source]#
Evaluate absorption coefficient spectrum in monochromatic mode.
- eval_sigma_s(si, zgrid=None)#
Evaluate scattering coefficient at given spectral index.
- Parameters:
si (
SpectralIndex
) – Spectral index.zgrid (
ZGrid
, optional) – The altitude grid for which the scattering coefficient is evaluated. If unset, a profile-specific default is used.
- Returns:
quantity
– Evaluated spectrum as an array with length equal to the number of layers.
- eval_sigma_t(si, zgrid=None)#
Evaluate extinction coefficient at given spectral index.
- Parameters:
si (
SpectralIndex
) – Spectral index.zgrid (
ZGrid
, optional) – The altitude grid for which the extinction coefficient is evaluated. If unset, a profile-specific default is used.
- Returns:
quantity
– Evaluated spectrum as an array with length equal to the number of layers.
- property zgrid#
Default altitude grid used for profile evaluation.