synthpop.modules.metallicity.gaussian_gradient
Metallicity class for a Gaussian distribution with a gradient, given a mean, standard deviation, gradient, and upper and lower limits.
Classes
Gaussian subclass of Metallicity base class. This subclass is for populations that |
Module Contents
- class synthpop.modules.metallicity.gaussian_gradient.GaussianGradient(mean: float, std: float, low_bound: float = -4, high_bound: float = 0.5, radial_gradient: float = 0.0, **kwargs)
Bases:
synthpop.modules.metallicity._metallicity.MetallicityGaussian subclass of Metallicity base class. This subclass is for populations that have metallicity characterized by a gaussian metallicity distribution plus a radius gradient.
Attributes
- meanfloat [[Fe/H]]
the mean metallicity in [Fe/H] for the Gaussian distribution at the Solar position
- stdfloat [[Fe/H]]
the standard deviation of metallicity in [Fe/H] for the Gaussian distribution
- lower_boundfloat [[Fe/H]]
lower limit for truncation of the distribution
- upper_boundfloat [[Fe/H]]
upper limit for truncation of the distribution
- radial_gradientfloat [[Fe/H]/kpc]
metallicity gradient with Galactocentric radius
Methods
- __init__(self,Population)None
initialize the metallicity class, and set the control parameters.
- draw_random_metallicity(self, N: int or None = None)np.ndarray, float [[Fe/H]]
return a random metallicity drawn from a Gaussian distribution
- average_metallicity(self)float [[Fe/H]]
return the average metallicity
- metallicity_func_name = 'gaussian_gradient'
- mean
- std
- lower = -4
- upper = 0.5
- radial_gradient = 0.0
- draw_random_metallicity(N, x, y, z, **kwargs) np.ndarray or float
Returns one or more metallicities in [Fe/H] from a Gaussian distribution.
Parameters
- Nint, None, optional
if N is set to an integer, an array with N random ages is returned
Returns
- valndarray, float [Gyr]
single metallicities or ndarray of N metallicities in [Fe/H]