catl_keys¶
-
cosmo_utils.mock_catalogues.catls_utils.
catl_keys
(catl_kind, perf_opt=False, return_type='list')[source] [edit on github]¶ Dictionary keys for the different types of catalogues
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
perf_opt :
bool
, optionalOption for using a
perfect
mock catalogue.return_type : {‘list’, ‘dict’} str, optional
Type of output to the be returned. This variable is set to
list
by default.- Options:
- ‘list’ : Returns the values as part of a list
- ‘dict’ : Returns the values as part of a python dictionary
Returns: catl_keys : python dictionary or array_like
Dictionary/array with the proper keys for the catalogue(s).
Order : 1)
gm_key
, 2)id_key
, 3)galtype_key
Raises: LSSUtils_Error : Exception from
LSSUtils_Error
Program exception if input parameters are accepted.
Examples
>>> catl_keys('data', perf_opt=False, return_type='list') ['M_h', 'groupid', 'galtype']
>>> catl_keys('mocks', perf_opt=True, return_type='list') ['M_h', 'haloid', 'galtype']