LSSTApplications  18.1.0
LSSTDataManagementBasePackage
ds9Regions.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010, 2015 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 import math
24 import re
25 import lsst.afw.geom as afwGeom
26 
27 
28 def dot(symb, c, r, size, ctype=None, fontFamily="helvetica", textAngle=None):
29  """Draw a symbol onto the specified DS9 frame.
30 
31  Parameters
32  ----------
33  symb
34  Possible values are:
35 
36  ``"+"``
37  Draw a +
38  ``"x"``
39  Draw an x
40  ``"*"``
41  Draw a *
42  ``"o"``
43  Draw a circle
44  ``"@:Mxx,Mxy,Myy"``
45  Draw an ellipse with moments (Mxx, Mxy, Myy) (argument size is ignored)
46  `lsst.afw.geom.ellipses.BaseCore`
47  Draw the ellipse (argument size is ignored). N.b. objects
48  derived from `~lsst.afw.geom.ellipses.BaseCore` include
49  `~lsst.afw.geom.ellipses.Axes` and `~lsst.afw.geom.ellipses.Quadrupole`.
50  Any other value
51  Interpreted as a string to be drawn. Strings obey the ``fontFamily``
52  (which may be extended with other characteristics, e.g. "times
53  bold italic". Text will be drawn rotated by ``textAngle``
54  (textAngle is ignored otherwise).
55  c, r
56  Zero-based coordinates at which to draw the symbol
57  size
58  ctype : `str`
59  the name of the desired color (e.g. 'red', 'orchid')
60  fontFamily
61  textAngle
62  """
63  if ctype is None:
64  color = "" # the default
65  else:
66  color = ' # color=%s' % ctype
67 
68  regions = []
69 
70  r += 1
71  c += 1 # ds9 uses 1-based coordinates
72  if isinstance(symb, afwGeom.ellipses.Axes):
73  regions.append('ellipse %g %g %gi %gi %g%s' % (c, r, symb.getA(), symb.getB(),
74  math.degrees(symb.getTheta()), color))
75  elif symb == '+':
76  regions.append('line %g %g %g %g%s' % (c, r+size, c, r-size, color))
77  regions.append('line %g %g %g %g%s' % (c-size, r, c+size, r, color))
78  elif symb == 'x':
79  size = size/math.sqrt(2)
80  regions.append('line %g %g %g %g%s' %
81  (c+size, r+size, c-size, r-size, color))
82  regions.append('line %g %g %g %g%s' %
83  (c-size, r+size, c+size, r-size, color))
84  elif symb == '*':
85  size30 = 0.5*size
86  size60 = 0.5*math.sqrt(3)*size
87  regions.append('line %g %g %g %g%s' % (c+size, r, c-size, r, color))
88  regions.append('line %g %g %g %g%s' %
89  (c-size30, r+size60, c+size30, r-size60, color))
90  regions.append('line %g %g %g %g%s' %
91  (c+size30, r+size60, c-size30, r-size60, color))
92  elif symb == 'o':
93  regions.append('circle %g %g %gi%s' % (c, r, size, color))
94  else:
95  color = re.sub("^ # ", "", color) # skip the leading " # "
96 
97  angle = ""
98  if textAngle is not None:
99  angle += " textangle=%.1f"%(textAngle)
100 
101  font = ""
102  if size != 2 or fontFamily != "helvetica":
103  fontFamily = fontFamily.split()
104  font += ' font="%s %d' % (fontFamily.pop(0),
105  int(10*size/2.0 + 0.5))
106  if not fontFamily:
107  # appears to be needed at least for 7.4b1
108  fontFamily = ["normal"]
109  font += " %s" % " ".join(fontFamily)
110  font += '"'
111  extra = ""
112  if color or angle or font:
113  extra = " # "
114  extra += color
115  extra += angle
116  extra += font
117 
118  regions.append('text %g %g \"%s\"%s' % (c, r, symb, extra))
119 
120  return regions
121 
122 
123 def drawLines(points, ctype=None):
124  """Draw a line by connecting the points
125 
126  Parameters
127  ----------
128  points : `list` of `tuple` of `float`
129  a list of (col,row)
130  ctype : `str`
131  the name of the desired color (e.g. 'red', 'orchid')
132  """
133 
134  if ctype is None: # default
135  color = ""
136  else:
137  color = "# color=%s" % ctype
138 
139  regions = []
140  if len(points) > 0:
141  c0, r0 = points[0]
142  r0 += 1
143  c0 += 1 # ds9 uses 1-based coordinates
144  for (c, r) in points[1:]:
145  r += 1
146  c += 1 # ds9 uses 1-based coordinates
147  regions.append('line %g %g %g %g %s' % (c0, r0, c, r, color))
148  c0, r0 = c, r
149 
150  return regions
def drawLines(points, ctype=None)
Definition: ds9Regions.py:123
def dot(symb, c, r, size, ctype=None, fontFamily="helvetica", textAngle=None)
Definition: ds9Regions.py:28