popsynth.populations.spatial_populations module

class popsynth.populations.spatial_populations.MWRadialPopulation(rho: float, a: float = 1.64, b: float = 4.01, R1: float = 0.55, R0: float = 8.5, r_max: float = 20, seed: int = 1234, luminosity_distribution: popsynth.distribution.LuminosityDistribution = None)[source]

Bases: popsynth.population_synth.PopulationSynth

__init__(rho: float, a: float = 1.64, b: float = 4.01, R1: float = 0.55, R0: float = 8.5, r_max: float = 20, seed: int = 1234, luminosity_distribution: popsynth.distribution.LuminosityDistribution = None)[source]

A Milky-way like population based on SpiralGalaxyDistribution.

Parameters:
  • rho (float) – Local density
  • a (float) – Shape parameter
  • b (float) – Shape parameter
  • R1 (float) – Scale parameter
  • R0 (float) – Scale parameter
  • r_max (float) – Maximum distance
  • 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.spatial_populations.SFRPopulation(r0: float, a: float, rise: float, decay: float, peak: float, r_max: float = 5, seed: int = 1234, luminosity_distribution: popsynth.distribution.LuminosityDistribution = None, is_rate: bool = True)[source]

Bases: popsynth.population_synth.PopulationSynth

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

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.spatial_populations.SphericalPopulation(Lambda: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: popsynth.distribution.LuminosityDistribution = None)[source]

Bases: popsynth.population_synth.PopulationSynth

__init__(Lambda: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: popsynth.distribution.LuminosityDistribution = None)[source]

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.spatial_populations.ZPowerCosmoPopulation(Lambda: float, delta: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: popsynth.distribution.LuminosityDistribution = None, is_rate: bool = True)[source]

Bases: popsynth.population_synth.PopulationSynth

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

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

Bases: popsynth.population_synth.PopulationSynth

__init__(Lambda: float, delta: float, r_max: float = 5.0, seed: int = 1234, luminosity_distribution: popsynth.distribution.LuminosityDistribution = None)[source]

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