Skip to content

Commit

Permalink
Fix esasky docs: rearrange output order
Browse files Browse the repository at this point in the history
  • Loading branch information
@emellega
emellega committed Oct 9, 2024
1 parent fa816c7 commit 9f63fe9
Showing 1 changed file with 49 additions and 44 deletions.
93 changes: 49 additions & 44 deletions docs/esasky/esasky.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,13 @@ If you know the names of all the available catalogs you can use :meth:`~astroque
>>> from astroquery.esasky import ESASky
>>> catalog_list = ESASky.list_catalogs()
>>> print(catalog_list)
['LAMOST_LRS', 'LAMOST_MRS', 'AllWise', 'Spitzer', 'AKARI-IRC-SC', 'TwoMASS', 'INTEGRAL', 'CHANDRA-SC2',
'XMM-EPIC-STACK', 'XMM-EPIC', 'XMM-OM', 'XMM-SLEW', 'Tycho-2', 'Gaia-DR3', 'Hipparcos-2', 'HSC',
'Herschel-HPPSC-070', 'Herschel-HPPSC-100', 'Herschel-HPPSC-160', 'Herschel-SPSC-250', 'Herschel-SPSC-350',
'Herschel-SPSC-500', 'Planck-PGCC', 'Planck-PCCS2E-HFI', 'Planck-PCCS2-HFI', 'Planck-PCCS2-LFI', 'Planck-PSZ2',
'Icecube', 'Fermi_4FGL-DR2', 'Fermi_3FHL', 'Fermi_4LAC-DR2', '2WHSP', '2RXS', 'OU_Blazars',
'eROSITA-eFEDS-hard', 'eROSITA-eFEDS-main', 'eROSITA-etaCha-hard', 'eROSITA-etaCha-main']
['TYCHO-2', '2RXS', 'INTEGRAL', 'GAIA-DR3', 'XMM-EPIC', 'OU_BLAZARS', 'XMM-SLEW', 'HIPPARCOS-2',
'HERSCHEL-SPSC-500', 'AKARI-IRC-SC', 'HERSCHEL-HPPSC-070', 'HERSCHEL-HPPSC-100', 'HERSCHEL-HPPSC-160',
'HERSCHEL-SPSC-250', 'HERSCHEL-SPSC-350', 'PLANCK-PCCS2E-HFI', 'PLANCK-PGCC', 'PLANCK-PCCS2-HFI',
'PLANCK-PCCS2-LFI', 'PLANCK-PSZ2', 'CHANDRA-SC2', 'ALLWISE', 'TWOMASS', 'EROSITA-EFEDS-MAIN',
'EROSITA-EFEDS-HARD', 'XMM-OM', 'XMM-EPIC-STACK', 'FERMI_4FGL-DR2', 'FERMI_3FHL', 'EROSITA-ETACHA-MAIN',
'SWIFT-2SXPS', 'ICECUBE', 'FERMI_4LAC-DR2', 'EROSITA-ETACHA-HARD', 'HSC', 'PLATO ASPIC1.1', '2WHSP',
'GAIA-FPR', 'EROSITA-ERASS-MAIN', 'EROSITA-ERASS-HARD', 'GLADE+', 'LAMOST_MRS', 'LAMOST_LRS']

Get the available maps mission names
------------------------------------
Expand All @@ -48,8 +49,8 @@ If you know the names of all the available maps missions you can use :meth:`~ast

>>> maps_list = ESASky.list_maps()
>>> print(maps_list)
['INTEGRAL', 'XMM', 'Chandra', 'SUZAKU', 'XMM-OM-OPTICAL', 'XMM-OM-UV', 'HST-UV', 'HST-OPTICAL', 'HST-IR',
'ISO-IR', 'Herschel', 'AKARI', 'JWST-MID-IR', 'JWST-NEAR-IR', 'Spitzer', 'ALMA', 'eROSITA']
['ALMA', 'ISO-IR', 'SPITZER', 'AKARI', 'HST-IR', 'HST-UV', 'HST-OPTICAL', 'EROSITA', 'INTEGRAL',
'SUZAKU', 'HERSCHEL', 'JWST-MID-IR', 'JWST-NEAR-IR', 'XMM', 'XMM-OM-UV', 'XMM-OM-OPTICAL', 'CHANDRA']

Get the available spectra mission names
---------------------------------------
Expand All @@ -60,8 +61,8 @@ If you know the names of all the available spectra you can use :meth:`~astroquer

>>> spectra_list = ESASky.list_spectra()
>>> print(spectra_list)
['XMM-NEWTON', 'Chandra', 'IUE', 'HST-UV', 'HST-OPTICAL', 'JWST-MID-IR', 'JWST-NEAR-IR', 'HST-IR', 'ISO-IR',
'Herschel', 'LAMOST_LRS', 'LAMOST_MRS', 'CHEOPS']
['HERSCHEL', 'CHANDRA', 'IUE', 'ISO-IR', 'CHEOPS', 'XMM-NEWTON', 'JWST-MID-IR', 'JWST-NEAR-IR',
'HST-OPTICAL', 'HST-UV', 'HST-IR', 'LAMOST_MRS', 'LAMOST_LRS']

Get the available SSO mission names
-----------------------------------
Expand All @@ -73,7 +74,7 @@ If you know the names of all the available missions with SSO cross match data, y

>>> sso_list = ESASky.list_sso()
>>> print(sso_list)
['Herschel', 'HST', 'XMM', 'XMM-OM']
['XMM-OM', 'HST', 'HERSCHEL', 'XMM']


Query an object
Expand Down Expand Up @@ -115,16 +116,18 @@ To see the result:
.. doctest-remote-data::

>>> print(result)
TableList with 9 tables:
'0:ALLWISE' with 25 column(s) and 1 row(s)
'1:TWOMASS' with 14 column(s) and 3 row(s)
'2:CHANDRA-SC2' with 41 column(s) and 9 row(s)
'3:XMM-EPIC-STACK' with 347 column(s) and 1 row(s)
'4:XMM-EPIC' with 223 column(s) and 12 row(s)
'5:XMM-OM' with 122 column(s) and 5 row(s)
'6:HSC' with 27 column(s) and 230 row(s)
'7:HERSCHEL-HPPSC-070' with 21 column(s) and 1 row(s)
'8:HERSCHEL-HPPSC-100' with 21 column(s) and 1 row(s)
TableList with 11 tables:
'0:XMM-EPIC' with 223 column(s) and 15 row(s)
'1:HERSCHEL-HPPSC-070' with 21 column(s) and 1 row(s)
'2:HERSCHEL-HPPSC-100' with 21 column(s) and 1 row(s)
'3:CHANDRA-SC2' with 41 column(s) and 9 row(s)
'4:ALLWISE' with 25 column(s) and 1 row(s)
'5:TWOMASS' with 14 column(s) and 3 row(s)
'6:XMM-OM' with 122 column(s) and 7 row(s)
'7:XMM-EPIC-STACK' with 161 column(s) and 15 row(s)
'8:SWIFT-2SXPS' with 232 column(s) and 1 row(s)
'9:HSC' with 27 column(s) and 230 row(s)
'10:GLADE+' with 40 column(s) and 1 row(s)

All the results are returned as a `~astroquery.utils.TableList` object. This is a container for `~astropy.table.Table`
objects. It is basically an extension to `~collections.OrderedDict` for storing a `~astropy.table.Table` against its
Expand Down Expand Up @@ -195,27 +198,29 @@ To see the result:
.. doctest-remote-data::

>>> print(result)
TableList with 20 tables:
'0:LAMOST_LRS' with 43 column(s) and 37 row(s)
'1:ALLWISE' with 25 column(s) and 1762 row(s)
'2:SPITZER' with 146 column(s) and 1082 row(s)
'3:AKARI-IRC-SC' with 29 column(s) and 1 row(s)
'4:TWOMASS' with 14 column(s) and 188 row(s)
'5:CHANDRA-SC2' with 41 column(s) and 430 row(s)
'6:XMM-EPIC-STACK' with 347 column(s) and 225 row(s)
'7:XMM-EPIC' with 223 column(s) and 941 row(s)
'8:XMM-OM' with 122 column(s) and 4849 row(s)
'9:XMM-SLEW' with 106 column(s) and 2 row(s)
'10:GAIA-DR3' with 153 column(s) and 932 row(s)
'11:HSC' with 27 column(s) and 10000 row(s)
'12:HERSCHEL-HPPSC-070' with 21 column(s) and 93 row(s)
'13:HERSCHEL-HPPSC-100' with 21 column(s) and 122 row(s)
'14:HERSCHEL-HPPSC-160' with 21 column(s) and 93 row(s)
'15:HERSCHEL-SPSC-250' with 36 column(s) and 59 row(s)
'16:HERSCHEL-SPSC-350' with 36 column(s) and 24 row(s)
'17:HERSCHEL-SPSC-500' with 36 column(s) and 7 row(s)
'18:PLANCK-PCCS2-HFI' with 9 column(s) and 8 row(s)
'19:2RXS' with 306 column(s) and 2 row(s)
TableList with 22 tables:
'0:2RXS' with 306 column(s) and 2 row(s)
'1:GAIA-DR3' with 153 column(s) and 932 row(s)
'2:XMM-EPIC' with 223 column(s) and 1467 row(s)
'3:XMM-SLEW' with 106 column(s) and 2 row(s)
'4:HERSCHEL-SPSC-500' with 36 column(s) and 7 row(s)
'5:AKARI-IRC-SC' with 29 column(s) and 1 row(s)
'6:HERSCHEL-HPPSC-070' with 21 column(s) and 93 row(s)
'7:HERSCHEL-HPPSC-100' with 21 column(s) and 122 row(s)
'8:HERSCHEL-HPPSC-160' with 21 column(s) and 93 row(s)
'9:HERSCHEL-SPSC-250' with 36 column(s) and 59 row(s)
'10:HERSCHEL-SPSC-350' with 36 column(s) and 24 row(s)
'11:PLANCK-PCCS2-HFI' with 9 column(s) and 8 row(s)
'12:CHANDRA-SC2' with 41 column(s) and 430 row(s)
'13:ALLWISE' with 25 column(s) and 1762 row(s)
'14:TWOMASS' with 14 column(s) and 188 row(s)
'15:XMM-OM' with 122 column(s) and 7026 row(s)
'16:XMM-EPIC-STACK' with 161 column(s) and 4185 row(s)
'17:SWIFT-2SXPS' with 232 column(s) and 120 row(s)
'18:HSC' with 27 column(s) and 10000 row(s)
'19:PLATO ASPIC1.1' with 70 column(s) and 3 row(s)
'20:GLADE+' with 40 column(s) and 51 row(s)
'21:LAMOST_LRS' with 40 column(s) and 47 row(s)

You can use, :meth:`~astroquery.esasky.ESASkyClass.query_region_maps` and
:meth:`~astroquery.esasky.ESASkyClass.query_region_maps` with the same parameters. To execute the same command as above
Expand Down Expand Up @@ -427,7 +432,7 @@ You can see the available missions with:

>>> from astroquery.esasky import ESASky
>>> ESASky.list_sso()
['Herschel', 'HST', 'XMM', 'XMM-OM']
['XMM-OM', 'HST', 'HERSCHEL', 'XMM']

Other parameters and the return value are structured in the same manner as the other query methods.

Expand All @@ -451,8 +456,8 @@ Or download everything on an SSO by something like this:

>>> from astroquery.esasky import ESASky
>>> images=ESASky.get_images_sso(sso_name="2017 RN65")
INFO: Starting download of HERSCHEL data. (1 files) [astroquery.esasky.core]
INFO: Starting download of HST data. (1 files) [astroquery.esasky.core]
INFO: Starting download of HERSCHEL data. (1 files) [astroquery.esasky.core]
INFO: Starting download of XMM data. (1 files) [astroquery.esasky.core]
...

Expand Down

0 comments on commit 9f63fe9

Please sign in to comment.