HeasarcClass¶
-
class
astroquery.heasarc.
HeasarcClass
[source]¶ Bases:
astroquery.query.BaseQuery
HEASARC query class.
- For a list of available HEASARC mission tables, visit:
- https://heasarc.gsfc.nasa.gov/cgi-bin/W3Browse/w3catindex.pl
Attributes Summary
TIMEOUT
URL
coord_systems
Methods Summary
query
(*args, **kwargs)Queries the service and returns a table object. query_async
(request_payload[, cache, url])Submit a query based on a given request_payload. query_mission_cols
(mission[, cache, …])Returns a list containing the names of columns that can be returned for a given mission table. query_mission_list
([cache, get_query_payload])Returns a list of all available mission tables with descriptions query_object
(*args, **kwargs)Queries the service and returns a table object. query_object_async
(object_name, mission[, …])Query around a specific object within a given mission catalog query_region
(*args, **kwargs)Queries the service and returns a table object. query_region_async
(position, mission, radius)Query around specific set of coordinates within a given mission catalog. Attributes Documentation
-
TIMEOUT
= 30¶
-
URL
= 'http://heasarc.gsfc.nasa.gov/cgi-bin/W3Browse/w3query_noredir.pl'¶
-
coord_systems
= ['fk5', 'fk4', 'equatorial', 'galactic']¶
Methods Documentation
-
query
(*args, **kwargs)¶ Queries the service and returns a table object.
Submit a query based on a given request_payload. This allows detailed control of the query to be submitted.
Returns: table : A Table
object.
-
query_async
(request_payload, cache=True, url='http://heasarc.gsfc.nasa.gov/cgi-bin/W3Browse/w3query_noredir.pl')[source]¶ Submit a query based on a given request_payload. This allows detailed control of the query to be submitted.
-
query_mission_cols
(mission, cache=True, get_query_payload=False, **kwargs)[source]¶ Returns a list containing the names of columns that can be returned for a given mission table. By default all column names are returned.
Parameters: mission : str
Mission table (short name) to search from
fields : str, optional
Return format for columns from the server available options: * Standard : Return default table columns * All (default) : Return all table columns * <custom> : User defined csv list of columns to be returned
All other parameters have no effect
-
query_mission_list
(cache=True, get_query_payload=False)[source]¶ Returns a list of all available mission tables with descriptions
-
query_object
(*args, **kwargs)¶ Queries the service and returns a table object.
Query around a specific object within a given mission catalog
Parameters: object_name : str
Object to query around. To set search radius use the ‘radius’ parameter.
mission : str
Mission table to search from
**kwargs :
see
_args_to_payload
for list of additional parameters that can be used to refine search queryReturns: table : A
Table
object.
-
query_object_async
(object_name, mission, cache=True, get_query_payload=False, **kwargs)[source]¶ Query around a specific object within a given mission catalog
Parameters: object_name : str
Object to query around. To set search radius use the ‘radius’ parameter.
mission : str
Mission table to search from
**kwargs :
see
_args_to_payload
for list of additional parameters that can be used to refine search query
-
query_region
(*args, **kwargs)¶ Queries the service and returns a table object.
Query around specific set of coordinates within a given mission catalog. Method first converts the supplied coordinates into the FK5 reference frame and searches for sources from there. Because of this, returned offset coordinates may look different than the ones supplied.
Parameters: position :
astropy.coordinates
or strThe position around which to search. It may be specified as a string in which case it is resolved using online services or as the appropriate
astropy.coordinates
object. ICRS coordinates may also be entered as a string. (adapted from nrao module)mission : str
Mission table to search from
radius :
Astropy Quantity object, or a string that can be parsed into one. e.g., ‘1 degree’ or 1*u.degree.
**kwargs :
see
_args_to_payload
for list of additional parameters that can be used to refine search queryReturns: table : A
Table
object.
-
query_region_async
(position, mission, radius, cache=True, get_query_payload=False, **kwargs)[source]¶ Query around specific set of coordinates within a given mission catalog. Method first converts the supplied coordinates into the FK5 reference frame and searches for sources from there. Because of this, returned offset coordinates may look different than the ones supplied.
Parameters: position :
astropy.coordinates
or strThe position around which to search. It may be specified as a string in which case it is resolved using online services or as the appropriate
astropy.coordinates
object. ICRS coordinates may also be entered as a string. (adapted from nrao module)mission : str
Mission table to search from
radius :
Astropy Quantity object, or a string that can be parsed into one. e.g., ‘1 degree’ or 1*u.degree.
**kwargs :
see
_args_to_payload
for list of additional parameters that can be used to refine search query