punpy.digital_effects_table.measurement_function_utils.MeasurementFunctionUtils.calculate_corr#
- MeasurementFunctionUtils.calculate_corr(form, ds, var)[source]#
Function to extract error-correlation matrices of given form on given variable from the given datasets and return as array.
- Parameters:
form (str) – name or type of given uncertainty component
ds (xarray.dataset) – given dataset
var (str) – given variable
- Returns:
error-correlation matrix values for the given variable in the given dataset. returns None if uncertainty component is not present in dataset.
- Return type:
np.ndarray