LSSTApplications  18.0.0+53,19.0.0,19.0.0+1,19.0.0+15,19.0.0+16,19.0.0+18,19.0.0+23,19.0.0+3,19.0.0-1-g20d9b18+9,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+9,19.0.0-1-g6fe20d0+2,19.0.0-1-g8c57eb9+9,19.0.0-1-gbfe0924,19.0.0-1-gdc0e4a7+14,19.0.0-1-ge272bc4+9,19.0.0-1-ge3aa853+1,19.0.0-14-gbb28fe44,19.0.0-16-g8258e2a,19.0.0-2-g0d9f9cd+16,19.0.0-2-g260436e,19.0.0-2-g9b11441+3,19.0.0-2-gd955cfd+22,19.0.0-3-g6513920,19.0.0-3-gc4f6e04,19.0.0-4-g41ffa1d+2,19.0.0-4-g725f80e+18,19.0.0-4-g75300c1e,19.0.0-4-ga8eba22,19.0.0-5-g0745e3f,19.0.0-6-g6637c4fb6,19.0.0-6-gb6b8b0a,19.0.0-7-gea0a0fe+5,w.2020.03
LSSTDataManagementBasePackage
Functions
lsst.afw.display.ds9Regions Namespace Reference

Functions

def dot (symb, c, r, size, ctype=None, fontFamily="helvetica", textAngle=None)
 
def drawLines (points, ctype=None)
 

Function Documentation

◆ dot()

def lsst.afw.display.ds9Regions.dot (   symb,
  c,
  r,
  size,
  ctype = None,
  fontFamily = "helvetica",
  textAngle = None 
)
Draw a symbol onto the specified DS9 frame.

Parameters
----------
symb
    Possible values are:

        ``"+"``
            Draw a +
        ``"x"``
            Draw an x
        ``"*"``
            Draw a *
        ``"o"``
            Draw a circle
        ``"@:Mxx,Mxy,Myy"``
            Draw an ellipse with moments (Mxx, Mxy, Myy) (argument size is ignored)
        `lsst.afw.geom.ellipses.BaseCore`
            Draw the ellipse (argument size is ignored). N.b. objects
            derived from `~lsst.afw.geom.ellipses.BaseCore` include
            `~lsst.afw.geom.ellipses.Axes` and `~lsst.afw.geom.ellipses.Quadrupole`.
        Any other value
            Interpreted as a string to be drawn. Strings obey the ``fontFamily``
            (which may be extended with other characteristics, e.g. "times
            bold italic".  Text will be drawn rotated by ``textAngle``
            (textAngle is ignored otherwise).
c, r
    Zero-based coordinates at which to draw the symbol
size
ctype : `str`
    the name of the desired color (e.g. 'red', 'orchid')
fontFamily
textAngle

Definition at line 28 of file ds9Regions.py.

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 
def dot(symb, c, r, size, ctype=None, fontFamily="helvetica", textAngle=None)
Definition: ds9Regions.py:28

◆ drawLines()

def lsst.afw.display.ds9Regions.drawLines (   points,
  ctype = None 
)
Draw a line by connecting the points

Parameters
----------
points : `list` of `tuple` of `float`
    a list of (col,row)
ctype : `str`
    the name of the desired color (e.g. 'red', 'orchid')

Definition at line 123 of file ds9Regions.py.

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
151 
def drawLines(points, ctype=None)
Definition: ds9Regions.py:123