Package: irgsctool
TMT-IRGSCIntroductionThis is a python repository dedicated to the development of the Near-Infrared Guide Star Catalog (IRGSC) for the Adaptive Optics (AO) observations of the Thirty Meter Telescope (TMT) project. This package generates the catalog by computing the NIR magnitudes of the optical stellar sources in the PANSTARSS DR2 data.Packagesirgsctool:This is a python package aimed to compute the NIR magnitudes of the optical sources in the PANSTARRS stack-photometric data by modelling them with the Kurucz, Castelli-Kurucz and Phoenix stellar atmospheric models. This package also validates the computed NIR magnitudes with the observed NIR data from UKIDSS (if it is available). The methodology implemented in this python package is implemented on twenty test-fields across the TMT's observable sky and the generated as well as validated IRGSC is available on the GitHub homepage. Most of the sources have the computed NIR magnitudes similar to the observed. The generated catalog contains astrometric information from GAIA DR3 also. Read the section below to see the nature of IRGSC.Nature of the generated catalogThe IRGSC generated has various information about the sources shown in the following Table. This table describes the columns in the IRGSC generated for a particular test field. The details of the flags, e.g., infoflags, filterflags, and qualityflags can be foundhere. These flags indicate various values assigned to
the source by the PANSTARRS team, which gives further information about the nature of the source
and the quality of its detection, which can help understand more about a particular object of interest.
It is to be noted that although this package relies on the PANSTARRS StackObjectView table, the Right
Ascension and Declination of the source is obtained from the mean photometric information as they are well calibrated using Gaia DR2.Column NameDescriptionData TypePS1_ObjIDSource identifier in the PANSTARRS datafloatPS1_raRight Ascencion of the source in the PANSTARRS DR2 weighted mean photometryfloatPS1_ra_errorUncertainty in PS1_rafloatPS1_decDeclination of the source in the PANSTARRS DR2 weighted mean photometryfloatPS1_dec_errorUncertainty in the PS1_decfloatPS1_gpsfpsf magnitude of the source in the g-band stacked photometryfloatPS1_gpsfUncertainty in PS1_gpsfPS1_rpsfpsf magnitude of the source in the r-band stacked photometryfloatPS1_rpsfUncertainty in PS1_rpsffloatPS1_ipsfpsf magnitude of the source in the i-band stacked photometryfloatPS1_ipsfUncertainty in PS1_ipsffloatPS1_zpsfpsf magnitude of the source in the z-band stacked photometryfloatPS1_zpsfUncertainty in PS1_zpsffloatPS1_ypsfpsf magnitude of the source in the y-band stacked photometryfloatPS1_ypsfUncertainty in PS1_ypsffloatSAM_NameName of the best-fitted Stellar Atmospheric Model (SAM)stringTeffBest-fitted model parameter: TefffloatloggBest-fitted model parameter: log(g)float[Fe/H]Best-fitted model parameter: [Fe/H]floatsam_gBest-fitted model magnitudes in PANSTARRS g-filterfloatsam_rBest-fitted model magnitudes in PANSTARRS r-filterfloatsam_iBest-fitted model magnitudes in PANSTARRS i-filterfloatsam_zBest-fitted model magnitudes in PANSTARRS z-filterfloatsam_yBest-fitted model magnitudes in PANSTARRS y-filterfloatsam_jBest-fitted model magnitudes in PANSTARRS j-filterfloatsam_hBest-fitted model magnitudes in PANSTARRS h-filterfloatsam_kBest-fitted model magnitudes in PANSTARRS k-filterfloatscale factorThe scale factor computed after fitting the SAMfloatscale factor errorError in the computed scale factorfloatd_devThe parameter denoting the goodness-of-fitfloatComputed JThe computed J magnitude in the Vega systemfloatComputed J errorError in computed J magnitudefloatComputed HThe computed H magnitude in the Vega systemfloatComputed H errorError in computed H magnitudefloatComputed KThe computed K magnitude in the Vega systemfloatComputed K errorError in computed K magnitudefloatgaia source idSource identifier in Gaia DR3floatgaia raRight Ascension of the source in Gaia DR3 catalogfloatgaia ra errorUncertainty in gaia rafloatgaia decDeclination of the source in Gaia DR3 catalogfloatgaia dec errorUncertainty in gaia decfloatgaia parallaxParallax (mas) of the source in the Gaia DR3 catalogfloatgaia parallax errorUncertainty in gaia parallaxfloatgaia pmpm of the source (mas/yr) in Gaia DR3 catalogfloatgaia pm rapm of the source along R.A. axis in the Gaia DR3 catalogfloatgaia pm ra errorUncertainty gaia pm rafloatgaia pm decpm of the source along Dec. axis in the Gaia DR3 catalogfloatgaia pm dec errorUncertainty gaia pm decfloatgaia ruweRenormalised Unit Weight Error flag of the source in Gaia DR3floatobjinfoflagThese flag values of the source in PANSTARRS data specify whether the object is a QSO, transient, asteroid, extended, a known solar system object, etc. in naturefloatobjqualityflagThese flag values denote if an object is real or a possible false positivefloatndetectionsThe number of times something is detected from the individual exposuresfloatnstackdetectionsThe number of stack detections after which the stack photometric measurements are donefloatginfoflagThese flags indicate the details of the g filter stack photometryfloatginfoflag2These flags indicate the details of the g filter stack photometryfloatginfoflag3These flags indicate the details of the g filter stack photometryfloatrinfoflagThese flags indicate the details of the r filter stack photometryfloatrinfoflag2These flags indicate the details of the r filter stack photometryfloatrinfoflag3These flags indicate the details of the r filter stack photometryfloatiinfoflagThese flags indicate the details of the i filter stack photometryfloatiinfoflag2These flags indicate the details of the i filter stack photometryfloatiinfoflag3These flags indicate the details of the i filter stack photometryfloatzinfoflagThese flags indicate the details of the z filter stack photometryfloatzinfoflag2These flags indicate the details of the z filter stack photometryfloatzinfoflag3These flags indicate the details of the z filter stack photometryfloatyinfoflagThese flags indicate the details of the y filter stack photometryfloatyinfoflag2These flags indicate the details of the y filter stack photometryfloatyinfoflag3These flags indicate the details of the y filter stack photometryfloatSAMThe name of the best-fitted Stellar Atmospheric Model (SAM)stringApplication of irgsctool on fieldsThe method developed for the generation of IRGSC has applied on twenty test fields across the sky. The generaed IRGSC is also valiated using the UKIDSS data available for those fields and the generated as well as validated catalog for these fields can be found in the 'generated_irgsc' directory.
In addition to the twenty test fields, additional ten catalogs are provided for the PANSTARRS Medium Deep Survey (MDS) Fieldsmore information available here. Since the MDS data is not publically released by the PANSTARRS, the optical data to generate the IRGSC for these fields is been taken from the PANSTARRS $3\pi$ survey.R.A.Decl.lbE(B-V)227.260.0359.2747.240.04335.00-1.2561.96-45.430.0760.001.25188.72-36.530.2630.000.50156.53-57.820.0211.167.83120.00-55.000.04225.532.190.0050.000.04269.93-13.4815.005.000.98334.8050.96100.00-5.000.28324.0951.4795.00-0.502.48298.0234.0270.003.001.010.000.0096.33-60.180.0234.50-5.16169.97-59.870.0136.25-4.50171.65-58.220.02164.2557.66148.3953.430.0466.7515.86180.08-22.320.5882.25-2.60205.62-19.480.62189.830.00296.3362.710.01150.2510.00227.7146.400.0315.00.90127.47-61.890.0235.0-3.50168.62-58.280.01RequirementsThis package is developed for Python versions above 3.6. It uses various other packages like:
astroquery,
astropy,
matplotlib,
astropy,
dustmaps,
numpy,
datetime,
requests, and
pyvo.Note: It is recommended to install irgsctool in a fresh environment and requires a stable internet connection to fetch the data.Installation1. Using pip:pip install irgsctool2. Using .zip file from GitHub:Download the .zip file fromhereand unzip it. Then open the directory in terminal and type:pip install .3 Using the Development version from GitHub:pip install git+https://github.com/sshah1502/irgsc@mainUsageclass GenerateIRGSCThis class is defined by importing irgsctool module and passing the R.A. and Decl. arguments. In this package, the catalog is generated using the optimal method described in the work report (link). After initializing, this module alerts the user if there is no observed NIR UKIDSS data for the given field.from irgsctool import GenerateIRGSC as GC
gc = GC(ra(float),dec(float))
gc.generate_irgsc()The module Generate_IRGSC is the module that generates the catalog in .csv format. Irrespective of whether UKIDSS data is available or not, this module (the command gc.generate_irgsc()) generates the catalog using the optical PANSTARRS data from 3pi steradian survey for given ra (float) and decl.(float). The name of the generated catalog has IRGSC prefix followed by RA, Dec., and the data of generation. eg. IRGSC_RA_0_0_DEC_0_0.csv for (ra,dec) = (0.0, 0.0)class Validatefrom irgssctool import Validate
vd = Validate(ra,dec)
vd.validate()The module Validate(ra,dec) is the module that validates the computed NIR magnitudes after importing the IRGSC library. If initialized without generating the catalog, this module independantly checks whether the UKIDSS observed NIR data can be obtained for the given field.

# Conclusion/Disclaimer

Please add the following acknowledgment if you use our package in your work.

"This work has made use of "tmt-irgsc" developed as part of the Thirty Meter Telescope (TMT) project."

If you have any questions or suggestions for improvements to this repo,
please contact the owners of the repository.