File: nasa_exoplanet_archive.rst

package info (click to toggle)
astroquery 0.4.11%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 26,584 kB
  • sloc: python: 53,596; xml: 36,604; makefile: 140; ansic: 69
file content (259 lines) | stat: -rw-r--r-- 12,439 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
.. _astroquery.ipac.nexsci.nasa_exoplanet_archive:

************************************************************************
NASA Exoplanet Archive (`astroquery.ipac.nexsci.nasa_exoplanet_archive`)
************************************************************************

This module can be used to query the `NASA Exoplanet Archive <https://exoplanetarchive.ipac.caltech.edu>`_ via
`the TAP service <https://exoplanetarchive.ipac.caltech.edu/docs/TAP/usingTAP.html>`_ or
`the API <https://exoplanetarchive.ipac.caltech.edu/docs/program_interfaces.html>`_.
A full discussion of the available tables and query syntax through the two interfaces is available at [1]_ and [2]_.
More information about the development of a more integrated NASA Exoplanet Archive and ongoing transition to
fully TAP supported services can be found at [3]_.

*NOTE*: the ``exoplanet`` and ``exomultpars`` tables are no longer available and have been replaced by the
Planetary Systems table (``ps``). Likewise, the ``compositepars`` table has been replaced by the
Planetary Systems Composite Parameters table (``pscomppars``). Both the ``ps`` and ``pscomppars`` tables are accessible
through the Exoplanet Archive TAP service. Database column names have changed;
`this document <https://exoplanetarchive.ipac.caltech.edu/docs/API_PS_columns.html>`_ contains the current definitions
and a mapping between the new and deprecated names.

Query methods
=============

The `~astroquery.ipac.nexsci.nasa_exoplanet_archive.NasaExoplanetArchiveClass.query_object` method can be used to query for a specific planet or planet host.
For example, the following query searches the ``ps`` table of confirmed exoplanets for information about the planet K2-18 b.

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_object("K2-18 b") # doctest: +IGNORE_OUTPUT
    <QTable masked=True length=11>
    pl_name pl_letter hostname ... sy_kmagerr1 sy_kmagerr2      sky_coord
                               ...                               deg,deg
      str7     str1     str5   ...   float64     float64          object
    ------- --------- -------- ... ----------- ----------- --------------------
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315
    K2-18 b         b    K2-18 ...       0.019      -0.019 172.560141,7.5878315


Similarly, cone searches can be executed using the `~astroquery.ipac.nexsci.nasa_exoplanet_archive.NasaExoplanetArchiveClass.query_region` method:

.. doctest-remote-data::

    >>> import astropy.units as u
    >>> from astropy.coordinates import SkyCoord
    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_region(
    ...     table="pscomppars", coordinates=SkyCoord(ra=172.56 * u.deg, dec=7.59 * u.deg),
    ...     radius=1.0 * u.deg) # doctest: +IGNORE_OUTPUT
    <QTable masked=True length=2>
    pl_name pl_letter hostname ...   htm20         sky_coord
                               ...                  deg,deg
      str7     str1     str5   ...   int32           object
    ------- --------- -------- ... ---------- --------------------
    K2-18 b         b    K2-18 ... -244884223 172.560141,7.5878315
    K2-18 c         c    K2-18 ... -244884223 172.560141,7.5878315


The most general queries can be performed using the `~astroquery.ipac.nexsci.nasa_exoplanet_archive.NasaExoplanetArchiveClass.query_criteria` method.
For example, a full table can be queried as follows:

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_criteria(table="cumulative", select="*") # doctest: +IGNORE_OUTPUT
    <QTable masked=True length=9564>
     kepid   kepoi_name kepler_name  ... koi_fittype koi_score      sky_coord
                                     ...                             deg,deg
     int64      str9       str14     ...     str7     float64         object
    -------- ---------- ------------ ... ----------- --------- -------------------
    10797460  K00752.01 Kepler-227 b ...     LS+MCMC       1.0 291.93423,48.141651
    10797460  K00752.02 Kepler-227 c ...     LS+MCMC     0.969 291.93423,48.141651
    10811496  K00753.01              ...     LS+MCMC       0.0 297.00482,48.134129
    10848459  K00754.01              ...     LS+MCMC       0.0  285.53461,48.28521
    10854555  K00755.01 Kepler-664 b ...     LS+MCMC       1.0   288.75488,48.2262
         ...        ...          ... ...         ...       ...                 ...
    10155286  K07988.01              ...     LS+MCMC     0.092 296.76288,47.145142
    10156110  K07989.01              ...     LS+MCMC       0.0 297.00977,47.121021


A list of accessible tables can be found in the ``TAP_TABLES`` attribute:

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.TAP_TABLES
    ['spectra',
    'TD',
    'pscomppars',
    'superwasptimeseries',
    'kelttimeseries',
    'DI_STARS_EXEP',
    'stellarhosts',
    'transitspec',
    'emissionspec',
    'ps',
    'keplernames',
    'k2names',
    'toi',
    'CUMULATIVE',
    'Q1_Q6_KOI',
    'Q1_Q8_KOI',
    'Q1_Q12_KOI',
    'Q1_Q16_KOI',
    'Q1_Q17_DR24_KOI',
    'Q1_Q17_DR25_KOI',
    'Q1_Q17_DR25_SUP_KOI',
    'Q1_Q12_TCE',
    'Q1_Q16_TCE',
    'Q1_Q17_DR24_TCE',
    'Q1_Q17_DR25_TCE',
    'stellarhosts',
    'ukirttimeseries',
    'ml',
    'object_aliases',
    'k2pandc',
    'K2TARGETS',
    'KEPLERTIMESERIES',
    'KEPLERSTELLAR',
    'Q1_Q12_KS',
    'Q1_Q16_KS',
    'Q1_Q17_DR24_KS',
    'Q1_Q17_DR25_KS',
    'Q1_Q17_DR25_SUP_KS']



Example queries
===============

Specific searches can be executed using the ``where``, ``select``, ``order``, and other parameters as described in the documentation [1]_, [2]_.

In this section, we demonstrate

1. The number of confirmed planets discovered by TESS:

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_criteria(table="pscomppars", select="count(*)",
    ...                                     where="disc_facility like '%TESS%'")  # doctest: +IGNORE_OUTPUT
    <QTable masked=True length=1>
    count(*)
     int32
    --------
         131


2. The list of 10 confirmed planets discovered by TESS and their host star coordinates:

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_criteria(table="pscomppars", select="top 10 pl_name,ra,dec",
    ...                                     where="disc_facility like '%TESS%'") # doctest: +IGNORE_OUTPUT
    <QTable masked=True length=10>
       pl_name         ra         dec            sky_coord
                      deg         deg             deg,deg
        str13       float64     float64            object
    ------------- ----------- ----------- -----------------------
    WD 1856+534 b  284.415675  53.5090244   284.415675,53.5090244
       TOI-1201 b  42.2476999 -14.5372835  42.2476999,-14.5372835
      HD 213885 b 338.9837166  -59.864829  338.9837166,-59.864829
      HD 219666 b 349.5592665 -56.9039857 349.5592665,-56.9039857
              ...         ...         ...                     ...


3. The list of confirmed planets discovered using microlensing that have data available in the archive:

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_criteria(
    ...     table="pscomppars", where="discoverymethod like 'Microlensing'")  # doctest: +IGNORE_OUTPUT
    <QTable masked=True length=108>
           pl_name        pl_letter ...    htm20           sky_coord
                                    ...                     deg,deg
            str24            str1   ...    int32             object
    --------------------- --------- ... ----------- -----------------------
    OGLE-2016-BLG-1227L b         b ...  -768415656  265.597125,-33.7597778
    OGLE-2015-BLG-0966L b         b ...  2084638177   268.75425,-29.0471111
    OGLE-2017-BLG-0173L b         b ...  1462336374  267.970612,-29.2713604
    OGLE-2017-BLG-1140L b         b ...  -925663673  266.883057,-24.5226669
                      ...       ... ...         ...                     ...
    OGLE-2012-BLG-0358L b         b ...  2111594269      265.694875,-24.261
    OGLE-2017-BLG-0482L b         b ...  -287458961  269.048889,-30.5283604
      MOA-2010-BLG-353L b         b ... -1953724135  271.303917,-27.2932333
    OGLE-2014-BLG-1722L c         c ...   361334854   268.75238,-31.4690552


4. The list of confirmed planets where the host star name starts with "Kepler" using a *wildcard search*:

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_criteria(
    ...     table="pscomppars", where="hostname like 'Kepler%'", order="hostname") # doctest: +IGNORE_OUTPUT
    <QTable masked=True length=2370>
       pl_name    pl_letter   hostname  ...    htm20          sky_coord
                                        ...                    deg,deg
        str14        str1      str12    ...    int32            object
    ------------- --------- ----------- ... ----------- ----------------------
      Kepler-10 c         c   Kepler-10 ...   512815427  285.679298,50.2414842
      Kepler-10 b         b   Kepler-10 ...   512815427  285.679298,50.2414842
     Kepler-100 b         b  Kepler-100 ...  -383871624 291.3861294,41.9901394
     Kepler-100 d         d  Kepler-100 ...  -383871624 291.3861294,41.9901394
     Kepler-100 c         c  Kepler-100 ...  -383871624 291.3861294,41.9901394
    Kepler-1000 b         b Kepler-1000 ... -1745355506 286.6854729,47.0981948
              ...       ...         ... ...         ...                    ...
     Kepler-995 b         b  Kepler-995 ...  -369943676  284.6157154,39.130998
     Kepler-996 b         b  Kepler-996 ...  -288530943 291.9127633,41.5335891
     Kepler-997 b         b  Kepler-997 ...   604179197 289.2333767,49.9388952
     Kepler-998 b         b  Kepler-998 ...  1883599570 296.7541629,49.2087085
     Kepler-999 b         b  Kepler-999 ... -1948748132 299.6604865,46.1984679


5. The Kepler Objects of Interest that were vetted more recently than January 24, 2015 using a *date search*:

.. doctest-remote-data::

    >>> from astroquery.ipac.nexsci.nasa_exoplanet_archive import NasaExoplanetArchive
    >>> NasaExoplanetArchive.query_criteria(
    ...     table="koi", where="koi_vet_date>to_date('2015-01-24','yyyy-mm-dd')",
    ...     select="kepoi_name,koi_vet_date", order="koi_vet_date") # doctest: +IGNORE_OUTPUT
    <QTable length=34652>
    kepoi_name koi_vet_date
       str9       str10
    ---------- ------------
     K00866.01   2015-09-24
     K00867.01   2015-09-24
     K00124.01   2015-09-24
           ...          ...
     K06823.01   2018-08-16
     K06824.01   2018-08-16
     K06825.01   2018-08-16


References
==========

.. [1] `NASA Exoplanet Archive TAP Documentation <https://exoplanetarchive.ipac.caltech.edu/docs/TAP/usingTAP.html>`_
.. [2] `NASA Exoplanet Archive API Documentation <https://exoplanetarchive.ipac.caltech.edu/docs/program_interfaces.html>`_
.. [3] `Developing a More Integrated NASA Exoplanet Archive <https://exoplanetarchive.ipac.caltech.edu/docs/transition.html>`_


Reference/API
=============

.. automodapi:: astroquery.ipac.nexsci.nasa_exoplanet_archive
    :no-inheritance-diagram: