popsynth.populations.pareto_populations module

class popsynth.populations.pareto_populations.ParetoHomogeneousSphericalPopulation(Lambda: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234)

Bases: SphericalPopulation

__init__(Lambda: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234)

A population built on the ConstantSphericalDistribution spatial distribution and the ParetoDistribution luminosity distribution.

Parameters

• Lambda (float) – Density per unit volume

• Lmin (float) – Minimum value of the luminosity

• alpha (float) – Index of the luminosity distribution

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.pareto_populations.ParetoZPowerSphericalPopulation(Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234)

Bases: ZPowerSphericalPopulation

__init__(Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234)

A population built on the ZPowerSphericalDistribution spatial distribution and the ParetoDistribution luminosity distribution.

Parameters

• Lambda (float) – Density per unit volume

• delta (float) – Index of the spatial distribution

• Lmin (float) – Minimum value of the luminosity

• alpha (float) – Index of the luminosity distribution

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.pareto_populations.ParetoZPowerCosmoPopulation(Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

Bases: ZPowerCosmoPopulation

__init__(Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

A population built on the ZPowerCosmoDistribution spatial distribution and the ParetoDistribution luminosity distribution.

Parameters

• Lambda (float) – Density in units of Gpc^-3

• delta (float) – Index of the spatial distribution

• Lmin (float) – Minimum value of the luminosity

• alpha (float) – Index of the luminosity distribution

• r_max (float) – Maximum redshift

• seed (int) – Random seed

• is_rate (bool) – True if modelling a population of transient events, False if modelling a population of steady-state objects. Affects the time_adjustment method used in cosmo calculations. Default is True.

class popsynth.populations.pareto_populations.ParetoSFRPopulation(r0: float, a: float, rise: float, decay: float, peak: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

Bases: SFRPopulation

__init__(r0: float, a: float, rise: float, decay: float, peak: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

A population built on the SFRDistribution spatial distribution and the ParetoDistribution luminosity distribution.

Parameters

• r0 (float) – Local density in units of Gpc^-3

• a (float) – Offset at z=0

• rise (float) – Rise at low z

• decay (float) – Decay at high z

• peak (float) – Peak of z distribution

• Lmin (float) – Minimum value of the luminosity

• alpha (float) – Index of the luminosity distribution

• r_max (float) – Maximum redshift

• seed (int) – Random seed

• is_rate (bool) – True if modelling a population of transient events, False if modelling a population of steady-state objects. Affects the time_adjustment method used in cosmo calculations. Default is True.