extract_catls¶
-
cosmo_utils.mock_catalogues.catls_utils.
extract_catls
(catl_kind='data', catl_type='mr', sample_s='19', datatype='.hdf5', catl_info='members', halotype='fof', clf_method=3, hod_n=0, clf_seed=1235, dv=1.0, perf_opt=False, return_len=False, print_filedir=True)[source] [edit on github]¶ Extracts a list of synthetic catalogues given input parameters
Parameters: catl_kind : {‘data’, ‘mocks’} str, optional
Type of catalogue to use. This variable is set to
data
by default.- Options:
data
: catalogues come from SDSSreal
cataloguemocks
: catalogue come from SDSSmock
catalogues
catl_type : {‘mr’, ‘mstar’} str, optional
Type of catalogue to use. It shows which abundance matching method was used for the CLF when assigning halo masses. This variable is set to ‘mr’ by default.
- Options:
mr
: Uses r-band absolute magnitudemstar
: Uses stellar masses
sample_s : {‘19’, ‘20’, ‘21’} str, optional
Volume-limited sample to use. This variable is set to ‘19’ by default.
- Options:
- ‘19’ : Uses the Mr19 volume-limited sample, i.e. ‘Consuelo’
- ‘20’ : Uses the Mr20 volume-limited sample, i.e. ‘Esmeralda’
- ‘21’ : Uses the Mr21 volume-limited sample, i.e. ‘Carmen’
datatype : {‘.hdf5’} str, optional
Data type of the files to be indexed in the folder. This variable is set to ‘.hdf5’ by default.
catl_info : {‘members’, ‘groups’} str, optional
Option for which kind of catalogues to use.
- Options:
members
: Member galaxies of group cataloguesgroups
: Catalogues withgroup
information.
halotype : {‘fof’, ‘so’} str, optional
Type of the dark matter halo of the simulation used to create the synthetic catalogues. This variable is set to
fof
by default.- Options:
- ‘fof’: Friends-of-Friends halos.
- ‘so’ : Spherical overdensity halos.
clf_method : {1, 2, 3} int, optional
Method for assigning galaxy properties to mock galaxies. This variable is set to
3
by default.- Options:
1
: Independent assigment of (g-r) color, sersic, and log(ssfr)2
: (g-r) decides active/passive designation and draw values- independently.
3
: (g-r) decides active/passive designations, and- assigns other galaxy properties for that given galaxy.
hod_n : {0, 1} int, optional
HOD model to use. Only relevant when
catl_kind == mocks
.clf_seed : int, optional
Seed used for the
CLF
random seed. This variable is set to1235
by default.dv : float, optional
Difference between galaxy and mass velocity profiles (v_g-v_c)/(v_m-v_c). This value is set to
1.0
by default.perf_opt :
bool
, optionalIf True, it chooses to analyze the
perfect
set of synthetic catalogues. This variable is set toFalse
by default.return_len :
bool
, optionalIf True, the function returns the total number of elements in the folder that match the criteria.
print_filedir :
bool
, optionalIf True, the output directory is printed onto the screen.
Returns: catl_arr :
numpy.ndarray
Array of elements/files matching the
datatype
type in the directory.Raises: LSSUtils_Error : Exception from
LSSUtils_Error
Program exception if input parameters are accepted.