API reference

This page provides an auto-generated summary of obsarray’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

Templating functions

templater.template_util.create_ds(template, size)	Returns template dataset
templater.dstemplater.DSTemplater([...])	Class to generate xarray.Dataset's from a set of templates.

Uncertainty functions

unc_accessor.UncAccessor(xarray_obj)	xarray.Dataset accesssor object for handling dataset variable uncertainties
unc_accessor.UncAccessor.obs_vars	Returns dataset observation data variables (defined as dataset variables with uncertainties)
unc_accessor.UncAccessor.unc_vars	Returns dataset uncertainty data variables (defined as uncertainties associated with observation variables)
unc_accessor.UncAccessor.__getitem__(var_name)	Returns VariableUncertainty object to interface with uncertainty information for a given observation variable
unc_accessor.UncAccessor.keys()	Returns observation variable names
unc_accessor.VariableUncertainty(xarray_obj, ...)	Interface for xarray.Dataset variable uncertainty handling
unc_accessor.VariableUncertainty.__getitem__(key)	Returns variable uncertainty interface
unc_accessor.VariableUncertainty.__setitem__(...)	Adds defined uncertainty variable to dataset
unc_accessor.VariableUncertainty.__delitem__(unc_var)	Safely removes uncertainty variable
unc_accessor.VariableUncertainty.keys()	Returns uncertainty variable names
unc_accessor.VariableUncertainty.comps	Returns observation variable uncertainty data variables
unc_accessor.VariableUncertainty.random_comps	Returns dataset uncertainty data variables with fully random error-correlation
unc_accessor.VariableUncertainty.structured_comps	Returns dataset uncertainty data variables with structured error-correlation
unc_accessor.VariableUncertainty.systematic_comps	Returns dataset uncertainty data variables with fully systematic error-correlation
unc_accessor.VariableUncertainty.total_unc()	Returns observation variable combined uncertainty for all uncertainty components (in absolute units)
unc_accessor.VariableUncertainty.random_unc()	Returns observation variable combined uncertainty for uncertainty components with fully random error-correlation
unc_accessor.VariableUncertainty.structured_unc()	Returns observation variable combined uncertainty for uncertainty components with structured error-correlation
unc_accessor.VariableUncertainty.systematic_unc()	Returns observation variable combined uncertainty for uncertainty components with fully systematic error-correlation
unc_accessor.VariableUncertainty.total_err_corr_matrix()	Returns observation variable combined error-correlation matrix for all uncertainty components
unc_accessor.VariableUncertainty.structured_err_corr_matrix()	Returns observation variable combined error-correlation matrix for uncertainty components that do not have either fully random or fully systematic error-correlation
unc_accessor.VariableUncertainty.total_err_cov_matrix()	Returns observation variable combined error-covariance matrix for all uncertainty components
unc_accessor.VariableUncertainty.structured_err_cov_matrix()	Returns observation variable combined error-covariance matrix for uncertainty components with structured error-correlation
unc_accessor.Uncertainty(xarray_obj, ...[, sli])	Interface for handling xarray.Dataset uncertainty variables
unc_accessor.Uncertainty.err_corr_dict()	Error-correlation dictionary for uncertainty effect.
unc_accessor.Uncertainty.err_corr_matrix()	Error-correlation matrix for uncertainty effect.
unc_accessor.Uncertainty.err_cov_matrix()	Error-covariance matrix for uncertainty effect
unc_accessor.Uncertainty.abs_value	Returns uncertainty values with units that match those of the observation variable
unc_accessor.Uncertainty.err_corr	Error-correlation parameterisation for uncertainty effect.
unc_accessor.Uncertainty.is_random	Returns True if uncertainty is fully random in all dimensions
unc_accessor.Uncertainty.is_structured	Returns True if uncertainty is neither fully random or systematic in all dimensions
unc_accessor.Uncertainty.is_systematic	Returns True if uncertainty is fully systematic in all dimensions
unc_accessor.Uncertainty.pdf_shape	Returns probability density function shape for uncertainty variable data
unc_accessor.Uncertainty.units	Return uncertainty variable units
unc_accessor.Uncertainty.value	Return uncertainty data array
unc_accessor.Uncertainty.var_units	Returns units of observation variable associated with uncertainty variable
unc_accessor.Uncertainty.var_value	Returns value of observation variable associated with uncertainty variable

Flag functions

flag_accessor.FlagAccessor(xarray_obj)	xarray.Dataset accesssor object for handling dataset variable flags
flag_accessor.FlagAccessor.keys()	Returns flag variable names
flag_accessor.FlagAccessor.__getitem__(...)	Custom __repr__
flag_accessor.FlagAccessor.__setitem__(...)	Adds defined flag variable to dataset
flag_accessor.FlagAccessor.data_vars	Returns dataset data variables (defined as dataset variables that are not themselves flags)
flag_accessor.FlagAccessor.flag_vars	Returns dataset flag variables (defined as flags associated with data variables)
flag_accessor.FlagVariable(xarray_obj, ...)	Interface for handling xarray.Dataset flag variables
flag_accessor.FlagVariable.keys()	Returns flag variable flag names
flag_accessor.FlagVariable.__getitem__(key)	Returns flag variable flag interface
flag_accessor.FlagVariable.__setitem__(...)	Sets defined flag variable flag, if flag is:
flag_accessor.FlagVariable.__delitem__(...)	Removes defined flag variable flag
flag_accessor.Flag(xarray_obj, ...)	Interface for handling xarray.Dataset flag variable flags
flag_accessor.Flag.__getitem__(sli)	Defines variable slice
flag_accessor.Flag.__setitem__(sli, flag_value)	Sets flag values
flag_accessor.Flag.value	Return flag variable flag value