popsynth.distributions.pareto_distribution module

class popsynth.distributions.pareto_distribution.ParetoDistribution(seed: int = 1234, name: str = 'pareto')[source]

Bases: popsynth.distribution.LuminosityDistribution

Lmin
__init__(seed: int = 1234, name: str = 'pareto')[source]

A Pareto luminosity function.

alpha``*``Lmin``^``alpha / L^(``alpha``+1)

Parameters:
  • seed (int) – Random seed
  • name (str) – Name of the distribution
  • Lmin (DistributionParameter) – Minimum value of the luminosity
  • alpha (DistributionParameter) – Index of the pareto distribution
alpha
draw_luminosity(size: int = 1)[source]

function to draw the luminosity via an alternative method must be implemented in child class

Parameters:size
Returns:
phi(L)[source]

The functional form of the distribution. not required for sampling :param luminosity: Luminosity