lsst.sphgeom._continue_class.Region Class Reference

Public Member Functions
Region	from_ivoa_pos (cls, str pos)
str	to_ivoa_pos (self)

Detailed Description

A minimal interface for 2-dimensional regions on the unit sphere.

Member Function Documentation

from_ivoa_pos()

Region lsst.sphgeom._continue_class.Region.from_ivoa_pos	(		cls,
		str	pos )

Create a Region from an IVOA POS string.

Parameters
----------
pos : `str`
    A string using the IVOA SIAv2 POS syntax.

Returns
-------
region : `Region`
    A region equivalent to the POS string.

Notes
-----
See
https://ivoa.net/documents/SIA/20151223/REC-SIA-2.0-20151223.html#toc12
for a description of the POS parameter but in summary the options are:

* ``CIRCLE <longitude> <latitude> <radius>``
* ``RANGE <longitude1> <longitude2> <latitude1> <latitude2>``
* ``POLYGON <longitude1> <latitude1> ... (at least 3 pairs)``

Units are degrees in all coordinates.

to_ivoa_pos()

str lsst.sphgeom._continue_class.Region.to_ivoa_pos

(

self

)

Represent the region as an IVOA POS string.

Returns
-------
pos : `str`
    The region in ``POS`` format.

---

The documentation for this class was generated from the following file:

• python/lsst/sphgeom/_continue_class.py