lime_tbx.business.interpolation.interp_data.interp_data module
Module in charge of retrieving interpolation data (spectra, etc) from storage.
- It exports the following functions:
get_best_asd_data() - Retrieve the best ASD reflectance spectrum for the given moon phase angle.
get_apollo16_data() - Retrieve the Apollo 16 spectrum.
get_breccia_data() - Retrieve the Breccia spectrum.
get_composite_data() - Retrieve the composite Apollo 16 + Breccia spectrum.
get_available_spectra_names() - Obtain the spectra names that the user can use.
get_interpolation_spectrum_name() - Obtains the currently chosen interpolation spectrum name.
set_interpolation_spectrum_name() - Sets the spectrum name as the currently selected one.
- lime_tbx.business.interpolation.interp_data.interp_data.get_apollo16_data() SpectralData[source]
Retrieve the Apollo 16 spectrum.
- Returns:
spectral_data – Apollo 16 reflectance spectrum.
- Return type:
- lime_tbx.business.interpolation.interp_data.interp_data.get_available_dolp_spectra_names() List[str][source]
Obtain the dolp spectra names that the user can use.
- Returns:
names – Valid interpolation spectra names.
- Return type:
list of str
- lime_tbx.business.interpolation.interp_data.interp_data.get_available_interp_SRFs() List[str][source]
Obtain the spectra names that the user can use.
- Returns:
names – Valid interpolation spectra names.
- Return type:
list of str
- lime_tbx.business.interpolation.interp_data.interp_data.get_available_spectra_names() List[str][source]
Obtain the spectra names that the user can use.
- Returns:
names – Valid interpolation spectra names.
- Return type:
list of str
- lime_tbx.business.interpolation.interp_data.interp_data.get_best_asd_data(moon_phase_angle: float) SpectralData[source]
Retrieve the best ASD reflectance spectrum for the given moon phase angle.
- Parameters:
moon_phase_angle (float) – Moon phase angle in degrees of which the best ASD reflectance will be retrieved.
- Returns:
spectral_data – Reflectance spectrum.
- Return type:
- lime_tbx.business.interpolation.interp_data.interp_data.get_best_polar_asd_data(moon_phase_angle: float) SpectralData[source]
Retrieve the best ASD polarisation spectrum for the given moon phase angle. This is not used in the end, the ASD polarisation spectrum wasn’t good enough.
- Parameters:
moon_phase_angle (float) – Moon phase angle in degrees of which the best ASD polarisation will be retrieved.
- Returns:
spectral_data – ASD polarisation spectrum.
- Return type:
- lime_tbx.business.interpolation.interp_data.interp_data.get_breccia_data() SpectralData[source]
Retrieve the Breccia spectrum.
- Returns:
spectral_data – Apollo 16 reflectance spectrum.
- Return type:
- lime_tbx.business.interpolation.interp_data.interp_data.get_composite_data() SpectralData[source]
Retrieve the composite Apollo 16 + Breccia spectrum. 95% Apollo 16 and 5% Breccia.
- Returns:
spectral_data – Apollo 16 reflectance spectrum.
- Return type:
- lime_tbx.business.interpolation.interp_data.interp_data.get_dolp_interpolation_spectrum_name() str[source]
Obtains the currently chosen dolp (polarisation) interpolation spectrum name.
- Returns:
name – Currently chosen dolp interpolation spectrum name.
- Return type:
str
- lime_tbx.business.interpolation.interp_data.interp_data.get_interpolation_SRF() str[source]
Obtains the currently chosen interpolation spectrum name.
- Returns:
name – Currently chosen interpolation spectrum name.
- Return type:
str
- lime_tbx.business.interpolation.interp_data.interp_data.get_interpolation_spectrum_name() str[source]
Obtains the currently chosen interpolation spectrum name.
- Returns:
name – Currently chosen interpolation spectrum name.
- Return type:
str
- lime_tbx.business.interpolation.interp_data.interp_data.get_interpolation_srf_as_srf_type() str[source]
- lime_tbx.business.interpolation.interp_data.interp_data.get_linear_polar_data() SpectralData[source]
Retrieve the linear polarisation spectrum.
- Returns:
spectral_data – Linear polarisation spectrum.
- Return type:
- lime_tbx.business.interpolation.interp_data.interp_data.get_use_wehrli_for_esi() bool[source]
Checks if the user/dev settings are set to use the wehrli spectrum as source for the ESI or if the TSIS will be used instead.
- Returns:
use_wehrli – Boolean indicating if the Wehrli spectrum will be used or not.
- Return type:
bool
- lime_tbx.business.interpolation.interp_data.interp_data.is_show_cimel_points() bool[source]
Checks if the UI should show the CIMEL points used for interpolation.
- Returns:
should_show – True if the CIMEL points should be shown.
- Return type:
bool
- lime_tbx.business.interpolation.interp_data.interp_data.is_show_interpolation_spectrum() bool[source]
Checks if the UI should show the spectrum used for interpolation.
- Returns:
should_show – True if the spectrum should be shown.
- Return type:
bool
- lime_tbx.business.interpolation.interp_data.interp_data.is_skip_uncertainties() bool[source]
Checks if the user settings are set to skip the uncertainties calculation.
- Returns:
should_skip – True if the uncertainties calculation should be skipped.
- Return type:
bool
- lime_tbx.business.interpolation.interp_data.interp_data.set_dolp_interpolation_spectrum_name(spectrum: str)[source]
Sets the dolp spectrum name as the currently selected one.
- Parameters:
spectrum (str) – Spectrum name to set as chosen.
- lime_tbx.business.interpolation.interp_data.interp_data.set_interpolation_SRF(intp_srf: str)[source]
Sets the SRF as the currently selected one.
- Parameters:
spectrum (str) – SRF name to set as chosen.
- lime_tbx.business.interpolation.interp_data.interp_data.set_interpolation_spectrum_name(spectrum: str)[source]
Sets the spectrum name as the currently selected one.
- Parameters:
spectrum (str) – Spectrum name to set as chosen.
- lime_tbx.business.interpolation.interp_data.interp_data.set_show_cimel_points(show: bool)[source]
Sets the CIMEL points visibility as <show>.
- Parameters:
show (bool) – Visibility of the CIMEL points.