HipsSurveyProperties¶

class hips.HipsSurveyProperties(data: dict)[source]¶

Bases: object

HiPS properties container.

Parameters:

data : dict

HiPS survey properties

Examples

>>> from hips import HipsSurveyProperties
>>> url = 'http://alasky.unistra.fr/DSS/DSS2Merged/properties'
>>> hips_survey_property = HipsSurveyProperties.fetch(url)
>>> hips_survey_property.base_url
'http://alasky.u-strasbg.fr/DSS/DSS2Merged'

Attributes Summary

`astropy_frame`	Astropy coordinate frame (str).
`base_url`	HiPS access URL
`hips_frame`	HiPS coordinate frame (str).
`hips_order`	HiPS order (int).
`hips_service_url`	HiPS service base URL (str).
`hips_to_astropy_frame_mapping`	HIPS to Astropy SkyCoord frame string mapping.
`hips_version`	HiPS version (str).
`tile_format`	HiPS tile format (str).
`tile_width`	HiPS tile width
`title`	HiPS title (str).

Methods Summary

`fetch`(url)	Read from HiPS survey description file from remote URL (`HipsSurveyProperties`).
`from_name`(name)	Create object from Survey ID (`HipsSurveyProperties`).
`make`(hips_survey, _ForwardRef()])	Convenience constructor for from_string classmethod or existing object (`HipsSurveyProperties`).
`parse`(text, url)	Parse HiPS survey description text (`HipsSurveyProperties`).
`read`(filename)	Read from HiPS survey description file (`HipsSurveyProperties`).
`tile_url`(tile_meta)	Tile URL on the server (str).
`to_string`()	Convert properties to string
`write`(path)	Write properties to text file.

Attributes Documentation

astropy_frame¶: Astropy coordinate frame (str).

base_url¶: HiPS access URL

hips_frame¶: HiPS coordinate frame (str).

hips_order¶: HiPS order (int).

hips_service_url¶: HiPS service base URL (str).

hips_to_astropy_frame_mapping = {'ecliptic': 'ecliptic', 'equatorial': 'icrs', 'galactic': 'galactic'}¶: HIPS to Astropy SkyCoord frame string mapping.

hips_version¶: HiPS version (str).

tile_format¶: HiPS tile format (str).

tile_width¶: HiPS tile width

title¶: HiPS title (str).

Methods Documentation

classmethod fetch(url: str) → hips.tiles.survey.HipsSurveyProperties[source]¶

Read from HiPS survey description file from remote URL (HipsSurveyProperties).

Parameters:

url : str

URL containing HiPS properties

classmethod from_name(name: str) → hips.tiles.survey.HipsSurveyProperties[source]¶: Create object from Survey ID (HipsSurveyProperties).

classmethod make(hips_survey: Union[str, _ForwardRef('HipsSurveyProperties')]) → hips.tiles.survey.HipsSurveyProperties[source]¶: Convenience constructor for from_string classmethod or existing object (HipsSurveyProperties).

classmethod parse(text: str, url: str = None) → hips.tiles.survey.HipsSurveyProperties[source]¶

Parse HiPS survey description text (HipsSurveyProperties).

Parameters:

text : str

Text containing HiPS survey properties

url : str

Properties URL of HiPS

classmethod read(filename: str) → hips.tiles.survey.HipsSurveyProperties[source]¶

Read from HiPS survey description file (HipsSurveyProperties).

Parameters:

filename : str

HiPS properties filename

tile_url(tile_meta: hips.tiles.tile.HipsTileMeta) → str[source]¶: Tile URL on the server (str).

to_string()[source]¶: Convert properties to string

write(path)[source]¶

Write properties to text file.

Parameters:

path : str or Path

Base path where to write the properties file.