Skip to content

Commit 494212e

Browse files
bsipoczbsipocz
committed
Adding back deleted examples
1 parent 5ebc764 commit 494212e

File tree

1 file changed

+60
-43
lines changed

1 file changed

+60
-43
lines changed

‎docs/mast/mast.rst‎

Lines changed: 60 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ Downloading data products from S3:
456456
...
457457
>>> Observations.disable_cloud_dataset()
458458

459-
459+
460460

461461
Mission Searches
462462
================
@@ -471,15 +471,15 @@ observational parameters. The available metadata includes all information that
471471
was previously available in the original HST web search form, and are present in
472472
the current `Mission Search interface <https://mast.stsci.edu/search/ui/#/hst>`__.
473473

474-
**Note:**, this API interface does not yet support data product download, only
474+
**Note:** this API interface does not yet support data product download, only
475475
metadata earch access.
476476

477-
An object of MastMissions class is instantiated with a default mission of 'hst' and
477+
An object of MastMissions class is instantiated with a default mission of 'hst' and
478478
default service set to 'search'.
479479

480480
.. doctest-remote-data::
481481

482-
>>> from astroquery.mast.missions import MastMissions
482+
>>> from astroquery.mast import MastMissions
483483
>>> missions = MastMissions()
484484
>>> missions.mission
485485
'hst'
@@ -493,70 +493,87 @@ The available column names for a mission are returned by the
493493
`~astroquery.mast.MastMissionsClass.get_column_list` function.
494494

495495
.. doctest-remote-data::
496-
497-
>>> from astroquery.mast.missions import MastMissions
496+
497+
>>> from astroquery.mast import MastMissions
498498
>>> missions = MastMissions(mission='hst')
499499
>>> columns = missions.get_column_list()
500500

501501
For positional searches, the columns "ang_sep", "sci_data_set_name", "search_key" and "search_position"
502502
will always be included, in addition to any columns specified using "select_cols". For non-positional
503503
searches, "search_key" and "sci_data_set_name" will always be included, in addition to any columns
504-
specified using "select_cols".
504+
specified using "select_cols".
505+
506+
For a non positional search, ``select_cols`` would always include ``'search_key'`` and ``'sci_data_set_name'``.
505507

506508
.. doctest-remote-data::
507-
508-
>>> from astroquery.mast.missions import MastMissions
509+
510+
>>> from astroquery.mast import MastMissions
509511
>>> from astropy.coordinates import SkyCoord
510-
...
511512
>>> missions = MastMissions(mission='hst')
512513
>>> regionCoords = SkyCoord(210.80227, 54.34895, unit=('deg', 'deg'))
513514
>>> results = missions.query_region(regionCoords, radius=3, sci_pep_id=12556,
514515
... select_cols=["sci_stop_time", "sci_targname", "sci_start_time", "sci_status"],
515516
... sort_by=['sci_targname'])
516-
>>> print(results[:5]) # doctest: +IGNORE_OUTPUT
517-
sci_stop_time sci_start_time sci_data_set_name ... ang_sep sci_status
518-
-------------------------- -------------------------- ----------------- ... -------------------- ----------
519-
2012-05-24T09:20:44.570000 2012-05-24T09:17:38.570000 OBQU010H0 ... 0.017460048037303017 PUBLIC
520-
2012-05-24T07:54:46.553000 2012-05-24T07:51:40.553000 OBQU01050 ... 0.017460048037303017 PUBLIC
521-
2012-05-24T07:46:26.553000 2012-05-24T07:43:20.553000 OBQU01030 ... 0.022143836477276503 PUBLIC
522-
2012-05-24T09:12:24.570000 2012-05-24T09:09:18.570000 OBQU010F0 ... 0.022143836477276503 PUBLIC
523-
2012-05-24T09:29:04.570000 2012-05-24T09:25:58.570000 OBQU010J0 ... 0.04381046755938432 PUBLIC
524-
525-
Metadata queries can be performed using object names with the
526-
`~astroquery.mast.MastMissionsClass.query_object` function.
517+
>>> results[:5] # doctest: +IGNORE_OUTPUT
518+
<Table masked=True length=5>
519+
sci_status sci_targname sci_data_set_name ang_sep sci_pep_id search_pos sci_pi_last_name search_key
520+
str6 str16 str9 str20 int64 str18 str6 str27
521+
---------- ---------------- ----------------- -------------------- ---------- ------------------ ---------------- ---------------------------
522+
PUBLIC NUCLEUS+HODGE602 OBQU010H0 0.017460048037303017 12556 210.80227 54.34895 GORDON 210.80227 54.34895OBQU010H0
523+
PUBLIC NUCLEUS+HODGE602 OBQU01050 0.017460048037303017 12556 210.80227 54.34895 GORDON 210.80227 54.34895OBQU01050
524+
PUBLIC NUCLEUS+HODGE602 OBQU01030 0.022143836477276503 12556 210.80227 54.34895 GORDON 210.80227 54.34895OBQU01030
525+
PUBLIC NUCLEUS+HODGE602 OBQU010F0 0.022143836477276503 12556 210.80227 54.34895 GORDON 210.80227 54.34895OBQU010F0
526+
PUBLIC NUCLEUS+HODGE602 OBQU010J0 0.04381046755938432 12556 210.80227 54.34895 GORDON 210.80227 54.34895OBQU010J0
527+
528+
for paging through the results, offset and limit can be used to specify the starting record and the number
529+
of returned records. the default values for offset and limit is 0 and 5000 respectively.
527530

528531
.. doctest-remote-data::
529532

530-
>>> from astroquery.mast.missions import MastMissions
531-
...
532-
>>> missions = MastMissions(mission='hst')
533-
>>> results = missions.query_object('M101', radius=3, select_cols=["sci_stop_time", "sci_targname",
534-
... "sci_start_time", "sci_status"],
533+
>>> from astroquery.mast import MastMissions
534+
>>> from astropy.coordinates import SkyCoord
535+
>>> missions = MastMissions()
536+
>>> results = missions.query_criteria(sci_start_time=">=2021-01-01 00:00:00",
537+
... select_cols=["sci_stop_time", "sci_targname", "sci_start_time", "sci_status", "sci_pep_id"],
538+
... sort_by=['sci_pep_id'], limit=1000, offset=1000) # doctest: +IGNORE_WARNINGS
539+
... # MaxResultsWarning('Maximum results returned, may not include all sources within radius.')
540+
>>> len(results)
541+
1000
542+
543+
Metadata queries can also be performed using object names with the
544+
~astroquery.mast.MastMissionsClass.query_object function.
545+
546+
.. doctest-remote-data::
547+
548+
>>> results = missions.query_object('M101', radius=3, select_cols=["sci_stop_time", "sci_targname", "sci_start_time", "sci_status"],
535549
... sort_by=['sci_targname'])
536-
>>> print(results[:5]) # doctest: +IGNORE_OUTPUT
537-
ang_sep sci_targname sci_stop_time ... search_pos sci_start_time
538-
------------------ ------------ -------------------------- ... ------------------ --------------------------
539-
2.751140575012458 +164.6+9.9 2019-02-19T05:52:40.020000 ... 210.80227 54.34895 2019-02-19T00:49:58.010000
540-
0.8000626246647815 ANY 2003-08-27T08:27:34.513000 ... 210.80227 54.34895 2003-08-27T07:44:47.417000
541-
1.1261718338567348 ANY 2003-01-17T00:50:22.250000 ... 210.80227 54.34895 2003-01-17T00:42:06.993000
542-
1.1454431087675097 ANY 2017-06-15T18:33:25.983000 ... 210.80227 54.34895 2017-06-15T18:10:12.037000
543-
1.1457795862361977 ANY 2017-06-15T20:08:44.063000 ... 210.80227 54.34895 2017-06-15T19:45:30.023000
544-
545-
Metadata queries can be performed using non-positional search criteria with the
550+
>>> results[:5] # doctest: +IGNORE_OUTPUT
551+
<Table masked=True length=5>
552+
ang_sep search_pos sci_status search_key sci_stop_time sci_targname sci_start_time sci_data_set_name
553+
str20 str18 str6 str27 str26 str16 str26 str9
554+
------------------ ------------------ ---------- --------------------------- -------------------------- ------------ -------------------------- -----------------
555+
2.751140575012458 210.80227 54.34895 PUBLIC 210.80227 54.34895LDJI01010 2019-02-19T05:52:40.020000 +164.6+9.9 2019-02-19T00:49:58.010000 LDJI01010
556+
0.8000626246647815 210.80227 54.34895 PUBLIC 210.80227 54.34895J8OB02011 2003-08-27T08:27:34.513000 ANY 2003-08-27T07:44:47.417000 J8OB02011
557+
1.1261718338567348 210.80227 54.34895 PUBLIC 210.80227 54.34895J8D711J1Q 2003-01-17T00:50:22.250000 ANY 2003-01-17T00:42:06.993000 J8D711J1Q
558+
1.1454431087675097 210.80227 54.34895 PUBLIC 210.80227 54.34895JD6V01012 2017-06-15T18:33:25.983000 ANY 2017-06-15T18:10:12.037000 JD6V01012
559+
1.1457795862361977 210.80227 54.34895 PUBLIC 210.80227 54.34895JD6V01013 2017-06-15T20:08:44.063000 ANY 2017-06-15T19:45:30.023000 JD6V01013
560+
561+
Metadata queries can also be performed using non-positional parameters with the
546562
`~astroquery.mast.MastMissionsClass.query_criteria` function.
547563

548564
.. doctest-remote-data::
549565

550-
>>> from astroquery.mast.missions import MastMissions
551-
...
552-
>>> missions = MastMissions(mission='hst')
553566
>>> results = missions.query_criteria(sci_data_set_name="Z06G0101T", sci_pep_id="1455",
554567
... select_cols=["sci_stop_time", "sci_targname", "sci_start_time", "sci_status"],
555568
... sort_by=['sci_targname'])
556-
>>> print(results) # doctest: +IGNORE_OUTPUT
557-
sci_data_set_name sci_targname sci_stop_time sci_start_time sci_status
558-
----------------- ------------ -------------------------- -------------------------- ----------
559-
Z06G0101T -- 1990-05-13T11:02:34.567000 1990-05-13T10:38:09.193000 PUBLIC
569+
>>> results[:5] # doctest: +IGNORE_OUTPUT
570+
<Table masked=True length=5>
571+
search_key sci_stop_time sci_data_set_name sci_start_time sci_targname sci_status
572+
str9 str26 str9 str26 str19 str6
573+
---------- -------------------------- ----------------- -------------------------- ------------ ----------
574+
Z06G0101T 1990-05-13T11:02:34.567000 Z06G0101T 1990-05-13T10:38:09.193000 -- PUBLIC
575+
576+
560577

561578

562579
Catalog Queries

0 commit comments

Comments
 (0)