comet_maths.generate_sample.generate_sample.generate_sample_random

comet_maths.generate_sample.generate_sample.generate_sample_random#

comet_maths.generate_sample.generate_sample.generate_sample_random(MCsteps, param, u_param, dtype=None, pdf_shape='gaussian', pdf_params=None, comp_list=False)[source]#

Generate MC sample of input quantity with random uncertainties.

Parameters:
  • MCsteps (int) – number of MC steps

  • param (float or array) – values of input quantity (mean of distribution)

  • u_param (float or array) – uncertainties on input quantity (std of distribution)

  • dtype (numpy.dtype, optional) – dtype of the produced sample

  • 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)

  • comp_list (bool, optional) – boolean to define whether u_x and corr_x are given as a list or individual uncertainty components. Defaults to False, in chich case a single combined uncertainty component is given per input quantity.

Returns:

generated sample

Return type:

array