Uncertainty

class obsarray.unc_accessor.Uncertainty(xarray_obj: Dataset, var_name: str, unc_var_name: str, sli: tuple | None = None)

Interface for handling xarray.Dataset uncertainty variables

Parameters:

• xarray_obj – dataset

• unc_var_name – name of uncertainty variable

• sli – slice of variable

__init__(xarray_obj: Dataset, var_name: str, unc_var_name: str, sli: tuple | None = None)

Methods

__init__
err_corr_dict	Error-correlation dictionary for uncertainty effect.
err_corr_matrix	Error-correlation matrix for uncertainty effect.
err_cov_matrix	Error-covariance matrix for uncertainty effect
rename	Renames uncertainty variable and safely updates variable name references in obs variable metadata :param name: desired name :returns: dataset with safely renamed variable

Attributes

abs_value	Returns uncertainty values with units that match those of the observation variable
err_corr	Error-correlation parameterisation for uncertainty effect.
is_random	Returns True if uncertainty is fully random in all dimensions
is_structured	Returns True if uncertainty is neither fully random or systematic in all dimensions
is_systematic	Returns True if uncertainty is fully systematic in all dimensions
pdf_shape	Returns probability density function shape for uncertainty variable data
units	Return uncertainty variable units
value	Return uncertainty data array
var_units	Returns units of observation variable associated with uncertainty variable
var_value	Returns value of observation variable associated with uncertainty variable