catl_keys

sdss_catl_utils.mocks_manager.catl_utils.catl_keys(catl_kind='data', perf_opt=False, return_type='list')[source] [edit on github]

Provides a dictionary/list with the corresponding keys for 1) halo mass, 2) Haloid/GroupID, 3) Group/Halo Galaxy-Type.

Parameters:
catl_kind : {data, mocks} str, optional

Type of the catalogue being analyzed. This variable corresponds to whether a real or synthetic/mock catalogue is being read/analyzed. This variable is set to data by default.

Options:
  • data: Catalogue(s) from the SDSS real catalogues
  • mocks: Catalogue(s) from the mock catalogues.
perf_opt : bool, optional

If True, it returns the corresponding keys for a perfect SDSS catalogue. This option only applies when catl_kind == 'mocks'.

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', and Group/Halo ID.
Returns:
catl_objs : dict or list

Dictionary or list of keys for group/halo mass, group ID and galaxy type columns in catalogues. This variable depends on the choice of return_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 a list as the output, one could write:

>>> catl_keys(catl_kind='data', return_type='list')
['M_h', 'groupid', 'galtype']

This list corresponds to the 1) Group estimated mass, 2) Galaxy’s group ID, and 3) Galaxy’s group galaxy type.

If instead, we wanted to analyze perfect mock catalogues, we could write:

>>> catl_keys(catl_kind='mocks', perf_opt=True, return_type='list')
['M_h', 'haloid', 'galtype']

For more information and examples, please refer to Getting started with SDSS_Catl_Utils.