punpy.mc.mc_propagation.MCPropagation.generate_MC_sample_cov

punpy.mc.mc_propagation.MCPropagation.generate_MC_sample_cov#

MCPropagation.generate_MC_sample_cov(x, cov_x, corr_between=None, pdf_shape='gaussian', pdf_params=None)[source]#

function to generate MC sample for input quantities from covariance matrix

Parameters:
  • x (list[array]) – list of input quantities (usually numpy arrays)

  • u_x (list[array]) – list of systematic uncertainties on input quantities (usually numpy arrays)

  • corr_x (list[array]) – list of correlation matrices (n,n) along non-repeating axis. Can be set to “rand” (diagonal correlation matrix), “syst” (correlation matrix of ones) or a custom correlation matrix.

  • corr_between (array, optional) – correlation matrix (n,n) between input quantities, defaults to None

  • pdf_shape (str, optional) – string identifier of the probability density function shape, defaults to gaussian

  • pdf_params (dict, optional) – dictionaries defining optional additional parameters that define the probability density function, Defaults to None (gaussian does not require additional parameters)

Returns:

MC sample for input quantities

Return type: