Source code for popsynth.populations.pareto_populations

from popsynth.distributions.pareto_distribution import ParetoDistribution
from popsynth.populations.spatial_populations import (
    SFRPopulation,
    SphericalPopulation,
    ZPowerCosmoPopulation,
    ZPowerSphericalPopulation,
)


[docs]class ParetoHomogeneousSphericalPopulation(SphericalPopulation):
[docs] def __init__( self, Lambda: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234, ): """ A population built on the :class:`ConstantSphericalDistribution` spatial distribution and the :class:`ParetoDistribution` luminosity distribution. :param Lambda: Density per unit volume :type Lambda: float :param Lmin: Minimum value of the luminosity :type Lmin: float :param alpha: Index of the luminosity distribution :type alpha: float :param r_max: Maximum distance :type r_max: float :param seed: Random seed :type seed: int """ luminosity_distribution = ParetoDistribution(seed=seed) luminosity_distribution.Lmin = Lmin luminosity_distribution.alpha = alpha super(ParetoHomogeneousSphericalPopulation, self).__init__( Lambda=Lambda, r_max=r_max, seed=seed, luminosity_distribution=luminosity_distribution, )
[docs]class ParetoZPowerSphericalPopulation(ZPowerSphericalPopulation):
[docs] def __init__( self, Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234, ): """ A population built on the :class:`ZPowerSphericalDistribution` spatial distribution and the :class:`ParetoDistribution` luminosity distribution. :param Lambda: Density per unit volume :type Lambda: float :param delta: Index of the spatial distribution :type delta: float :param Lmin: Minimum value of the luminosity :type Lmin: float :param alpha: Index of the luminosity distribution :type alpha: float :param r_max: Maximum distance :type r_max: float :param seed: Random seed :type seed: int """ luminosity_distribution = ParetoDistribution(seed=seed) luminosity_distribution.Lmin = Lmin luminosity_distribution.alpha = alpha super(ParetoZPowerSphericalPopulation, self).__init__( Lambda=Lambda, delta=delta, r_max=r_max, seed=seed, luminosity_distribution=luminosity_distribution, )
[docs]class ParetoZPowerCosmoPopulation(ZPowerCosmoPopulation):
[docs] def __init__( self, Lambda: float, delta: float, Lmin: float, alpha: float, r_max: float = 5, seed: int = 1234, is_rate: bool = True, ): """ A population built on the :class:`ZPowerCosmoDistribution` spatial distribution and the :class:`ParetoDistribution` luminosity distribution. :param Lambda: Density in units of Gpc^-3 :type Lambda: float :param delta: Index of the spatial distribution :type delta: float :param Lmin: Minimum value of the luminosity :type Lmin: float :param alpha: Index of the luminosity distribution :type alpha: float :param r_max: Maximum redshift :type r_max: float :param seed: Random seed :type seed: int :param is_rate: `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`. :type is_rate: bool """ luminosity_distribution = ParetoDistribution(seed=seed) luminosity_distribution.Lmin = Lmin luminosity_distribution.alpha = alpha super(ParetoZPowerCosmoPopulation, self).__init__( Lambda=Lambda, delta=delta, r_max=r_max, seed=seed, luminosity_distribution=luminosity_distribution, is_rate=is_rate, )
[docs]class ParetoSFRPopulation(SFRPopulation):
[docs] def __init__( self, 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 :class:`SFRDistribution` spatial distribution and the :class:`ParetoDistribution` luminosity distribution. :param r0: Local density in units of Gpc^-3 :type r0: float :param a: Offset at z=0 :type a: float :param rise: Rise at low z :type rise: float :param decay: Decay at high z :type decay: float :param peak: Peak of z distribution :type peak: float :param Lmin: Minimum value of the luminosity :type Lmin: float :param alpha: Index of the luminosity distribution :type alpha: float :param r_max: Maximum redshift :type r_max: float :param seed: Random seed :type seed: int :param is_rate: `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`. :type is_rate: bool """ luminosity_distribution = ParetoDistribution(seed=seed) luminosity_distribution.Lmin = Lmin luminosity_distribution.alpha = alpha super(ParetoSFRPopulation, self).__init__( r0=r0, a=a, rise=rise, decay=decay, peak=peak, r_max=r_max, seed=seed, luminosity_distribution=luminosity_distribution, is_rate=is_rate, )