Loading [MathJax]/extensions/tex2jax.js
LSST Applications g1653933729+b86e4b8053,g2303c004a3+5d98734b0b,g28da252d5a+b5f26bf57f,g2bbee38e9b+2d3ef731f8,g2bc492864f+2d3ef731f8,g2cdde0e794+ed7a12f8c9,g3156d2b45e+b0ccf75d80,g347aa1857d+2d3ef731f8,g35bb328faa+b86e4b8053,g3a166c0a6a+2d3ef731f8,g3e281a1b8c+ffc3dc1f6e,g414038480c+28b4cb0ab6,g461a3dce89+b86e4b8053,g7f102674c4+ae0b5e0d9c,g7f343241b9+cace6dd00a,g80478fca09+40b0749891,g82479be7b0+9b1afe76dd,g858d7b2824+5d98734b0b,g8cd86fa7b1+d2e7f28fff,g9125e01d80+b86e4b8053,g979bb04a14+4f8b8b03ff,g9ddcbc5298+b4cb6f9276,ga44b09e51c+0c9720502a,ga5288a1d22+41b6a69a9e,gae0086650b+b86e4b8053,gb781091699+985cf60945,gbbab02d8cb+d561f2537f,gc28159a63d+2d3ef731f8,gcaf7e4fdec+5d98734b0b,gcd45df26be+5d98734b0b,gcf0d15dbbd+13a49b3b58,gda6a2b7d83+13a49b3b58,gdaeeff99f8+b9455e0a82,gdd21207f33+b0eed3e87c,ge79ae78c31+2d3ef731f8,geb408df1e3+2fe46b4317,gf048a9a2f4+f152b11ff2,gf0baf85859+122dc4ce2f,w.2024.31
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
utils.py
Go to the documentation of this file.
2# LSST Data Management System
3# Copyright 2008, 2009, 2010 LSST Corporation.
4#
5# This product includes software developed by the
6# LSST Project (http://www.lsst.org/).
7#
8# This program is free software: you can redistribute it and/or modify
9# it under the terms of the GNU General Public License as published by
10# the Free Software Foundation, either version 3 of the License, or
11# (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the LSST License Statement and
19# the GNU General Public License along with this program. If not,
20# see <http://www.lsstcorp.org/LegalNotices/>.
21#
22
23__all__ = ["coordFromVec", "makeSkyPolygonFromBBox", "Index2D"]
24
25from typing import NamedTuple
26import numpy
27
28import lsst.sphgeom
29import lsst.geom as geom
30
31_TinyFloat = numpy.finfo(float).tiny
32
33
34def coordFromVec(vec, defRA=None):
35 """Convert an ICRS cartesian vector to an ICRS `lsst.geom.SpherePoint`.
36
37 Parameters
38 ----------
39 vec : `list` of `float`
40 An ICRS catesian vector.
41 defRA : `lsst.geom.Angle` or None
42 The RA to use if the vector is too near a pole;
43 ignored if not near a pole.
44
45 Raises
46 ------
47 RuntimeError
48 Raised if vec too near a pole and defRA is None.
49 """
50 if abs(vec[0]) < _TinyFloat and abs(vec[1]) < _TinyFloat:
51 if defRA is None:
52 raise RuntimeError("At pole and defRA==None")
53 if vec[2] > 0:
54 decDeg = 90.0
55 else:
56 decDeg = -90.0
57 return geom.SpherePoint(defRA, decDeg*geom.degrees)
59
60
62 """Make an on-sky polygon from a bbox and a SkyWcs.
63
64 Parameters
65 ----------
66 bbox : `lsst.geom.Box2I` or `lsst.geom.Box2D`
67 Bounding box of region, in pixel coordinates.
68 wcs : `lsst.afw.geom.SkyWcs`
69 Celestial WCS.
70
71 Returns
72 -------
73 polygon : `lsst.sphgeom.ConvexPolygon`
74 On-sky region
75 """
76 pixelPoints = geom.Box2D(bbox).getCorners()
77 skyPoints = wcs.pixelToSky(pixelPoints)
78 return lsst.sphgeom.ConvexPolygon([sp.getVector() for sp in skyPoints])
79
80
81class Index2D(NamedTuple):
82 """Two dimensional index for patches and cells.
83
84 This class contains the x and y values of the location of a patch
85 within a tract, or a cell within a patch.
86
87 Parameters
88 ----------
89 x : `int`
90 y : `int`
91 """
92 x: int
93 y: int
A floating-point coordinate rectangle geometry.
Definition Box.h:413
Point in an unspecified spherical coordinate system.
Definition SpherePoint.h:57
ConvexPolygon is a closed convex polygon on the unit sphere.
Vector3d is a vector in ℝ³ with components stored in double precision.
Definition Vector3d.h:51
coordFromVec(vec, defRA=None)
Definition utils.py:34
makeSkyPolygonFromBBox(bbox, wcs)
Definition utils.py:61