skretrieval.retrieval.forwardmodel.SpectrometerMixin#
- class skretrieval.retrieval.forwardmodel.SpectrometerMixin(lineshape_fn: Callable[[float], LineShape] | None = None, model_res_nm=0.02, model_res_cminv=0.02, spectral_native_coordinate='wavelength_nm', round_decimal=2, stokes_sensitivities=None)[source]#
Bases:
objectMixin for adding a spectrometer to the forward model
- Parameters:
lineshape_fn (Callable[[float], LineShape] | None, optional) – Function that takes in wavelength in nm and returns back a LineShape, by default None
model_res_nm (float, optional) – Model Resolution to use in [nm], by default 0.02
model_res_cminv (float, optional) – Model Resolution to use in [cm^-1], by default 0.02
spectral_native_coordinate (str, optional) – The native coordinate for the spectral axis, by default “wavelength_nm”, can also be “wavenumber_cminv”
round_decimal (int, optional) – Decimal points to round the wavelengths to in the radiative transfer calculation, by default 2
stokes_sensitivities (dict, optional) – Dictionary of stokes sensitivities, by default None. Can be set to multiple measurements, e.g., {“I”: np.array([1, 0, 0, 0]), “Q”: np.array([0, 1, 0, 0]), “U”: np.array([0, 0, 1, 0])} to measure multiple stokes parameters separately.
- __init__(lineshape_fn: Callable[[float], LineShape] | None = None, model_res_nm=0.02, model_res_cminv=0.02, spectral_native_coordinate='wavelength_nm', round_decimal=2, stokes_sensitivities=None) None[source]#
Mixin for adding a spectrometer to the forward model
- Parameters:
lineshape_fn (Callable[[float], LineShape] | None, optional) – Function that takes in wavelength in nm and returns back a LineShape, by default None
model_res_nm (float, optional) – Model Resolution to use in [nm], by default 0.02
model_res_cminv (float, optional) – Model Resolution to use in [cm^-1], by default 0.02
spectral_native_coordinate (str, optional) – The native coordinate for the spectral axis, by default “wavelength_nm”, can also be “wavenumber_cminv”
round_decimal (int, optional) – Decimal points to round the wavelengths to in the radiative transfer calculation, by default 2
stokes_sensitivities (dict, optional) – Dictionary of stokes sensitivities, by default None. Can be set to multiple measurements, e.g., {“I”: np.array([1, 0, 0, 0]), “Q”: np.array([0, 1, 0, 0]), “U”: np.array([0, 0, 1, 0])} to measure multiple stokes parameters separately.
Methods
__init__([lineshape_fn, model_res_nm, ...])Mixin for adding a spectrometer to the forward model