distl.gaussian (function)


def gaussian(loc=0.0, scale=1.0, unit=None, label=None, label_latex=None, wrap_at=None)

Create a Gaussian distribution.

Arguments

  • loc (float or int, default=0.0): the central value of the gaussian distribution.
  • scale (float or int, default=1.0): the scale (sigma) of the gaussian distribution.
  • unit (astropy.units object, optional): the units of the provided values.
  • label (string, optional): a label for the distribution. This is used for the x-label while plotting the distribution if label_latex is not provided, as well as a shorthand notation when creating a Composite distribution.
  • label_latex (string, optional): a latex label for the distribution. This is used for the x-label while plotting.
  • wrap_at (float or False or None, optional, default=None): value to wrap all sampled values. If None, will default to 0-2pi if unit is angular (0-360 for degrees), or 0-1 if unit is cycles. If False, will not wrap. See Gaussian.wrap_at and Gaussian.wrap for more details.

Returns