rail.utils.catalog_tag module

class rail.utils.catalog_tag.Band

Bases: Configurable

Information about a particular filter Band used for photometric redshifts.

This is just a name and a redenning parameter: a_env.

The name is used for lookup and should be unique. It should match the name of the associated filter file. These are typically found in: rail_base/src/rail/examples_data/estimation_data/data/FILTER

The a_env parameter can be computed from filter curves using code in rail_astro_tools:

https://github.com/LSSTDESC/rail_astro_tools/blob/main/src/rail/tools/filter_tools.py

__init__(**kwargs)

C’tor

Parameters:: kwargs (Any) – Configuration parameters for this Band, must match class.config_options data members
Return type:: None

classmethod clear()

Return type:: None

classmethod get_band(key)

Return a particular band

Parameters:: key (str)
Return type:: Band

yaml_tag: str = 'Band'

class rail.utils.catalog_tag.CatalogTag

Bases: Configurable

Helper class to specify particulars about a particular catalog.

This keep track of things like the mapping between band names and columns, names of special columns like the objectId and the ‘true’ redshift, gaurd values used to specify non-detections or non-observations.

Expected usage is that user will define a yaml file with the various datasets that they wish to use with the following example syntax:

Catalogs:
  - CatalogTag:
      name: "com_cam"
      mag_column_template: "{band}_cModelMag"
      mag_err_column_template: "{band}_cModelMagErr"
      filter_template: "comcam_{band}"
      band_list: ['u', 'g', 'r', 'i', 'z', 'y']
      bands:
        u:
          mag_limit: 26.4
       g:
          mag_limit: 27.8
       r:
          mag_limit: 27.1
       i:
          mag_limit: 26.7
       z:
          mag_limit: 25.8
       y:
          mag_limit: 24.6

Notes

The files in the yaml file should match the class config_options.

The mapping between bands and magnitude, magnitude error columns is constructed by looping over the band_list add resolving mag_column_template and mag_err_column_template.

Similarly, the mapping between bands and filters is constructed by looping over the band_list add resolving filter_template.

The bands field is used to provide band-specific overrides. At a minimum this must include 5-sigma limiting magnitdues.

But it may also include specfic overrides for the names of the mag_column, mag_err_columns and filter template file.

__init__(**kwargs)

C’tor

Parameters:: kwargs (Any) – Configuration parameters for this Band, must match class.config_options data members
Return type:: None

classmethod apply(tag)

Activate a particular tag

Parameters:: tag (str)
Return type:: None

apply_tag()

Apply this tag

Return type:: None

band_name_dict()

Retrun the mapping from band to column names

Return type:: dict[str, str]

classmethod clear()

Return type:: None

classmethod get_active_tag()

Return the currently active tag

Return type:: CatalogTag | None

classmethod get_tag(tag)

Parameters:: tag (str)
Return type:: CatalogTag

yaml_tag: str = 'CatalogTag'