synthpop.modules.metallicity.gaussian

Metallicity class for a Gaussian distribution, given a mean, standard deviation, and upper and lower limits.

Classes

Gaussian

Gaussian metallicity distribution

Module Contents

class synthpop.modules.metallicity.gaussian.Gaussian(mean: float, std: float, low_bound: float = -4, high_bound: float = 0.5, gradient=0.0, **kwargs)

Bases: synthpop.modules.metallicity._metallicity.Metallicity

Gaussian metallicity distribution

Attributes

meanfloat [[Fe/H]]

the mean metallicity in [Fe/H] for the Gaussian distribution

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

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'

mean

std

lower = -4

upper = 0.5

gradient = 0.0

draw_random_metallicity(N: int or None = None, x=None, y=None, z=None, **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]

average_metallicity() → float

Determine the average metallicity of the population

likelyhood_distribution(met: numpy.ndarray) → numpy.ndarray

analytic version of likelyhood_distribution. only used for the validating