synthpop.modules.age.exponential

An exponential age distribution

Stars are assigned ages from an exponential distribution with a power law index and upper and lower limits.

Classes

Exponential

Exponential age distribution generator

Module Contents

class synthpop.modules.age.exponential.Exponential(gamma: float, low_bound: float = 0.0001, high_bound: float = 19.9526231497, **kwargs)

Bases: synthpop.modules.age._age.Age

Exponential age distribution generator

age_func_name = 'exponential'

gamma

lower = 0.0001

upper = 19.9526231497

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

Returns one or more ages [Gyr] from an exponential 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 age or ndarray of N ages in [Gyr]

average_age() → float

Return the average age of the population

get_maximum_age() → float

Return the maximum age that can be generated by the distribution.