synthpop.modules.population_density.gums_halo

Spheroidal density distribution, used for the Halo in the Gaia Universe Model Snapshot and other models.

Classes

This is the Parent Class for population densities functions

Module Contents

class synthpop.modules.population_density.gums_halo.GumsHalo(rho0, e=0.774, rc=2.175827881, ah=1, dh=2.777231, **kwargs)

Bases: synthpop.modules.population_density._population_density.PopulationDensity

This is the Parent Class for population densities functions

Attributes

population_density_namestr: name of the population density
density_unitstr: specifier if density profile returns “number”-, “mass”- or “init_mass”-density

(more attributes are specified in the subclasses)

Methods

__init__() :: Initialize the PopulationDensity class
density(r: ndarray, theta, ndarray, z: ndarray)ndarray: estimate the density at (r,theta,z) (specified in the subclasses)

population_density_name = 'GumsHalo'

density_unit = 'mass'

rho0

e = 0.774

rc = 2.175827881

ah = 1

dh = 2.777231

density(r: numpy.ndarray, phi_rad: numpy.ndarray, z: numpy.ndarray) → numpy.ndarray

Estimates the density at the given position

Parameters

rndarray [‘kpc’]: Distance to z axis
phi_radndarray [‘rad’]: azimuth angle of the stars. phi_rad = 0 is pointing towards sun.

z : height above the galactic plane (corrected for warp of the galaxy)

Returns

rhondarray [M_sun/kpc^3 or #/kpc^3]: density at the given location, either in number density evolved mass density or initial mass density should be specified in density_unit.