From fe46b3c0efc12f77bb0f5f93a379378dc3792d16 Mon Sep 17 00:00:00 2001 From: Sam Bianco Date: Tue, 25 Mar 2025 13:02:26 -0400 Subject: [PATCH] Documentation updates --- docs/mast/mast_cut.rst | 24 ++++++++++---------- docs/mast/mast_obsquery.rst | 44 +++++++++++++++++++++++-------------- 2 files changed, 40 insertions(+), 28 deletions(-) diff --git a/docs/mast/mast_cut.rst b/docs/mast/mast_cut.rst index 6d7cb76434..0f2e0b267d 100644 --- a/docs/mast/mast_cut.rst +++ b/docs/mast/mast_cut.rst @@ -312,18 +312,18 @@ If a given coordinate appears in more than one Zcut survey, a cutout will be pro Downloading URL https://mast.stsci.edu/zcut/api/v0.1/astrocut?ra=189.49206&dec=62.20615&y=200&x=300&units=px&format=jpg to ./zcut_20201202132453.zip ... [Done] ... >>> print(manifest) - Local Path - ----------------------------------------------------------------------------------------------------- - ./hlsp_3dhst_spitzer_irac_goods-n_irac1_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_spitzer_irac_goods-n-s2_irac3_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_spitzer_irac_goods-n-s1_irac4_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_spitzer_irac_goods-n_irac2_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_mayall_mosaic_goods-n_u_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_subaru_suprimecam_goods-n_rc_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_subaru_suprimecam_goods-n_v_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_subaru_suprimecam_goods-n_ic_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_subaru_suprimecam_goods-n_zp_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg - ./hlsp_3dhst_subaru_suprimecam_goods-n_b_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut.jpg + Local Path + ------------------------------------------------------------------------------------------------------- + ./hlsp_3dhst_spitzer_irac_goods-n_irac1_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_spitzer_irac_goods-n-s2_irac3_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_spitzer_irac_goods-n-s1_irac4_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_spitzer_irac_goods-n_irac2_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_mayall_mosaic_goods-n_u_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_subaru_suprimecam_goods-n_rc_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_subaru_suprimecam_goods-n_v_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_subaru_suprimecam_goods-n_ic_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_subaru_suprimecam_goods-n_zp_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg + ./hlsp_3dhst_subaru_suprimecam_goods-n_b_v4.0_sc_189.492060_62.206150_10.0pix-x-5.0pix_astrocut_0.jpg Survey information diff --git a/docs/mast/mast_obsquery.rst b/docs/mast/mast_obsquery.rst index abf3ee0e76..5bf835d259 100644 --- a/docs/mast/mast_obsquery.rst +++ b/docs/mast/mast_obsquery.rst @@ -82,33 +82,45 @@ However, only one wildcarded value can be processed per criterion. RA and Dec must be given in decimal degrees, and datetimes in MJD. +`~astroquery.mast.ObservationsClass.query_criteria` can be used to perform non-positional criteria queries. + .. doctest-remote-data:: >>> from astroquery.mast import Observations ... - >>> obs_table = Observations.query_criteria(dataproduct_type=["image"], - ... proposal_pi="Osten*", - ... s_dec=[43.5,45.5]) - >>> print(obs_table) # doctest: +IGNORE_OUTPUT - dataproduct_type calib_level obs_collection ... intentType obsid objID - ---------------- ----------- -------------- ... ---------- ---------- ---------- - image 1 HST ... science 2003520267 2023816094 - image 1 HST ... science 2003520266 2023816134 - image 1 HST ... science 2003520268 2025756935 - ... - >>> obs_table = Observations.query_criteria(filters=["*UV","Kepler"], - ... objectname="M10", + >>> obs_table = Observations.query_criteria(dataproduct_type="image", + ... proposal_pi="Osten*") + >>> print(obs_table[:5]) # doctest: +IGNORE_OUTPUT + intentType obs_collection provenance_name ... srcDen obsid objID + ---------- -------------- --------------- ... ------ -------- --------- + science HST CALCOS ... nan 24139596 144540274 + science HST CALCOS ... nan 24139591 144540276 + science HST CALCOS ... nan 24139580 144540277 + science HST CALCOS ... nan 24139597 144540280 + science HST CALCOS ... nan 24139575 144540281 + ... + +You can also perform positional queries with additional criteria by passing in ``objectname``, ``coordinates``, +and/or ``radius`` as keyword arguments. + +.. doctest-remote-data:: + + >>> from astroquery.mast import Observations + ... + >>> obs_table = Observations.query_criteria(objectname="M10", + ... radius="0.1 deg", + ... filters=["*UV","Kepler"], ... obs_collection="GALEX") >>> print(obs_table) # doctest: +IGNORE_OUTPUT intentType obs_collection provenance_name ... objID objID1 distance ---------- -------------- --------------- ... ----- ------ -------- + science GALEX AIS ... 61675 61675 0.0 science GALEX GII ... 7022 7022 0.0 - science GALEX GII ... 7023 7023 0.0 + science GALEX GII ... 78941 78941 0.0 science GALEX AIS ... 61673 61673 0.0 - science GALEX AIS ... 61674 61674 0.0 - science GALEX AIS ... 61675 61675 0.0 + science GALEX GII ... 7023 7023 0.0 science GALEX AIS ... 61676 61676 0.0 - science GALEX GII ... 78941 78941 0.0 + science GALEX AIS ... 61674 61674 0.0 We encourage the use of wildcards particularly when querying for JWST instruments with the instrument_name criteria. This is because of the varying instrument names