INNER CODE UNIT · Python
apogee
jobovy/gaia_tools · gaia_tools/load/__init__.py:42
def apogee(xmatch=None,**kwargs):
"""
PURPOSE:
read the APOGEE allStar file
INPUT:
IF the apogee package is not installed:
dr= (14) SDSS data release
use_astroNN= (False) if True, swap in astroNN (Leung & Bovy 2019a) parameters (get placed in, e.g., TEFF and TEFF_ERR) and add astroNN distances (Leung & Bovy 2019b) and ages (Mackereth, Bovy, Leung, et al. 2019); use 'use_astroNN_abundances', 'use_astroNN_distances', and 'use_astroNN_ages' to only add abundances, distances, or ages respectively
ELSE you can use the same keywords as apogee.tools.read.allstar:
rmcommissioning= (default: True) if True, only use data obtained after commissioning
main= (default: False) if True, only select stars in the main survey
exclude_star_bad= (False) if True, remove stars with the STAR_BAD flag set in ASPCAPFLAG
exclude_star_warn= (False) if True, remove stars with the STAR_WARN flag set in ASPCAPFLAG
ak= (default: True) only use objects for which dereddened mags exist
akvers= 'targ' (default) or 'wise': use target AK (AK_TARG) or AK derived from all-sky WISE (AK_WISE)
rmnovisits= (False) if True, remove stars with no good visits (to go into the combined spectrum); shouldn't be necessary