catl_keys_prop¶
-
sdss_catl_utils.mocks_manager.catl_utils.
catl_keys_prop
(catl_kind='data', catl_info='memb', return_type='list')[source] [edit on github]¶ Provides a dictionary/list with the corresponding keys for 1) specific star formation rate (sSFR) and 2) stellar mass.
Parameters: - catl_kind : {
data
,mocks
}str
, optional Type of the catalogue being analyzed. This variable corresponds to whether a
real
orsynthetic/mock
catalogue is being read/analyzed. This variable is set todata
by default.- Options:
data
: Catalogue(s) from the SDSSreal
cataloguesmocks
: Catalogue(s) from themock
catalogues.
- catl_info : {
memb
,groups
}bool
, optional Option for which type of catalogue is being analyzed. This variable correspondos to whether a
galaxy
-catalogue or agroup
-catalogue is being analyzed. This variable is set tomemb
by default.- Options:
memb
: Galaxy catalogue with themember
galaxies of groups.groups
: Catalogues withgroup
information.
- return_type : {
list
,dict
}str
, optional Type of output to be returned. This variable is set to
list
by default.- Options:
list
: Returns the output as part of a list. The order of- the elements are:
'group mass'
,'groupid/haloid'
, andGroup/Halo ID
.
- Returns
- ————
- catl_objs :
dict
orlist
Dictionary or list of keys for
logssfr
andlogmstar
columns in catalogues. This variable depends on the choice ofreturn_type
.
Raises: - SDSSCatlUtils_Error : Exception from
SDSSCatlUtils_Error
Program exception if input parameters are
not
accepted.
Examples
This function can be used for several different combinations of parameters. For example, if we wanted to analyze a
data
catalogue, and have this function return alist
as the output, one could write:>>> catl_keys_prop(catl_kind='data', return_type='list') ['logssfr', 'logMstar_JHU']
This list corresponds to the 1)
specific star formation rate
key and 2)stellar mass
key.If instead, we wanted to analyze a
mock
catalogue and return the appropriate keys for agroup catalogue
, we could write:>>> catl_keys_prop(catl_kind='mocks', catl_info='groups') ['logssfr', 'logMstar']
For more information and examples, please refer to Getting started with SDSS_Catl_Utils.
- catl_kind : {