@@ -20,7 +20,6 @@ Get the available catalog names
20
20
21
21
If you know the names of all the available catalogs you can use :meth: `~astroquery.esasky.ESASkyClass.list_catalogs `:
22
22
23
- .. code-block :: python
24
23
.. doctest-remote-data ::
25
24
26
25
>>> from astroquery.esasky import ESASky
@@ -38,7 +37,6 @@ Get the available maps mission names
38
37
39
38
If you know the names of all the available maps missions you can use :meth: `~astroquery.esasky.ESASkyClass.list_maps `:
40
39
41
- .. code-block :: python
42
40
.. doctest-remote-data ::
43
41
44
42
>>> maps_list = ESASky.list_maps()
@@ -52,7 +50,6 @@ Get the available spectra mission names
52
50
53
51
If you know the names of all the available spectra you can use :meth: `~astroquery.esasky.ESASkyClass.list_spectra `:
54
52
55
- .. code-block :: python
56
53
.. doctest-remote-data ::
57
54
58
55
>>> spectra_list = ESASky.list_spectra()
@@ -66,7 +63,7 @@ Get the available SSO mission names
66
63
If you know the names of all the available missions with SSO cross match data, you can use
67
64
:meth: `~astroquery.esasky.ESASkyClass.list_sso `:
68
65
69
- .. code-block :: python
66
+ .. doctest-remote-data ::
70
67
71
68
>>> sso_list = ESASky.list_sso()
72
69
>>> print (sso_list)
@@ -87,7 +84,6 @@ row_limit parameter. You can set the parameter to -1, which will result in the m
87
84
88
85
For instance to query an object around M51 in the Hubble catalog:
89
86
90
- .. code-block :: python
91
87
.. doctest-remote-data ::
92
88
93
89
>>> from astroquery.esasky import ESASky
@@ -96,22 +92,20 @@ For instance to query an object around M51 in the Hubble catalog:
96
92
Note that the catalog may also be specified as a list.
97
93
So the above query may also be written as:
98
94
99
- .. code-block :: python
95
+ .. doctest-remote-data ::
100
96
101
- >> > result = ESASky.query_object_catalogs(position = " M51" , missions = [" HSC" , " XMM-OM" ]) # doctest: +REMOTE_DATA
97
+ >>> result = ESASky.query_object_catalogs(position = " M51" , missions = [" HSC" , " XMM-OM" ])
102
98
103
99
To search in all available catalogs you can write ``"all" `` instead of a catalog name. The same thing will happen if you
104
100
don't write any catalog name.
105
101
106
- .. code-block :: python
107
102
.. doctest-remote-data ::
108
103
109
104
>>> result = ESASky.query_object_catalogs(position = " M51" , missions = " all" )
110
105
>>> result = ESASky.query_object_catalogs(position = " M51" )
111
106
112
107
To see the result:
113
108
114
- .. code-block :: python
115
109
.. doctest-remote-data ::
116
110
117
111
>>> print (result)
@@ -132,7 +126,6 @@ name.
132
126
133
127
To access an individual table from the `~astroquery.utils.TableList ` object
134
128
135
- .. code-block :: python
136
129
.. doctest-remote-data ::
137
130
138
131
>>> interesting_table = result[' ALLWISE' ]
@@ -145,7 +138,6 @@ To access an individual table from the `~astroquery.utils.TableList` object
145
138
To do some common processing to all the tables in the returned `~astroquery.utils.TableList ` object, you can just use a
146
139
for loop:
147
140
148
- .. code-block :: python
149
141
.. doctest-remote-data ::
150
142
151
143
>>> for table in result:
@@ -157,7 +149,6 @@ As mentioned earlier, :meth:`astroquery.esasky.ESASkyClass.query_object_maps` an
157
149
:meth: `astroquery.esasky.ESASkyClass.query_object_spectra ` works extremely similar. It will return all maps or spectra
158
150
that contain the chosen object or coordinate. To execute the same command as above you write this:
159
151
160
- .. code-block :: python
161
152
.. doctest-remote-data ::
162
153
163
154
>>> result = ESASky.query_object_maps(position = " M51" , missions = " all" )
@@ -177,7 +168,6 @@ sources (currently 100 000).
177
168
To query a region either the coordinates or the object name around which to query should be specified along with the
178
169
value for the radius of the region. For instance to query region around M51 in the HSC catalog:
179
170
180
- .. code-block :: python
181
171
.. doctest-remote-data ::
182
172
183
173
>>> from astroquery.esasky import ESASky
@@ -186,29 +176,27 @@ value for the radius of the region. For instance to query region around M51 in t
186
176
187
177
Note that the catalog may also be specified as a list. So the above query may also be written as:
188
178
189
- .. code-block :: python
179
+ .. doctest-remote-data ::
190
180
191
- >> > result = ESASky.query_region_catalogs(position = " M51" , radius = 10 * u.arcmin, catalogs = [" HSC" , " XMM-OM" ]) # doctest: +REMOTE_DATA
181
+ >>> result = ESASky.query_region_catalogs(position = " M51" , radius = 10 * u.arcmin, catalogs = [" HSC" , " XMM-OM" ])
192
182
193
183
To search in all available catalogs you can write ``"all" `` instead of a catalog name. The same thing will happen if you
194
184
don't write any catalog name.
195
185
196
- .. code-block :: python
197
186
.. doctest-remote-data ::
198
187
199
188
>>> result = ESASky.query_region_catalogs(position = " M51" , radius = 10 * u.arcmin, catalogs = " all" )
200
189
>>> result = ESASky.query_region_catalogs(position = " M51" , radius = 10 * u.arcmin)
201
190
202
191
In the same manner, the radius can be specified with either a string or any `~astropy.units.Quantity `
203
192
204
- .. code-block :: python
205
193
.. doctest-remote-data ::
206
194
207
195
>>> result = ESASky.query_region_catalogs(position = " M51" , radius = " 10 arcmin" )
208
196
209
197
To see the result:
210
198
211
- .. code-block :: python
199
+ .. doctest-remote-data ::
212
200
213
201
>>> print (result)
214
202
TableList with 18 tables:
@@ -235,20 +223,21 @@ You can use, :meth:`~astroquery.esasky.ESASkyClass.query_region_maps` and
235
223
:meth: `~astroquery.esasky.ESASkyClass.query_region_maps ` with the same parameters. To execute the same command as above
236
224
you write this:
237
225
238
- .. code-block :: python
226
+ .. doctest-remote-data ::
239
227
240
228
>>> result = ESASky.query_region_maps(position = " M51" , radius = 10 * u.arcmin, missions = " all" )
241
229
>>> result = ESASky.query_region_spectra(position = " M51" , radius = 10 * u.arcmin, missions = " all" )
242
230
243
231
The parameters are interchangeable in the same way as in :meth: `~astroquery.esasky.ESASkyClass.query_region_catalogs `.
244
232
233
+
245
234
Get the metadata of specific observations or sources
246
235
----------------------------------------------------
236
+
247
237
If you already know the observation ID's or source names of interest, you can get their related metadata directly with
248
238
:meth: `~astroquery.esasky.ESASkyClass.query_ids_maps `, or :meth: `~astroquery.esasky.ESASkyClass.query_ids_catalogs `, or
249
239
:meth: `~astroquery.esasky.ESASkyClass.query_ids_spectra `
250
240
251
- .. code-block :: python
252
241
.. doctest-remote-data ::
253
242
254
243
>>> maps = ESASky.query_ids_maps(observation_ids = [" lbsk03vbq" , " ieag90010" ], missions = " HST-UV" )
@@ -272,7 +261,6 @@ The method returns a `dict` to separate the different missions. All mission exce
272
261
`~astropy.io.fits.HDUList `. For Herschel each item in the list is a dictionary where the used filter is the key and the
273
262
HDUList is the value.
274
263
275
- .. code-block :: python
276
264
.. doctest-remote-data ::
277
265
278
266
>>> from astroquery.esasky import ESASky
@@ -291,17 +279,15 @@ HDUList is the value.
291
279
As mentioned above, you can also download a images from a list of observation ID's. To do that you just have to use the
292
280
parameter observation_id instead of target and position.
293
281
294
- .. code-block :: python
295
282
.. doctest-remote-data ::
296
- .. doctest-skip ::
297
283
298
284
>>> from astroquery.esasky import ESASky
299
285
>>> images = ESASky.get_images(position = " m51" , radius = " 20 arcmin" , missions = [' Herschel' , ' ISO-IR' ])
300
286
301
287
Note that the fits files also are stored to disk. By default they are saved to the working directory but the location
302
288
can be chosen by the download_dir parameter:
303
289
304
- .. code-block :: python
290
+ .. doctest-remote-data ::
305
291
306
292
>>> images = ESASky.get_images(observation_ids = " 100001010" , missions = " SUZAKU" )
307
293
>>> images = ESASky.get_images(observation_ids = [" 100001010" , " 01500403" ], missions = [" SUZAKU" , " ISO-IR" ])
@@ -313,33 +299,30 @@ You can also fetch images using :meth:`astroquery.esasky.ESASkyClass.get_maps`.
313
299
:meth: `astroquery.esasky.ESASkyClass.get_images ` except that it takes a `~astroquery.utils.TableList ` instead of
314
300
position, radius and missions.
315
301
316
- .. code-block :: python
302
+
317
303
.. doctest-remote-data ::
318
- .. doctest-skip ::
319
304
320
305
>>> table_list = ESASky.query_region_maps(position = " m51" , radius = " 20 arcmin" , missions = [' Herschel' , ' ISO-IR' ])
321
306
>>> images = ESASky.get_maps(query_table_list = table_list, download_dir = " /home/user/esasky" )
322
307
323
308
This example is equivalent to:
324
309
325
- .. code-block :: python
326
310
.. doctest-remote-data ::
327
- .. doctest-skip ::
328
311
329
312
>>> images = ESASky.get_images(position = " m51" , radius = " 20 arcmin" , missions = [' Herschel' , ' ISO-IR' ],
330
313
... download_dir= " /home/user/esasky" )
331
314
332
315
333
316
Get spectra
334
317
-----------
318
+
335
319
There are also two methods to download spectra: :meth: `astroquery.esasky.ESASkyClass.get_spectra ` and
336
320
:meth: `astroquery.esasky.ESASkyClass.get_spectra_from_table `. These two methods use the same parameters as
337
321
:meth: `astroquery.esasky.ESASkyClass.get_maps ` and :meth: `astroquery.esasky.ESASkyClass.get_images ` respectively.
338
322
339
323
The methods returns a `dict ` to separate the different missions. All mission except Herschel returns a list of
340
324
`~astropy.io.fits.HDUList `. Herschel returns a three-level dictionary.
341
325
342
- .. code-block :: python
343
326
.. doctest-remote-data ::
344
327
345
328
>>> from astroquery.esasky import ESASky
@@ -348,18 +331,11 @@ The methods returns a `dict` to separate the different missions. All mission exc
348
331
349
332
or
350
333
351
- .. code-block :: python
352
334
.. doctest-remote-data ::
353
- .. doctest-skip ::
354
335
355
336
>>> table_list = ESASky.query_region_spectra(position = " m51" , radius = " 20 arcmin" ,
356
337
... missions= [' Herschel' , ' XMM-NEWTON' ])
357
338
>>> spectra = ESASky.get_spectra_from_table(query_table_list = table_list, download_dir = " /home/user/esasky" )
358
-
359
- The return value is structured in a dictionary like this:
360
-
361
- .. code-block :: python
362
-
363
339
dict: {
364
340
'HERSCHEL': {'1342211195': {'red' : {'HPSTBRRS' : HDUList}, 'blue' : {'HPSTBRBS': HDUList},
365
341
'1342180796': {'WBS' : {'WBS-H_LSB_5a' : HDUList}, 'HRS' : {'HRS-H_LSB_5a': HDUList},
@@ -371,7 +347,6 @@ The return value is structured in a dictionary like this:
371
347
372
348
Here is another example for Herschel, since it is a bit special:
373
349
374
- .. code- block:: python
375
350
.. doctest-remote-data ::
376
351
377
352
>>> from astroquery.esasky import ESASky
@@ -384,22 +359,23 @@ Here is another example for Herschel, since it is a bit special:
384
359
385
360
Solar System Object Crossmatch
386
361
------------------------------
362
+
387
363
ESASky has a solar system object crossmatch feature which performs a crossmatch on the SSO orbits against the entire
388
364
mission archives to find observations in which the SSO fell within the imaging instrument's field of view during the
389
365
time the images were being taken. `Read more about the ESASky SSO feature
390
366
<https://www.cosmos.esa.int/web/esdc/esasky-interface#SSO> `__ You can access the results of this crossmatch by using
391
367
:meth: `astroquery.esasky.ESASkyClass.query_sso ` which works like the other query methods, but it takes an SSO name as
392
368
input instead of a position.
393
369
394
- .. code - block:: python
370
+ .. doctest-remote-data ::
395
371
396
372
>>> from astroquery.esasky import ESASky
397
373
>>> result = ESASky.query_sso(sso_name = " Pallas" , missions = [" XMM" , " HST" ])
398
374
399
375
In some cases an SSO name is ambiguous, in which case you may need to use a more precise SSO name or specify the SSO
400
376
type of the desired object. For example:
401
377
402
- .. code - block:: python
378
+ .. doctest-remote-data ::
403
379
404
380
>>> from astroquery.esasky import ESASky
405
381
>>> ESASky.query_sso(sso_name = " 503" )
@@ -416,15 +392,15 @@ type of the desired object. For example:
416
392
417
393
In this case, you can specify the sso_type
418
394
419
- .. code - block:: python
395
+ .. doctest-remote-data ::
420
396
421
397
>>> from astroquery.esasky import ESASky
422
398
>>> ESASky.query_sso(sso_name = " 503" , sso_type = " SATELLITE" )
423
399
424
400
425
401
You can see the available missions with:
426
402
427
- .. code - block:: python
403
+ .. doctest-remote-data ::
428
404
429
405
>>> from astroquery.esasky import ESASky
430
406
>>> ESASky.list_sso()
@@ -437,7 +413,7 @@ This function works very similar to :meth:`astroquery.esasky.ESASkyClass.get_ima
437
413
:meth: `astroquery.esasky.ESASkyClass.get_maps `, as it structures the return values in the same way, and most parameters
438
414
are the same. You can for example, download a table list just like in get_maps by doing something like this:
439
415
440
- .. code - block:: python
416
+ .. doctest-remote-data ::
441
417
442
418
>>> from astroquery.esasky import ESASky
443
419
>>> table_list_from_query_maps= ESASky.query_sso(sso_name = " ganymede" , missions = " XMM" )
@@ -446,7 +422,7 @@ are the same. You can for example, download a table list just like in get_maps b
446
422
447
423
Or download everything on an SSO by something like this:
448
424
449
- .. code - block:: python
425
+ .. doctest-remote-data ::
450
426
451
427
>>> from astroquery.esasky import ESASky
452
428
>>> images= ESASky.get_images_sso(sso_name = " ganymede" )
@@ -456,7 +432,7 @@ This module also offers access to IMCCE's SsODNet resolver, which allows you to
456
432
objects with a given name. Here you can see all matches and there aliases and types. You can use this method to help you
457
433
specify which SSO you are after. Use :meth: `astroquery.esasky.ESASkyClass.find_sso ` like this:
458
434
459
- .. code - block:: python
435
+ .. doctest-remote-data ::
460
436
461
437
>>> from astroquery.esasky import ESASky
462
438
>>> list_of_matches= ESASky.find_sso(sso_name = " Io" )
0 commit comments