skypy.halos.quenching.environment_quenched

skypy.halos.quenching.environment_quenched(nh, probability)[source] [edit on github]

Environment quenching function. This function implements the model proposed by A.Amara where the probability of a subhalo being quenched is a fixed probability. The model is inspired on [1] and [2].

Parameters:
nh: integer

Number of subhalos.

probability: float

Quenching probability.

Returns:
quenched: (nh,) array_like, boolean

Boolean array indicating which subhalo’s host galaxies are (satellite) environment-quenched.

References

[1]

Peng et al. 2010, doi 10.1088/0004-637X/721/1/193.

[2]

Birrer et al. 2014, arXiv 1401.3162.

Examples

This example shows how many subhalos are environtment quenched (True) and how many survive (False) from a list of 1000 halos:

>>> import numpy as np
>>> from skypy.halos.quenching import environment_quenched
>>> from collections import Counter
>>> quenched = environment_quenched(1000, 0.5)
>>> Counter(quenched)
Counter({...})