tasks.reconfirming_stellar_parameters

  1"""
  2Reconfirming stellar parameters, enriching original datasets
  3with additional data from various data sources.
  4"""
  5
  6import pandas
  7import numpy
  8# import json
  9
 10from typing import Optional, List, Dict
 11
 12try:
 13    from ..utils.databases import tap, simbad
 14except ImportError:
 15    # what the hell is even that, for using the installed package
 16    # imports need to be done way, but for generating documentation
 17    # with pdoc it needs to be a different way
 18    from utils.databases import tap, simbad
 19
 20
 21def lookForParametersInGaia(
 22    originalTable: pandas.DataFrame,
 23    adqlTable: str,
 24    adqlParameters: List[str],
 25    simbadIDversion: Optional[str] = None
 26) -> pandas.DataFrame:
 27    """
 28    Looking for specified parameters in GAIA database:
 29
 30    1. Opens a pickle file with original [Pandas](https://pandas.pydata.org)
 31    table;
 32    2. Extracts unique list of star names;
 33    3. Gets their GAIA IDs from Simbad database;
 34    4. Queries GAIA database for given parameters;
 35    5. Adds found parameters to the original table as new columns.
 36
 37    Example:
 38
 39    ``` py
 40    from phab.utils.files import pickle
 41    from phab.tasks import reconfirming_stellar_parameters
 42
 43    originalTable = pickle.openPickleAsPandasTable("./data/systems-528n.pkl")
 44    tbl = reconfirming_stellar_parameters.lookForParametersInGaia(
 45        originalTable,
 46        "gaiadr3.astrophysical_parameters",
 47        [
 48            "age_flame",
 49            "logg_gspphot",
 50            "mass_flame",
 51            "mh_gspphot",
 52            "mh_gspspec",
 53            "radius_flame",
 54            "radius_gspphot",
 55            "teff_esphs",
 56            "teff_espucd",
 57            "teff_gspphot",
 58            "teff_gspspec",
 59            "teff_msc1",
 60            "ew_espels_halpha",
 61            "ew_espels_halpha_model"
 62        ],
 63        "dr3"
 64    )
 65    ```
 66
 67    You might need to provide `simbadIDversion` parameter (*the `dr3` value
 68    here*) if SIMBAD (`utils.databases.simbad.findIdentificatorFromAnotherCatalogue`)
 69    returns IDs like `DR3 2135237601028549888` and you need to get exactly
 70    the DR3 ones.
 71
 72    As a result, your original table `tbl` will be enriched with additional
 73    columns according to the list of provided astrophysical parameters.
 74    """
 75
 76    starNames = originalTable["star_name"].unique()
 77
 78    print("\nGetting GAIA IDs from SIMBAD...\n")
 79
 80    stars: Dict[str, Optional[str]] = {}
 81    for star in starNames:
 82        oid = simbad.findIdentificatorFromAnotherCatalogue(
 83            star,
 84            "gaia",
 85            simbadIDversion
 86        )
 87        if oid is None:
 88            print(f"- [WARNING] did not GAIA ID for [{star}]")
 89        else:
 90            print(f"- found GAIA ID for [{star}]: {oid}")
 91            stars[star] = oid
 92
 93    # print(json.dumps(stars, indent=4))
 94
 95    print("\nLooking for parameters in GAIA...\n")
 96
 97    for parameter in adqlParameters:
 98        originalTable[parameter] = numpy.array(numpy.nan, dtype=float)
 99
100    foundCnt = 0
101    for star in stars:
102        gaiaID = stars[star]
103        print(f"- {star} | {gaiaID}...")
104        resultsGAIA = tap.queryService(
105            tap.getServiceEndpoint("gaia"),
106            " ".join((
107                f"SELECT {', '.join(adqlParameters)}",
108                f"FROM {adqlTable}",
109                f"WHERE source_id = {gaiaID}"
110            ))
111        )
112        if resultsGAIA is None:
113            print(f"- [WARNING] did not found anything in GAIA for [{gaiaID}]")
114        else:
115            tbl = resultsGAIA.to_table().to_pandas()
116            foundCnt += 1
117            if len(tbl) > 1:
118                print(
119                    " ".join((
120                        "- [WARNING] GAIA has more than one record",
121                        f"for ID [{gaiaID}], will take only the first one"
122                    ))
123                )
124            # add found values to the new columns in the original table
125            for parameter in adqlParameters:
126                originalTable.loc[
127                    originalTable["star_name"] == star,
128                    parameter
129                ] = tbl.head(1)[parameter][0]
130
131    print(f"\nFound parameters for {foundCnt}/{len(stars)} stars\n")
132
133    return originalTable