pyrtlib.uncertainty.SpectroscopicParameter

class pyrtlib.uncertainty.SpectroscopicParameter(value: ndarray, uncer: ndarray, units: Optional[str] = '', refer: Optional[str] = '', name: Optional[str] = '')

Bases: object

Absorption model uncertainties for the spectroscopic parameters

Example

>>> from pyrtlib.uncertainty import SpectroscopicParameter
>>> parameters = SpectroscopicParameter.water_parameters('R18')
>>> parameters['con_Cf'].value
5.95e-10

New value may be added to parameters using SpectroscopicParameter() class as following

>>> parameters['con_Xs'] = SpectroscopicParameter(2.3, 0.001, 'unitless', 'Tretyakov, JMS, 2016')
>>> parameters['con_Xs'].value
2.3
>>> parameters['con_Xs'].uncer
'unitless'
>>> parameters['con_Xs'].refer
'Tretyakov, JMS, 2016'

Also, existing parameters may be modified as following

>>> parameters['w2a'].value = 1.333
>>> parameters['w2a'].value
1.333

Note

If new value will be added or modified it is necessary to save the new values by calling the set_parameters() function.

Methods

__init__(value, uncer[, units, refer, name])
oxygen_parameters(model)	This method is used for uncertainty analysis and returns the dictionary with the whole spectroscopic parameters for \(O_2\).
ozono_parameters(model)	This method is used for uncertainty analysis and returns the dictionary with the whole spectroscopic parameters for \(O_3\).
set_parameters(SP)	Set new values and uncertainties to spectroscopic parameters.
water_parameters(model)	This method is used for uncertainty analysis and returns the dictionary with the whole spectroscopic parameters for \(H_2O\).

Attributes

name	The name or description of the parameter
refer	The reference of the parameter
units	The units of the parameter
value	The value associated to the parameter
uncer	The uncertainty of the parameter