Skip to content

Commit 34e4c16

Browse files
syed-gilanibsipocz
authored andcommitted
updated documentation
1 parent 6c8c35a commit 34e4c16

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

docs/mast/mast.rst

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -210,21 +210,29 @@ and 'hst' mission.
210210
>>> missions.service
211211
'search'
212212
213-
The missions object can be used to search meta data using region coordinates. the kwargs can be
214-
used to specify output characteristics like selec_cols and sort_by and conditions that filter on
215-
values like proposal id, pi last name etc. The available column names to filter and
216-
their descriptions can be found here https://vao.stsci.edu/missionmast/tapservice.aspx/tables#folder38
213+
The missions object can be used to search metadata using region coordinates. the keywoed argumentss
214+
can be used to specify output characteristics like selec_cols and sort_by and conditions that filter
215+
on values like proposal id, pi last name etc. The available column names for a mission can be found out
216+
by using the ~astroquery.mast.MastMissionsClass.get_column_list function.
217217

218-
For a cone search, select_cols would always include ang_sep, sci_data_set_name, search_key and
219-
search_position, in addition to the columns specified using select_cols.
218+
.. code-block:: python
219+
220+
>>> from astroquery.mast.missions import MastMissions
221+
>>> missions = MastMissions(mission='hst')
222+
>>> columns = missions.get_column_list()
220223
221-
for a non cone search, select_cols would always include search_key and sci_data_set_name.
224+
For positional searches, the columns "ang_sep", "sci_data_set_name", "search_key" and "search_position"
225+
will always be included, in addition to any columns specified using "select_cols". For non-positional
226+
searches, "search_key" and "sci_data_set_name" will always be included, in addition to any columns
227+
specified using "select_cols".
228+
229+
For a non positional search, select_cols would always include search_key and sci_data_set_name.
222230

223231
.. code-block:: python
224232
225233
>>> from astroquery.mast.missions import MastMissions
226234
>>> from astropy.coordinates import SkyCoord
227-
>>> missions = MastMissions()
235+
>>> missions = MastMissions(mission='hst')
228236
>>> regionCoords = SkyCoord(210.80227, 54.34895, unit=('deg', 'deg'))
229237
>>> results = missions.query_region(regionCoords, 3, sci_pep_id=12556, select_cols=["sci_stop_time", "sci_targname", "sci_start_time", "sci_status"], sort_by=['sci_targname'])
230238
>>> results[:5]
@@ -251,7 +259,8 @@ of returned records. the default values for offset and limit is 0 and 5000 respe
251259
>>> len(results)
252260
>>> 1000
253261
254-
Meta data search can also be performed using object names like M101.
262+
Metadata queries can also be performed using object names with the
263+
~astroquery.mast.MastMissionsClass.query_object function.
255264

256265
.. code-block:: python
257266
@@ -267,7 +276,8 @@ Meta data search can also be performed using object names like M101.
267276
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
268277
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
269278
270-
Meta search can be performed by using key value pairs for search filters.
279+
Metadata queries can also be performed using non-positional parameters with the
280+
~astroquery.mast.MastMissionsClass.query_criteria function.
271281

272282
.. code-block:: python
273283

0 commit comments

Comments
 (0)