Ctrl+K

comet_maths.generate_sample.probability_density_function.generate_sample_pdf

comet_maths.generate_sample.probability_density_function.generate_sample_pdf#

comet_maths.generate_sample.probability_density_function.generate_sample_pdf(size, pdf_shape, pdf_params=None, dtype=None, seed=12345)[source]#

Function to generate samples from standard probability functions (with zero as mean and 1 as width)

Parameters:

  • size (int or tuple of ints) – Output shape. If the given shape is, e.g., (m, n, k), then m * n * k samples are drawn.

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

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

Returns:

output sample of given size and probability density function

Return type:

array

Contents