HipsSurveyPropertiesList

class hips.HipsSurveyPropertiesList(data: typing.List[hips.tiles.survey.HipsSurveyProperties]) → None

Bases: object

HiPS survey properties list.

Parameters:

data : list

Python list of HipsSurveyProperties

Examples

Fetch the list of available HiPS surveys from CDS:

>>> from hips import HipsSurveyPropertiesList
>>> surveys = HipsSurveyPropertiesList.fetch()

Look at the results:

>>> len(surveys.data)
335
>>> survey = surveys.data[0]
>>> survey.title
'2MASS H (1.66 microns)'
>>> survey.hips_order
9

You can make a astropy.table.Table of available HiPS surveys:

>>> table = surveys.table

and then do all the operations that Astropy table supports, e.g.

>>> table[['ID', 'hips_order', 'hips_service_url']][[1, 30, 42]]
>>> table.show_in_browser(jsviewer=True)
>>> table.show_in_notebook()
>>> table.to_pandas()

Attributes Summary

DEFAULT_URL
table	Table with HiPS survey infos (Table).

Methods Summary

fetch(…)	Fetch HiPS list text from remote location (HipsSurveyPropertiesList).
from_name(…)	Return a matching HiPS survey (HipsSurveyProperties).
parse(…)	Parse HiPS list text (HipsSurveyPropertiesList).
read(…)	Read HiPS list from file (HipsSurveyPropertiesList).

Attributes Documentation

DEFAULT_URL = 'http://alasky.unistra.fr/MocServer/query?hips_service_url=*&dataproduct_type=!catalog&dataproduct_type=!cube&get=record'

table

Table with HiPS survey infos (Table).

Methods Documentation

classmethod fetch(url: str = None) → hips.tiles.survey.HipsSurveyPropertiesList

Fetch HiPS list text from remote location (HipsSurveyPropertiesList).

Parameters:

url : str

HiPS list URL

from_name(name: str) → hips.tiles.survey.HipsSurveyProperties

Return a matching HiPS survey (HipsSurveyProperties).

classmethod parse(text: str) → hips.tiles.survey.HipsSurveyPropertiesList

Parse HiPS list text (HipsSurveyPropertiesList).

Parameters:

text : str

HiPS list text

classmethod read(filename: str) → hips.tiles.survey.HipsSurveyPropertiesList

Read HiPS list from file (HipsSurveyPropertiesList).

Parameters:

filename : str

HiPS list filename