punpy.digital_effects_table.measurement_function.MeasurementFunction.propagate_ds_total#
- MeasurementFunction.propagate_ds_total(*args, store_unc_percent=False, expand=False, ds_out_pre=None, use_ds_out_pre_unmodified=None, include_corr=True)[source]#
Function to propagate the total uncertainties present in the digital effects tables in the input arguments, through the measurement function to produce an output digital effects table with the total uncertainties on the measurand
- Parameters:
args (obsarray dataset(s)) – One or multiple digital effects tables with input quantities, defined with obsarray
store_unc_percent (bool (optional)) – Boolean defining whether relative uncertainties should be returned or not. Default to True (relative uncertaintie returned)
expand (bool (optional)) – boolean to indicate whether the input quantities should be expanded/broadcasted to the shape of the measurand. Defaults to False.
ds_out_pre (xarray.dataset (optional)) – Pre-existing output dataset in which the measurand & uncertainty variables should be saved. Defaults to None, in which case a new dataset is created.
include_corr (bool (optional)) – boolean to indicate whether the output dataset should include the correlation matrices. Defaults to True.
- Returns:
digital effects table with uncertainties on measurand
- Return type:
obsarray dataset