synthpop.modules.metallicity.single_value

Metallicity module for a single value

Classes

Metallicity distribution for a single value

Module Contents

class synthpop.modules.metallicity.single_value.SingleValue(met_value: float, **kwargs)

Bases: synthpop.modules.metallicity._metallicity.Metallicity

Metallicity distribution for a single value

Attributes

metallicity_valuefloat [[Fe/H]]: [Fe/H] value for all stars

metallicity_func_name = 'single_value'

metallicity_value

draw_random_metallicity(N: int or None = None, **kwargs) → np.ndarray or float

Generate a “random” metallicity from a single value distribution

Parameters

Nint, None, optional: if N is set to an integer, an array with N random metallicities is returned

Returns

metfloat, ndarray [[Fe/H]]: single metallicities or numpy array of N metallicities in [[Fe/H]]

average_metallicity() → float: Determine the average metallicity of the population