Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add query_regions to esa.hsa #2362

Merged
merged 6 commits into from
Apr 19, 2022
Merged

Add query_regions to esa.hsa #2362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7bca604
add query_regions
keflavich Apr 15, 2022
4058829
Update astroquery/esa/hsa/core.py
keflavich Apr 16, 2022
a1eb3b4
add test and documentation to `query_region`
lvalerom Apr 16, 2022
e856afb
Merge pull request #21 from lvalerom/query_regions_hsa
keflavich Apr 17, 2022
401c939
Do run doctests for query_region
bsipocz Apr 19, 2022
115b0aa
Even more doctests to get more test coverage
bsipocz Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions astroquery/esa/hsa/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ def get_columns(self, table_name, *, only_names=True, verbose=False):
else:
return columns

def query_observations(self, coordinate, radius, *, n_obs=10):
def query_observations(self, coordinate, radius, *, n_obs=10, **kwargs):
"""
Get the observation IDs from a given region

Expand All @@ -391,6 +391,31 @@ def query_observations(self, coordinate, radius, *, n_obs=10):
the radius of the region
n_obs : int, optional
the number of observations
kwargs : dict
passed to `query_hsa_tap`

Returns
-------
A table object with the list of observations in the region
"""
return self.query_region(coordinate, radius, n_obs=n_obs, columns="observation_id", **kwargs)

def query_region(self, coordinate, radius, *, n_obs=10, columns='*', **kwargs):
"""
Get the observation metadata from a given region

Parameters
----------
coordinate : string / `astropy.coordinates`
the identifier or coordinates around which to query
radius : int / `~astropy.units.Quantity`
the radius of the region
n_obs : int, optional
the number of observations
columns : str, optional
the columns to retrieve from the data table
kwargs : dict
passed to `query_hsa_tap`

Returns
-------
Expand All @@ -401,11 +426,11 @@ def query_observations(self, coordinate, radius, *, n_obs=10):
r = radius*u.deg
coord = commons.parse_coordinates(coordinate).icrs

query = (f"select top {n_obs} observation_id from hsa.v_active_observation "
query = (f"select top {n_obs} {columns} from hsa.v_active_observation "
f"where contains("
f"point('ICRS', hsa.v_active_observation.ra, hsa.v_active_observation.dec), "
f"circle('ICRS', {coord.ra.degree},{coord.dec.degree},{r.to(u.deg).value}))=1")
return self.query_hsa_tap(query)
return self.query_hsa_tap(query, **kwargs)


HSA = HSAClass()
9 changes: 9 additions & 0 deletions astroquery/esa/hsa/tests/test_hsa.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,12 @@ def test_query_observations(self):
hsa = HSAClass(self.get_dummy_tap_handler())
hsa.query_observations(**parameters)
dummyTapHandler.check_call("query_observations", parameters)

def test_query_region(self):
c = SkyCoord(ra=100.2417*u.degree, dec=9.895*u.degree, frame='icrs')
parameters = {'coordinate': c,
'radius': 0.5}
dummyTapHandler = DummyHSATapHandler("query_region", parameters)
hsa = HSAClass(self.get_dummy_tap_handler())
hsa.query_region(**parameters)
dummyTapHandler.check_call("query_region", parameters)
43 changes: 34 additions & 9 deletions docs/esa/hsa.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ space missions and groundbased facilities. Herschel successfully performed ~3700
~6600 science calibration observations which are publicly available to the worldwide astronomical community
through the Herschel Science Archive.

This package allows the access to the `Herschel Science Archive <http://archives.esac.esa.int/hsa/whsa/>`__.
This package allows the access to the `Herschel Science Archive <http://archives.esac.esa.int/hsa/whsa/>`_.

Examples
========
Expand Down Expand Up @@ -109,7 +109,7 @@ Query Language (`ADQL <https://www.ivoa.net/documents/ADQL/20180112/PR-ADQL-2.1-
PACS-A - G345.39-3.97 -43.47405026924179 ... G345.39-3.97-1 883176
PRISMAS_g34_hifi7b_1897GHz_B_C3 1.2495150652937468 ... G34.3+0.1 921086

This will execute an ADQL query to download the first 10 observations in the Herschel Science Archive.
This will execute an ADQL query to download the first 10 observations in the `Herschel Science Archive`_.
The result of the query will be stored in the file ``results.csv``.


Expand All @@ -126,7 +126,7 @@ The result of the query will be stored in the file ``results.csv``.
INFO: Done. [astroquery.utils.tap.core]
['hpdp.latest_observation_hpdp', 'hpdp.vizier_links', 'hpdp.unique_observation_hpdp', 'hpdp.latest_unique_observation_requests', 'hpdp.files', 'hpdp.latest_requests', 'public.dual', 'public.image_formats', 'tap_schema.tables', 'tap_schema.columns', 'tap_schema.keys', 'tap_schema.schemas', 'tap_schema.key_columns', 'hsa.observation_science', 'hsa.proposal_coauthor', 'hsa.proposal_observation', 'hsa.instrument', 'hsa.observing_mode_per_instrument', 'hsa.spire_spectral_feature_finder_catalogue', 'hsa.hifi_spectral_line_smoothed', 'hsa.publication', 'hsa.quality_flag', 'hsa.v_active_observation', 'hsa.proposal_info', 'hsa.pacs_point_source_070', 'hsa.observing_mode', 'hsa.proposal', 'hsa.proposal_pi_user', 'hsa.spire_point_source_350', 'hsa.spire_point_source_250', 'hsa.v_publication', 'hsa.spire_point_source_500', 'hsa.pacs_point_source_100', 'hsa.v_proposal_observation', 'hsa.hifi_spectral_line_native', 'hsa.pacs_point_source_160', 'hsa.ancillary', 'hsa.metadata_expert_panels', 'pubtool.institutions', 'pubtool.v_first_pub_date', 'pubtool.v_first_pub_date_single', 'pubtool.archival_type', 'pubtool.publication', 'pubtool.publication_details', 'pubtool.authors_institutions', 'pubtool.publication_observation', 'pubtool.authors', 'updp2.latest_observation_updp', 'updp2.vizier_links', 'updp2.latest_unique_observation_requests', 'updp2.files', 'updp2.latest_requests', 'updp2.unique_observation_updp']

This will show the available tables in HSA TAP service in the Herschel Science Archive.
This will show the available tables in HSA TAP service in the `Herschel Science Archive`_.


6. Getting columns details of HSA TAP
Expand All @@ -142,13 +142,38 @@ This will show the available tables in HSA TAP service in the Herschel Science A
INFO: Done. [astroquery.utils.tap.core]
['aor', 'bii', 'dec', 'duration', 'end_time', 'fov', 'global_science_area', 'icon_image', 'icon_location', 'image_2_5_location', 'image_location', 'ingest_queue_oid', 'instrument_oid', 'is_active_version', 'is_public', 'lii', 'naif_id', 'num_publications', 'observation_id', 'observation_oid', 'observer', 'observing_mode_oid', 'obsstate', 'od_number', 'pa', 'polygon_fov', 'position', 'prop_end', 'proposal_id', 'quality_report_location', 'ra', 'science_area', 'science_category', 'spg_id', 'start_time', 'status', 'target_name', 'urn_version']

This will show the column details of the table 'hsa.v_active_observation' in HSA TAP service in the Herschel Science Archive.
This will show the column details of the table ``'hsa.v_active_observation'`` in HSA TAP service in the
`Herschel Science Archive`_.


7. Query Observations
7. Query Region
---------------

.. doctest-remote-data::

>>> from astroquery.esa.hsa import HSA
>>> from astropy.coordinates import SkyCoord
>>> from astropy import units as u
>>>
>>> c = SkyCoord(ra=100.2417*u.degree, dec=9.895*u.degree, frame='icrs')
>>> result = HSA.query_region(c, 0.5)
>>> result.pprint(max_width=100)
aor bii ... target_name urn_version
...
------------------------------------------- ------------------ ... ---------------- -----------
KPOT_wlanger_1-HPoint-0007 - CII_G202.6+2.0 10.062774289985356 ... CII_G202.6+2.0-1 921022
n2264-o 9.45754288889945 ... NGC2264 919399
n2264-n 9.45754288889945 ... NGC2264 919398
n2264-n 9.450299102175919 ... NGC2264 898497
n2264-o 9.450499719127244 ... NGC2264 898535

Retrieve a VOTable with the observations metadata of a given region.


8. Query Observations
---------------------

.. doctest-skip::
.. doctest-remote-data::

>>> from astroquery.esa.hsa import HSA
>>> from astropy.coordinates import SkyCoord
Expand All @@ -166,15 +191,15 @@ This will show the column details of the table 'hsa.v_active_observation' in HSA
1342205056
1342205057

Retrieve a VOTable with the observation IDs of a given region
Retrieve a VOTable with the observation IDs of a given region.


8. Procedure example
9. Procedure example
--------------------

First retrieve the observation IDs based on a position on the sky. To achive this, query the TAP service.

.. doctest-skip::
.. doctest-remote-data::

>>> from astroquery.esa.hsa import HSA
>>>
Expand Down