# -*- coding: utf-8 -*- """ Examples -------- Run all tests:: pytest # (in command line, in project folder) Run only fast tests (i.e: tests that a 'fast' label):: pytest -m fast """ import numpy as np from radis import Radiance_noslit, calc_spectrum, get_residual from radis.spectrum.compare import get_distance, plot_diff from radis.test.utils import getTestFile from radis.tools.database import load_spec # Test routines def test_compare_methods(verbose=True, plot=True, close_plots=True, *args, **kwargs): """Just run all Spectrum compare methods to check they work""" if plot and close_plots: import matplotlib.pyplot as plt plt.close("all") s = load_spec(getTestFile("CO_Tgas1500K_mole_fraction0.01.spec"), binary=True) # limits to a single line, because get_distance() s.resample(np.linspace(2193, 2193.8, 100)) # is very computationally heavy s.update("radiance_noslit") s_noabsorption = s.copy() s.name = "solve RTE" s_noabsorption.name = "optically thin" # rescale, normal # s.rescale_mole_fraction(10) s.rescale_path_length(10) # rescale, optically thin mode s_noabsorption.conditions["self_absorption"] = False # s_noabsorption.rescale_mole_fraction(10) s_noabsorption.rescale_path_length(10) # Compare # should be added in an example with experimental fit of bandhead get_distance(s, s_noabsorption, "radiance_noslit") title = f"CO x={s.conditions['mole_fraction']:.2f}, L={s.conditions['path_length']:.2f}cm" if plot: plot_diff(s, s_noabsorption, method="diff", diff_window=1, title=title) plot_diff(s, s_noabsorption, method="ratio", normalize=True, title=title) # %% def test_plot_compare_with_nan( plot=True, verbose=True, close_plots=True, *args, **kwargs ): if plot and close_plots: import matplotlib.pyplot as plt plt.close("all") s = calc_spectrum( 1900, 2300, # cm-1 molecule="CO", isotope="1,2,3", pressure=1.01325, # bar Tgas=700, # K mole_fraction=0.1, path_length=1, # cm ) s = Radiance_noslit(s) s._q["radiance_noslit"][0] = np.nan # Test Plot function when there are NaNs in the spectrum: if plot: s.plot(normalize=True) s.plot(normalize=(2200, 2250)) # Test plot_diff function when there are NaNs in the spectra: if plot: plot_diff(s, s * 1.2, normalize=True) plot_diff(s, s * 1.2, "radiance_noslit", normalize=(2000, 2100)) def test_get_residual(): from radis import calc_spectrum, experimental_spectrum s1 = calc_spectrum( 1900, 2300, molecule="CO", isotope="1,2,3", pressure=1.01325, Tgas=1000, mole_fraction=0.1, ) s1.apply_slit(1, "nm") w1, I1 = s1.get( "radiance", copy=False, wunit=s1.get_waveunit(), Iunit="mW/cm2/sr/nm" ) # Fake experimental spectrum (identical) s_expe_1 = experimental_spectrum(w1, I1, Iunit="mW/cm2/sr/nm", wunit="cm-1") residual1 = get_residual( s1, s_expe_1, "radiance", # ignore_nan=False, normalize=True, ) assert residual1 < 1e-4 # Fake experimental spectrum with a new unit (but identical) I2 = I1 * 1e-3 s_expe_2 = experimental_spectrum(w1, I2, Iunit="W/cm2/sr/nm", wunit="cm-1") assert np.isclose(s_expe_1.max(), s_expe_2.max()) residual2 = get_residual( s1, s_expe_2, "radiance", normalize=False, ) assert residual2 < 1e-10 for bool_how in ["max", "area", "mean"]: residual2_bis = get_residual( s1, s_expe_2, "radiance", ignore_nan=False, normalize=True, normalize_how=bool_how, ) # print(f'residu2 ={residual2}') assert residual2_bis < 1e-3 # Fake experimental spectrum with a nan I3 = I1.copy() I3[0] = np.nan s_expe_3 = experimental_spectrum(w1, I3, Iunit="W/cm2/sr/nm", wunit="cm-1") # Interestingly, the "mean" method seams to be not adapted for spectra with nans criterion = [7e-5, 2e-6, 2e-2] for index, bool_how in enumerate(["max", "area", "mean"]): residual3 = get_residual( s1, s_expe_3, "radiance", ignore_nan=True, normalize=True, normalize_how=bool_how, ) # print(f'residu3 ={residual3}') assert residual3 < criterion[index] def test_get_distance_normalize(): """Test that get_distance supports normalize parameter. Two spectra with the same shape but different scales should yield ~0 distance when normalized (since shape is identical).""" from radis import Spectrum w = np.linspace(2000, 2300, 100) I1 = np.exp(-((w - 2150) ** 2) / 500) # peak = 1.0 I2 = I1 * 1000 # same shape, 1000x larger s1 = Spectrum.from_array( w, I1, "radiance_noslit", wunit="cm-1", Iunit="mW/cm2/sr/nm" ) s2 = Spectrum.from_array( w, I2, "radiance_noslit", wunit="cm-1", Iunit="mW/cm2/sr/nm" ) var = "radiance_noslit" # Identical spectra after normalization: distance should be ~0 _, d_norm = get_distance(s1, s2, var, normalize=True) assert ( np.nanmean(d_norm) < 1e-10 ), f"Same-shape spectra should have ~0 normalized distance, got {np.nanmean(d_norm)}" # Self-distance should be ~0 _, d_self = get_distance(s1, s1, var, normalize=True) assert np.nanmean(d_self) < 1e-10 # Different shapes should have non-zero normalized distance I3 = np.exp(-((w - 2180) ** 2) / 500) # shifted peak s3 = Spectrum.from_array( w, I3, "radiance_noslit", wunit="cm-1", Iunit="mW/cm2/sr/nm" ) _, d_diff = get_distance(s1, s3, var, normalize=True) assert ( np.nanmean(d_diff) > 1e-3 ), "Different-shape spectra should have non-zero normalized distance" # Test all normalize_how options work without error for how in ["max", "area", "mean"]: _, d = get_distance(s1, s2, var, normalize=True, normalize_how=how) assert not np.all(np.isnan(d)), f"normalize_how='{how}' returned all NaNs" # Test normalize with wrange tuple _, d_range = get_distance(s1, s2, var, normalize=(2100, 2200)) assert not np.all(np.isnan(d_range)) def _run_testcases(plot=True, verbose=True, warnings=True, *args, **kwargs): """Test procedures""" # Test all Spectrum compare methods # ---------------------------------- test_compare_methods(verbose=verbose, plot=plot, *args, **kwargs) test_plot_compare_with_nan(verbose=verbose, plot=True, *args, **kwargs) test_get_residual() test_get_distance_normalize() if __name__ == "__main__": # print("Test_compare.py: ", _run_testcases()) test_get_distance_normalize()