UkidssClass¶
-
class
astroquery.ukidss.
UkidssClass
(username=None, password=None, community=None, database='UKIDSSDR7PLUS', programme_id='all')[source]¶ Bases:
astroquery.query.QueryWithLogin
The UKIDSSQuery class. Must instantiate this class in order to make any queries. Allows registered users to login, but defaults to using the public UKIDSS data sets.
Attributes Summary
ARCHIVE_URL
BASE_URL
IMAGE_URL
LOGIN_URL
REGION_URL
TIMEOUT
all_databases
filters
frame_types
ukidss_programmes_long
ukidss_programmes_short
Methods Summary
extract_urls
(html_in)Helper function that uses regexps to extract the image urls from the given HTML. get_image_list
(*args, **kwargs)get_images
(coordinates[, waveband, ...])Get an image around a target/ coordinates from UKIDSS catalog. get_images_async
(coordinates[, waveband, ...])Serves the same purpose as get_images
but returns a list of file handlers to remote files.list_catalogs
([style])Returns a list of available catalogs in UKIDSS. list_databases
()List the databases available from the UKIDSS WFCAM archive. logged_in
()Determine whether currently logged in. query_region
(coordinates[, radius, ...])Used to query a region around a known identifier or given coordinates from the catalog. query_region_async
(coordinates[, radius, ...])Serves the same purpose as query_region
.Attributes Documentation
-
ARCHIVE_URL
= u'http://surveys.roe.ac.uk:8080/wsa/ImageList'¶
-
BASE_URL
= u'http://surveys.roe.ac.uk:8080/wsa/'¶
-
IMAGE_URL
= u'http://surveys.roe.ac.uk:8080/wsa/GetImage'¶
-
LOGIN_URL
= u'http://surveys.roe.ac.uk:8080/wsa/DBLogin'¶
-
REGION_URL
= u'http://surveys.roe.ac.uk:8080/wsa/WSASQL'¶
-
TIMEOUT
= 30¶
-
all_databases
= ('UKIDSSDR9PLUS', 'UKIDSSDR8PLUS', 'UKIDSSDR7PLUS', 'UKIDSSDR6PLUS', 'UKIDSSDR5PLUS', 'UKIDSSDR4PLUS', 'UKIDSSDR3PLUS', 'UKIDSSDR2PLUS', 'UKIDSSDR1PLUS', 'UKIDSSDR1', 'UKIDSSEDRPLUS', 'UKIDSSEDR', 'UKIDSSSV', 'WFCAMCAL08B', 'U09B8v20120403', 'U09B8v20100414')¶
-
filters
= {'H2': 6, 'all': 'all', 'Z': 1, 'Br': 7, 'Y': 2, 'H': 4, 'K': 5, 'J': 3}¶
-
frame_types
= {'interleave': 'leav', 'confidence': 'conf', 'all': 'all', 'normal': 'normal', 'leavstack': 'leavstack', 'difference': 'diff', 'stack': 'stack', 'deep_stack': 'deep%stack'}¶
-
ukidss_programmes_long
= {'Galactic Plane Survey': 102, 'Deep Extragalactic Survey': 104, 'Galactic Clusters Survey': 103, 'Ultra Deep Survey': 105, 'Large Area Survey': 101}¶
-
ukidss_programmes_short
= {'UDS': 105, 'GCS': 103, 'GPS': 102, 'DXS': 104, 'LAS': 101}¶
Methods Documentation
-
extract_urls
(html_in)[source]¶ Helper function that uses regexps to extract the image urls from the given HTML.
Parameters: html_in : str
source from which the urls are to be extracted.
Returns: links : list
The list of URLS extracted from the input.
-
get_images
(coordinates, waveband='all', frame_type='stack', image_width=<Quantity 1.0 arcmin>, image_height=None, radius=None, database='UKIDSSDR7PLUS', programme_id='all', verbose=True, get_query_payload=False, show_progress=True)[source]¶ Get an image around a target/ coordinates from UKIDSS catalog.
Parameters: coordinates : str or
astropy.coordinates
objectThe target 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 strings as specified in theastropy.coordinates
module.waveband : str
The color filter to download. Must be one of
'all'
,'J'
,'H'
,'K'
,'H2'
,'Z'
,'Y'
,'Br'
].frame_type : str
The type of image. Must be one of
'stack'
,'normal'
,'interleave'
,'deep_stack'
,'confidence'
,'difference'
,'leavstack'
,'all'
]image_width : str or
Quantity
object, optionalThe image size (along X). Cannot exceed 15 arcmin. If missing, defaults to 1 arcmin.
image_height : str or
Quantity
object, optionalThe image size (along Y). Cannot exceed 90 arcmin. If missing, same as image_width.
radius : str or
Quantity
object, optionalThe string must be parsable by
Angle
. The appropriateQuantity
object fromastropy.units
may also be used. When missing only image around the given position rather than multi-frames are retrieved.programme_id : str
The survey or programme in which to search for.
database : str
The UKIDSS database to use.
verbose : bool
get_query_payload : bool, optional
Returns: list : A list of
HDUList
objects.
-
get_images_async
(coordinates, waveband='all', frame_type='stack', image_width=<Quantity 1.0 arcmin>, image_height=None, radius=None, database='UKIDSSDR7PLUS', programme_id='all', verbose=True, get_query_payload=False, show_progress=True)[source]¶ Serves the same purpose as
get_images
but returns a list of file handlers to remote files.Parameters: coordinates : str or
astropy.coordinates
objectThe target 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 strings as specified in theastropy.coordinates
module.waveband : str
The color filter to download. Must be one of
'all'
,'J'
,'H'
,'K'
,'H2'
,'Z'
,'Y'
,'Br'
].frame_type : str
The type of image. Must be one of
'stack'
,'normal'
,'interleave'
,'deep_stack'
,'confidence'
,'difference'
,'leavstack'
,'all'
]image_width : str or
Quantity
object, optionalThe image size (along X). Cannot exceed 15 arcmin. If missing, defaults to 1 arcmin.
image_height : str or
Quantity
object, optionalThe image size (along Y). Cannot exceed 90 arcmin. If missing, same as image_width.
radius : str or
Quantity
object, optionalThe string must be parsable by
Angle
. The appropriateQuantity
object fromastropy.units
may also be used. When missing only image around the given position rather than multi-frames are retrieved.programme_id : str
The survey or programme in which to search for. See
list_catalogs
.database : str
The UKIDSS database to use.
verbose : bool
get_query_payload : bool, optional
Returns: list : list
A list of context-managers that yield readable file-like objects.
-
list_catalogs
(style='short')[source]¶ Returns a list of available catalogs in UKIDSS. These can be used as
programme_id
in queries.Parameters: style : str, optional
Must be one of
'short'
,'long'
. Defaults to'short'
. Determines whether to print long names or abbreviations for catalogs.Returns: list : list containing catalog name strings in long or short style.
-
query_region
(coordinates, radius=<Quantity 1.0 arcmin>, programme_id='GPS', database='UKIDSSDR7PLUS', verbose=False, get_query_payload=False, system='J2000')[source]¶ Used to query a region around a known identifier or given coordinates from the catalog.
Parameters: coordinates : str or
astropy.coordinates
objectThe target 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 strings as specified in theastropy.coordinates
module.radius : str or
Quantity
object, optionalThe string must be parsable by
Angle
. The appropriateQuantity
object fromastropy.units
may also be used. When missing defaults to 1 arcmin. Cannot exceed 90 arcmin.programme_id : str
The survey or programme in which to search for. See
list_catalogs
.database : str
The UKIDSS database to use.
verbose : bool, optional.
get_query_payload : bool, optional
system : ‘J2000’ or ‘Galactic’
The system in which to perform the query. Can affect the output data columns.
Returns: result :
Table
Query result table.
-
query_region_async
(coordinates, radius=<Quantity 1.0 arcmin>, programme_id='GPS', database='UKIDSSDR7PLUS', get_query_payload=False, system='J2000')[source]¶ Serves the same purpose as
query_region
. But returns the raw HTTP response rather than the parsed result.Parameters: coordinates : str or
astropy.coordinates
objectThe target 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 strings as specified in theastropy.coordinates
module.radius : str or
Quantity
object, optionalThe string must be parsable by
Angle
. The appropriateQuantity
object fromastropy.units
may also be used. When missing defaults to 1 arcmin. Cannot exceed 90 arcmin.programme_id : str
The survey or programme in which to search for. See
list_catalogs
.database : str
The UKIDSS database to use.
get_query_payload : bool, optional
Returns: response :
requests.Response
The HTTP response returned from the service.
-