punpy.digital_effects_table.measurement_function_utils.MeasurementFunctionUtils.get_input_unc

punpy.digital_effects_table.measurement_function_utils.MeasurementFunctionUtils.get_input_unc#

MeasurementFunctionUtils.get_input_unc(form, *args, ydims=None, sizes_dict=None, expand=False, corr_dims=[])[source]#

Function to extract uncertainties on the input quantities from datasets and return as list of arrays.

Parameters:
  • form (str) – name or type of uncertainty component

  • args (obsarray dataset(s)) – One or multiple digital effects tables with input quantities, defined with obsarray

  • ydims (list(str)) – list of dimensions of the measurand, in correct order.

  • sizes_dict (dict) – Dictionary with sizes of each of the dimensions of the measurand.

  • expand (bool) – boolean to indicate whether the input quantities should be expanded/broadcasted to the shape of the measurand.

  • corr_dims (integer, optional) – set to positive integer to select the axis used in the correlation matrix. The correlation matrix will then be averaged over other dimensions. Defaults to -99, for which the input array will be flattened and the full correlation matrix calculated.

Returns:

list of uncertainty values (as np.ndarray) for each of the input quantites.

Return type:

list(np.ndarray)