popsynth.populations package

Submodules

• popsynth.populations.bpl_population module
• popsynth.populations.lognormal_population module
• popsynth.populations.pareto_populations module
• popsynth.populations.schechter_populations module
• popsynth.populations.spatial_populations module

Module contents

class popsynth.populations.SphericalPopulation(Lambda: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None)

Bases: PopulationSynth

__init__(Lambda: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None)

A generic spherical population based on ConstantSphericalDistribution.

Parameters

• Lambda (float) – Density per unit volume

• r_max (float) – Maximum distance

• seed (int) – Random seed

• luminosity_distribution (LuminosityDistribution, optional) – Luminosity distribution

class popsynth.populations.SFRPopulation(r0: float, a: float, rise: float, decay: float, peak: float, r_max: float = 5, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None, is_rate: bool = True)

Bases: PopulationSynth

__init__(r0: float, a: float, rise: float, decay: float, peak: float, r_max: float = 5, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None, is_rate: bool = True)

A cosmological population with a density that scales similarly to the star formation rate. Based on ZpowerCosmoDistribution.

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

• r_max (float) – Maximum redshift

• seed (int) – Random seed

• luminosity_distribution (LuminosityDistribution, optional) – Luminosity distribution

• 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.ZPowerSphericalPopulation(Lambda: float, delta: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None)

Bases: PopulationSynth

__init__(Lambda: float, delta: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None)

A spherical population with a density that scales as (r+1)^delta. Based on ZpowerSphericalDistribution.

Parameters

• Lambda (float) – Local density per unit volume

• delta (float) – Index of spatial distribution

• r_max (float) – Maximum distance

• seed (int) – Random seed

• luminosity_distribution (LuminosityDistribution, optional) – Luminosity distribution

class popsynth.populations.ZPowerCosmoPopulation(Lambda: float, delta: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None, is_rate: bool = True)

Bases: PopulationSynth

__init__(Lambda: float, delta: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: Optional[LuminosityDistribution] = None, is_rate: bool = True)

A cosmological population with a density that scales as (z+1)^delta. Based on ZpowerCosmoDistribution.

Parameters

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

• delta (float) – Index of spatial distribution

• r_max (float) – Maximum redshift

• seed (int) – Random seed

• luminosity_distribution (LuminosityDistribution, optional) – Luminosity distribution

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

class popsynth.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.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.BPLHomogeneousSphericalPopulation(Lambda: float, Lmin: float, alpha: float, Lbreak: float, beta: float, Lmax: float, r_max: float = 5, seed: int = 1234)

Bases: SphericalPopulation

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

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

Parameters

• Lambda (float) – Density per unit volume

• Lmin (float) – Minimum value of the luminosity

• alpha (float) – Lower luminosity index

• Lbreak (float) – Break luminosity

• beta (float) – Upper luminosity index

• Lmax (float) – Maximum value of the luminosity

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.BPLSFRPopulation(r0: float, a: float, rise: float, decay: float, peak: float, Lmin: float, alpha: float, Lbreak: float, beta: float, Lmax: 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, Lbreak: float, beta: float, Lmax: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

A population built on the SFRDistribution spatial distribution and the BPLDistribution 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) – Lower luminosity index

• Lbreak (float) – Break luminosity

• beta (float) – Upper luminosity index

• Lmax (float) – Maximum value of the luminosity

• r_max (float) – Maximum redshift

• seed (int) – Random seed

class popsynth.populations.BPLZPowerSphericalPopulation(Lambda: float, delta: float, Lmin: float, alpha: float, Lbreak: float, beta: float, Lmax: float, r_max: float = 5, seed: int = 1234)

Bases: ZPowerSphericalPopulation

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

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

Parameters

• Lambda (float) – Density per unit volume

• delta (float) – Index of spatial distribution

• Lmin (float) – Minimum value of the luminosity

• alpha (float) – Lower luminosity index

• Lbreak (float) – Break luminosity

• beta (float) – Upper luminosity index

• Lmax (float) – Maximum value of the luminosity

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.BPLZPowerCosmoPopulation(Lambda: float, delta: float, Lmin: float, alpha: float, Lbreak: float, beta: float, Lmax: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

Bases: ZPowerCosmoPopulation

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

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

Parameters

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

• delta (float) – Index of spatial distribution

• Lmin (float) – Minimum value of the luminosity

• alpha (float) – Lower luminosity index

• Lbreak (float) – Break luminosity

• beta (float) – Upper luminosity index

• Lmax (float) – Maximum value of the luminosity

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.SchechterHomogeneousSphericalPopulation(Lambda: float, Lmin: float, alpha: float, r_max: float = 10, seed: int = 1234)

Bases: SphericalPopulation

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

A population built on the ConstantSphericalDistribution spatial distribution and the SchechterDistribution 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.SchechterSFRPopulation(r0: float, a: float, rise: float, decay: float, peak: float, Lmin: float, alpha: float, r_max: float = 10, 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 = 10, seed: int = 1234, is_rate: bool = True)

A population built on the SFRDistribution spatial distribution and the SchechterDistribution 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.

class popsynth.populations.SchechterZPowerSphericalPopulation(Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 10, seed: int = 1234)

Bases: ZPowerSphericalPopulation

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

A population built on the ZPowerSphericalDistribution spatial distribution and the SchechterDistribution 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.SchechterZPowerCosmoPopulation(Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 10, seed: int = 1234, is_rate: bool = True)

Bases: ZPowerCosmoPopulation

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

A population built on the ZPowerCosmoDistribution spatial distribution and the SchechterDistribution 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.Log10NormalHomogeneousSphericalPopulation(Lambda: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

Bases: SphericalPopulation

__init__(Lambda: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

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

Parameters

• Lambda (float) – Density per unit volume

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation of the luminosity distribution

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.Log10NormalSFRPopulation(r0: float, a: float, rise: float, decay: float, peak: float, mu: float, tau: 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, mu: float, tau: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

A population built on the SFRDistribution spatial distribution and the Log10NormalDistribution 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

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation 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.Log10NormalZPowerSphericalPopulation(Lambda: float, delta: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

Bases: ZPowerSphericalPopulation

__init__(Lambda: float, delta: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

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

Parameters

• Lambda (float) – Density per unit volume

• delta (float) – Index of the spatial distribution

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation of the luminosity distribution

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.Log10NormalZPowerCosmoPopulation(Lambda: float, delta: float, mu: float, tau: float, r_max: float = 5, seed: float = 1234, is_rate: float = True)

Bases: ZPowerCosmoPopulation

__init__(Lambda: float, delta: float, mu: float, tau: float, r_max: float = 5, seed: float = 1234, is_rate: float = True)

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

Parameters

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

• delta (float) – Index of the spatial distribution

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation 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.LogNormalHomogeneousSphericalPopulation(Lambda: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

Bases: SphericalPopulation

__init__(Lambda: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

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

Parameters

• Lambda (float) – Density per unit volume

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation of the luminosity distribution

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.LogNormalSFRPopulation(r0: float, a: float, rise: float, decay: float, peak: float, mu: float, tau: 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, mu: float, tau: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

A population built on the SFRDistribution spatial distribution and the LogNormalDistribution 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

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation 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.LogNormalZPowerSphericalPopulation(Lambda: float, delta: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

Bases: ZPowerSphericalPopulation

__init__(Lambda: float, delta: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234)

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

Parameters

• Lambda (float) – Density per unit volume

• delta (float) – Index of the spatial distribution

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation of the luminosity distribution

• r_max (float) – Maximum distance

• seed (int) – Random seed

class popsynth.populations.LogNormalZPowerCosmoPopulation(Lambda: float, delta: float, mu: float, tau: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True)

Bases: ZPowerCosmoPopulation

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

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

Parameters

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

• delta (float) – Index of the spatial distribution

• mu (float) – Mean of the luminosity distribution

• tau (float) – Standard deviation 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.