LSST Applications g063fba187b+fee0456c91,g0f08755f38+ea96e5a5a3,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+90257ff92a,g20f6ffc8e0+ea96e5a5a3,g217e2c1bcf+937a289c59,g28da252d5a+daa7da44eb,g2bbee38e9b+253935c60e,g2bc492864f+253935c60e,g3156d2b45e+6e55a43351,g32e5bea42b+31359a2a7a,g347aa1857d+253935c60e,g35bb328faa+a8ce1bb630,g3a166c0a6a+253935c60e,g3b1af351f3+a8ce1bb630,g3e281a1b8c+c5dd892a6c,g414038480c+416496e02f,g41af890bb2+afe91b1188,g599934f4f4+0db33f7991,g7af13505b9+e36de7bce6,g80478fca09+da231ba887,g82479be7b0+a4516e59e3,g858d7b2824+ea96e5a5a3,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,ga5288a1d22+bc6ab8dfbd,gb58c049af0+d64f4d3760,gc28159a63d+253935c60e,gcab2d0539d+3f2b72788c,gcf0d15dbbd+4ea9c45075,gda6a2b7d83+4ea9c45075,gdaeeff99f8+1711a396fd,ge79ae78c31+253935c60e,gef2f8181fd+3031e3cf99,gf0baf85859+c1f95f4921,gfa517265be+ea96e5a5a3,gfa999e8aa5+17cd334064,w.2024.50
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
lsst.afw.display.interface.Display Class Reference

Classes

class  _Buffering
 

Public Member Functions

 __init__ (self, frame=None, backend=None, **kwargs)
 
 __enter__ (self)
 
 __exit__ (self, *args)
 
 __del__ (self)
 
 __getattr__ (self, name)
 
 close (self)
 
 verbose (self)
 
 verbose (self, value)
 
 __str__ (self)
 
 setImageColormap (self, cmap)
 
 maskColorGenerator (self, omitBW=True)
 
 setMaskPlaneColor (self, name, color=None)
 
 getMaskPlaneColor (self, name=None)
 
 setMaskTransparency (self, transparency=None, name=None)
 
 getMaskTransparency (self, name=None)
 
 show (self)
 
 image (self, data, title="", wcs=None)
 
 mtv (self, data, title="", wcs=None)
 
 Buffering (self)
 
 flush (self)
 
 erase (self)
 
 centroids (self, catalog, *symbol="o", **kwargs)
 
 dot (self, symb, c, r, size=2, ctype=None, origin=afwImage.PARENT, **kwargs)
 
 line (self, points, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
 
 scale (self, algorithm, min, max=None, unit=None, **kwargs)
 
 zoom (self, zoomfac=None, colc=None, rowc=None, origin=afwImage.PARENT)
 
 pan (self, colc=None, rowc=None, origin=afwImage.PARENT)
 
 interact (self)
 
 setCallback (self, k, func=None, noRaise=False)
 
 getActiveCallbackKeys (self, onlyActive=True)
 

Static Public Member Functions

 setDefaultBackend (backend)
 
 getDefaultBackend ()
 
 setDefaultFrame (frame=0)
 
 getDefaultFrame ()
 
 incrDefaultFrame ()
 
 setDefaultMaskTransparency (maskPlaneTransparency={})
 
 setDefaultMaskPlaneColor (name=None, color=None)
 
 setDefaultImageColormap (cmap)
 
 getDisplay (frame=None, backend=None, create=True, verbose=False, **kwargs)
 
 delAllDisplays ()
 

Public Attributes

 frame
 
 name
 

Protected Attributes

 _impl
 
 _xy0
 
 _maskPlaneColors
 
 _callbacks
 

Static Protected Attributes

dict _displays = {}
 
 _defaultBackend = None
 
int _defaultFrame = 0
 
 _defaultMaskPlaneColor
 
dict _defaultMaskTransparency = {}
 
str _defaultImageColormap = "gray"
 

Detailed Description

Create an object able to display images and overplot glyphs.

Parameters
----------
frame
    An identifier for the display.
backend : `str`
    The backend to use (defaults to value set by setDefaultBackend()).
**kwargs
    Arguments to pass to the backend.

Definition at line 126 of file interface.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.afw.display.interface.Display.__init__ ( self,
frame = None,
backend = None,
** kwargs )

Definition at line 158 of file interface.py.

158 def __init__(self, frame=None, backend=None, **kwargs):
159 if frame is None:
160 frame = getDefaultFrame()
161
162 if backend is None:
163 if Display._defaultBackend is None:
164 try:
165 setDefaultBackend("ds9")
166 except RuntimeError:
167 setDefaultBackend("virtualDevice")
168
169 backend = Display._defaultBackend
170
171 self.frame = frame
172 self._impl = _makeDisplayImpl(self, backend, **kwargs)
173 self.name = backend
174
175 self._xy0 = None # displayed data's XY0
176 self.setMaskTransparency(Display._defaultMaskTransparency)
177 self._maskPlaneColors = {}
178 self.setMaskPlaneColor(Display._defaultMaskPlaneColor)
179 self.setImageColormap(Display._defaultImageColormap)
180
181 self._callbacks = {}
182
183 for ik in range(ord('a'), ord('z') + 1):
184 k = f"{ik:c}"
185 self.setCallback(k, noRaise=True)
186 self.setCallback(k.upper(), noRaise=True)
187
188 for k in ('Return', 'Shift_L', 'Shift_R'):
189 self.setCallback(k)
190
191 for k in ('q', 'Escape'):
192 self.setCallback(k, lambda k, x, y: True)
193
194 def _h_callback(k, x, y):
195 h_callback(k, x, y)
196
197 for k in sorted(self._callbacks.keys()):
198 doc = self._callbacks[k].__doc__
199 print(" %-6s %s" % (k, doc.split("\n")[0] if doc else "???"))
200
201 self.setCallback('h', _h_callback)
202
203 Display._displays[frame] = self
204

◆ __del__()

lsst.afw.display.interface.Display.__del__ ( self)

Definition at line 215 of file interface.py.

215 def __del__(self):
216 self.close()
217

Member Function Documentation

◆ __enter__()

lsst.afw.display.interface.Display.__enter__ ( self)
Support for python's with statement.

Definition at line 205 of file interface.py.

205 def __enter__(self):
206 """Support for python's with statement.
207 """
208 return self
209

◆ __exit__()

lsst.afw.display.interface.Display.__exit__ ( self,
* args )
Support for python's with statement.

Definition at line 210 of file interface.py.

210 def __exit__(self, *args):
211 """Support for python's with statement.
212 """
213 self.close()
214

◆ __getattr__()

lsst.afw.display.interface.Display.__getattr__ ( self,
name )
Return the attribute of ``self._impl``, or ``._impl`` if it is
requested.

Parameters:
-----------
name : `str`
    name of the attribute requested.

Returns:
--------
attribute : `object`
    the attribute of self._impl for the requested name.

Definition at line 218 of file interface.py.

218 def __getattr__(self, name):
219 """Return the attribute of ``self._impl``, or ``._impl`` if it is
220 requested.
221
222 Parameters:
223 -----------
224 name : `str`
225 name of the attribute requested.
226
227 Returns:
228 --------
229 attribute : `object`
230 the attribute of self._impl for the requested name.
231 """
232
233 if name == '_impl':
234 return object.__getattr__(self, name)
235
236 if not (hasattr(self, "_impl") and self._impl):
237 raise AttributeError("Device has no _impl attached")
238
239 try:
240 return getattr(self._impl, name)
241 except AttributeError:
242 raise AttributeError(
243 f"Device {self.name} has no attribute \"{name}\"")
244

◆ __str__()

lsst.afw.display.interface.Display.__str__ ( self)

Definition at line 265 of file interface.py.

265 def __str__(self):
266 return f"Display[{self.frame}]"
267

◆ Buffering()

lsst.afw.display.interface.Display.Buffering ( self)
Return a context manager that will buffer repeated display
commands, to e.g. speed up displaying points.

Examples
--------
.. code-block:: py

   with display.Buffering():
       display.dot("+", xc, yc)

Definition at line 621 of file interface.py.

621 def Buffering(self):
622 """Return a context manager that will buffer repeated display
623 commands, to e.g. speed up displaying points.
624
625 Examples
626 --------
627 .. code-block:: py
628
629 with display.Buffering():
630 display.dot("+", xc, yc)
631 """
632 return self._Buffering(self._impl)
633

◆ centroids()

lsst.afw.display.interface.Display.centroids ( self,
catalog,
* symbol = "o",
** kwargs )
Draw the sources from a catalog at their pixel centroid positions
as given by `~lsst.afw.table.Catalog.getX()` and
`~lsst.afw.table.Catalog.getY()`.

See `dot` for an explanation of ``symbol`` and available args/kwargs,
which are passed to `dot`.

Parameters
----------
catalog : `lsst.afw.table.Catalog`
    Catalog to display centroids for. Must have valid `slot_Centroid`.

Definition at line 644 of file interface.py.

644 def centroids(self, catalog, *, symbol="o", **kwargs):
645 """Draw the sources from a catalog at their pixel centroid positions
646 as given by `~lsst.afw.table.Catalog.getX()` and
647 `~lsst.afw.table.Catalog.getY()`.
648
649 See `dot` for an explanation of ``symbol`` and available args/kwargs,
650 which are passed to `dot`.
651
652 Parameters
653 ----------
654 catalog : `lsst.afw.table.Catalog`
655 Catalog to display centroids for. Must have valid `slot_Centroid`.
656 """
657 if not catalog.getCentroidSlot().isValid():
658 raise RuntimeError("Catalog must have a valid `slot_Centroid` defined to get X/Y positions.")
659
660 with self.Buffering():
661 for pt in catalog:
662 self.dot(symbol, pt.getX(), pt.getY(), **kwargs)
663
bool isValid
Definition fits.cc:404

◆ close()

lsst.afw.display.interface.Display.close ( self)

Definition at line 245 of file interface.py.

245 def close(self):
246 if getattr(self, "_impl", None) is not None:
247 self._impl._close()
248 del self._impl
249 self._impl = None
250
251 if self.frame in Display._displays:
252 del Display._displays[self.frame]
253

◆ delAllDisplays()

lsst.afw.display.interface.Display.delAllDisplays ( )
static
Delete and close all known displays.

Definition at line 402 of file interface.py.

402 def delAllDisplays():
403 """Delete and close all known displays.
404 """
405 for disp in list(Display._displays.values()):
406 disp.close()
407 Display._displays = {}
408

◆ dot()

lsst.afw.display.interface.Display.dot ( self,
symb,
c,
r,
size = 2,
ctype = None,
origin = afwImage.PARENT,
** kwargs )
Draw a symbol onto the specified display 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.
c, r : `float`
    The column and row where the symbol is drawn [0-based coordinates].
size : `int`
    Size of symbol, in pixels.
ctype : `str`
    The desired color, either e.g. `lsst.afw.display.RED` or a color name known to X11
origin : `lsst.afw.image.ImageOrigin`
    Coordinate system for the given positions.
**kwargs
    Extra keyword arguments to backend.

Definition at line 664 of file interface.py.

664 def dot(self, symb, c, r, size=2, ctype=None, origin=afwImage.PARENT, **kwargs):
665 """Draw a symbol onto the specified display frame.
666
667 Parameters
668 ----------
669 symb
670 Possible values are:
671
672 ``"+"``
673 Draw a +
674 ``"x"``
675 Draw an x
676 ``"*"``
677 Draw a *
678 ``"o"``
679 Draw a circle
680 ``"@:Mxx,Mxy,Myy"``
681 Draw an ellipse with moments (Mxx, Mxy, Myy) (argument size is ignored)
682 `lsst.afw.geom.ellipses.BaseCore`
683 Draw the ellipse (argument size is ignored). N.b. objects
684 derived from `~lsst.afw.geom.ellipses.BaseCore` include
685 `~lsst.afw.geom.ellipses.Axes` and `~lsst.afw.geom.ellipses.Quadrupole`.
686 Any other value
687 Interpreted as a string to be drawn.
688 c, r : `float`
689 The column and row where the symbol is drawn [0-based coordinates].
690 size : `int`
691 Size of symbol, in pixels.
692 ctype : `str`
693 The desired color, either e.g. `lsst.afw.display.RED` or a color name known to X11
694 origin : `lsst.afw.image.ImageOrigin`
695 Coordinate system for the given positions.
696 **kwargs
697 Extra keyword arguments to backend.
698 """
699 if isinstance(symb, int):
700 symb = f"{symb:d}"
701
702 if origin == afwImage.PARENT and self._xy0 is not None:
703 x0, y0 = self._xy0
704 r -= y0
705 c -= x0
706
707 if isinstance(symb, afwGeom.ellipses.BaseCore) or re.search(r"^@:", symb):
708 try:
709 mat = re.search(r"^@:([^,]+),([^,]+),([^,]+)", symb)
710 except TypeError:
711 pass
712 else:
713 if mat:
714 mxx, mxy, myy = [float(_) for _ in mat.groups()]
715 symb = afwGeom.Quadrupole(mxx, myy, mxy)
716
717 symb = afwGeom.ellipses.Axes(symb)
718
719 self._impl._dot(symb, c, r, size, ctype, **kwargs)
720
An ellipse core with quadrupole moments as parameters.
Definition Quadrupole.h:47

◆ erase()

lsst.afw.display.interface.Display.erase ( self)
Erase the specified display frame.

Definition at line 639 of file interface.py.

639 def erase(self):
640 """Erase the specified display frame.
641 """
642 self._impl._erase()
643

◆ flush()

lsst.afw.display.interface.Display.flush ( self)
Flush any buffering that may be provided by the backend.

Definition at line 634 of file interface.py.

634 def flush(self):
635 """Flush any buffering that may be provided by the backend.
636 """
637 self._impl._flush()
638

◆ getActiveCallbackKeys()

lsst.afw.display.interface.Display.getActiveCallbackKeys ( self,
onlyActive = True )
Return all callback keys

Parameters
----------
onlyActive : `bool`
    If `True` only return keys that do something

Definition at line 882 of file interface.py.

882 def getActiveCallbackKeys(self, onlyActive=True):
883 """Return all callback keys
884
885 Parameters
886 ----------
887 onlyActive : `bool`
888 If `True` only return keys that do something
889 """
890 return sorted([k for k, func in self._callbacks.items() if
891 not (onlyActive and func == noop_callback)])
892
893
894# Callbacks for display events
895
896
std::vector< SchemaItem< Flag > > * items

◆ getDefaultBackend()

lsst.afw.display.interface.Display.getDefaultBackend ( )
static

Definition at line 281 of file interface.py.

281 def getDefaultBackend():
282 return Display._defaultBackend
283

◆ getDefaultFrame()

lsst.afw.display.interface.Display.getDefaultFrame ( )
static
Get the default frame for display.

Definition at line 291 of file interface.py.

291 def getDefaultFrame():
292 """Get the default frame for display.
293 """
294 return Display._defaultFrame
295

◆ getDisplay()

lsst.afw.display.interface.Display.getDisplay ( frame = None,
backend = None,
create = True,
verbose = False,
** kwargs )
static
Return a specific `Display`, creating it if need be.

Parameters
----------
frame
    The desired frame (`None` => use defaultFrame
    (see `~Display.setDefaultFrame`)).
backend : `str`
    create the specified frame using this backend (or the default if
    `None`) if it doesn't already exist. If ``backend == ""``, it's an
    error to specify a non-existent ``frame``.
create : `bool`
    create the display if it doesn't already exist.
verbose : `bool`
    Allow backend to be chatty.
**kwargs
    keyword arguments passed to `Display` constructor.

Definition at line 368 of file interface.py.

368 def getDisplay(frame=None, backend=None, create=True, verbose=False, **kwargs):
369 """Return a specific `Display`, creating it if need be.
370
371 Parameters
372 ----------
373 frame
374 The desired frame (`None` => use defaultFrame
375 (see `~Display.setDefaultFrame`)).
376 backend : `str`
377 create the specified frame using this backend (or the default if
378 `None`) if it doesn't already exist. If ``backend == ""``, it's an
379 error to specify a non-existent ``frame``.
380 create : `bool`
381 create the display if it doesn't already exist.
382 verbose : `bool`
383 Allow backend to be chatty.
384 **kwargs
385 keyword arguments passed to `Display` constructor.
386 """
387
388 if frame is None:
389 frame = Display._defaultFrame
390
391 if frame not in Display._displays:
392 if backend == "":
393 raise RuntimeError(f"Frame {frame} does not exist")
394
395 Display._displays[frame] = Display(
396 frame, backend, verbose=verbose, **kwargs)
397
398 Display._displays[frame].verbose = verbose
399 return Display._displays[frame]
400

◆ getMaskPlaneColor()

lsst.afw.display.interface.Display.getMaskPlaneColor ( self,
name = None )
Return the color associated with the specified mask plane name.

Parameters
----------
name : `str`
    Desired mask plane; if `None`, return entire dict.

Definition at line 468 of file interface.py.

468 def getMaskPlaneColor(self, name=None):
469 """Return the color associated with the specified mask plane name.
470
471 Parameters
472 ----------
473 name : `str`
474 Desired mask plane; if `None`, return entire dict.
475 """
476 if name is None:
477 return self._maskPlaneColors
478 else:
479 color = self._maskPlaneColors.get(name)
480
481 if color is None:
482 color = self._defaultMaskPlaneColor.get(name)
483
484 return color
485

◆ getMaskTransparency()

lsst.afw.display.interface.Display.getMaskTransparency ( self,
name = None )
Return the current display's mask transparency.

Definition at line 507 of file interface.py.

507 def getMaskTransparency(self, name=None):
508 """Return the current display's mask transparency.
509 """
510 return self._impl._getMaskTransparency(name)
511

◆ image()

lsst.afw.display.interface.Display.image ( self,
data,
title = "",
wcs = None )
Display an image on a display, with semi-transparent masks
overlaid, if available.

Parameters
----------
data : `lsst.afw.image.Exposure` or `lsst.afw.image.MaskedImage` or `lsst.afw.image.Image`
    Image to display; Exposure and MaskedImage will show transparent
    mask planes.
title : `str`, optional
    Title for the display window.
wcs : `lsst.afw.geom.SkyWcs`, optional
    World Coordinate System to align an `~lsst.afw.image.MaskedImage`
    or `~lsst.afw.image.Image` to; raise an exception if ``data``
    is an `~lsst.afw.image.Exposure`.

Raises
------
RuntimeError
    Raised if an Exposure is passed with a non-None wcs when the
    ``wcs`` kwarg is also non-None.
TypeError
    Raised if data is an incompatible type.

Definition at line 538 of file interface.py.

538 def image(self, data, title="", wcs=None):
539 """Display an image on a display, with semi-transparent masks
540 overlaid, if available.
541
542 Parameters
543 ----------
544 data : `lsst.afw.image.Exposure` or `lsst.afw.image.MaskedImage` or `lsst.afw.image.Image`
545 Image to display; Exposure and MaskedImage will show transparent
546 mask planes.
547 title : `str`, optional
548 Title for the display window.
549 wcs : `lsst.afw.geom.SkyWcs`, optional
550 World Coordinate System to align an `~lsst.afw.image.MaskedImage`
551 or `~lsst.afw.image.Image` to; raise an exception if ``data``
552 is an `~lsst.afw.image.Exposure`.
553
554 Raises
555 ------
556 RuntimeError
557 Raised if an Exposure is passed with a non-None wcs when the
558 ``wcs`` kwarg is also non-None.
559 TypeError
560 Raised if data is an incompatible type.
561 """
562 if hasattr(data, "getXY0"):
563 self._xy0 = data.getXY0()
564 else:
565 self._xy0 = None
566
567 # It's an Exposure; display the MaskedImage with the WCS
568 if isinstance(data, afwImage.Exposure):
569 if wcs:
570 raise RuntimeError("You may not specify a wcs with an Exposure")
571 data, wcs = data.getMaskedImage(), data.wcs
572 # it's a DecoratedImage; display it
573 elif isinstance(data, afwImage.DecoratedImage):
574 try:
575 wcs = afwGeom.makeSkyWcs(data.getMetadata())
576 except TypeError:
577 wcs = None
578 data = data.image
579
580 self._xy0 = data.getXY0() # DecoratedImage doesn't have getXY0()
581
582 if isinstance(data, afwImage.Image): # it's an Image; display it
583 self._impl._mtv(data, None, wcs, title)
584 # It's a Mask; display it, bitplane by bitplane.
585 elif isinstance(data, afwImage.Mask):
586 self.__addMissingMaskPlanes(data)
587 # Some displays can't display a Mask without an image; so display
588 # an Image too, with pixel values set to the mask.
589 self._impl._mtv(afwImage.ImageI(data.array), data, wcs, title)
590 # It's a MaskedImage; display Image and overlay Mask.
591 elif isinstance(data, afwImage.MaskedImage):
592 self.__addMissingMaskPlanes(data.mask)
593 self._impl._mtv(data.image, data.mask, wcs, title)
594 else:
595 raise TypeError(f"Unsupported type {data!r}")
596
afw::table::Key< afw::table::Array< ImagePixelT > > image
A container for an Image and its associated metadata.
Definition Image.h:406
A class to contain the data, WCS, and other information needed to describe an image of the sky.
Definition Exposure.h:72
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
Represent a 2-dimensional array of bitmask pixels.
Definition Mask.h:82
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74
std::shared_ptr< SkyWcs > makeSkyWcs(daf::base::PropertySet &metadata, bool strip=false)
Construct a SkyWcs from FITS keywords.
Definition SkyWcs.cc:521

◆ incrDefaultFrame()

lsst.afw.display.interface.Display.incrDefaultFrame ( )
static
Increment the default frame for display.

Definition at line 297 of file interface.py.

297 def incrDefaultFrame():
298 """Increment the default frame for display.
299 """
300 Display._defaultFrame += 1
301 return Display._defaultFrame
302

◆ interact()

lsst.afw.display.interface.Display.interact ( self)
Enter an interactive loop, listening for key presses or equivalent
UI actions in the display and firing callbacks.

Exit with ``q``, ``CR``, ``ESC``, or any equivalent UI action provided
in the display. The loop may also be exited by returning `True` from a
user-provided callback function.

Definition at line 823 of file interface.py.

823 def interact(self):
824 """Enter an interactive loop, listening for key presses or equivalent
825 UI actions in the display and firing callbacks.
826
827 Exit with ``q``, ``CR``, ``ESC``, or any equivalent UI action provided
828 in the display. The loop may also be exited by returning `True` from a
829 user-provided callback function.
830 """
831 interactFinished = False
832
833 while not interactFinished:
834 ev = self._impl._getEvent()
835 if not ev:
836 continue
837 k, x, y = ev.k, ev.x, ev.y # for now
838
839 if k not in self._callbacks:
840 logger.warning("No callback registered for %s", k)
841 else:
842 try:
843 interactFinished = self._callbacks[k](k, x, y)
844 except Exception:
845 logger.exception(
846 "Display._callbacks['%s'](%s,%s,%s) failed.", k, x, y)
847

◆ line()

lsst.afw.display.interface.Display.line ( self,
points,
origin = afwImage.PARENT,
symbs = False,
ctype = None,
size = 0.5 )
Draw a set of symbols or connect points

Parameters
----------
points : `list`
    A list of (col, row)
origin : `lsst.afw.image.ImageOrigin`
    Coordinate system for the given positions.
symbs : `bool` or sequence
    If ``symbs`` is `True`, draw points at the specified points using
    the desired symbol, otherwise connect the dots.

    If ``symbs`` supports indexing (which includes a string -- caveat
    emptor) the elements are used to label the points.
ctype : `str`
    ``ctype`` is the name of a color (e.g. 'red').
size : `float`
    Size of points to create if `symbs` is passed.

Definition at line 721 of file interface.py.

721 def line(self, points, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5):
722 """Draw a set of symbols or connect points
723
724 Parameters
725 ----------
726 points : `list`
727 A list of (col, row)
728 origin : `lsst.afw.image.ImageOrigin`
729 Coordinate system for the given positions.
730 symbs : `bool` or sequence
731 If ``symbs`` is `True`, draw points at the specified points using
732 the desired symbol, otherwise connect the dots.
733
734 If ``symbs`` supports indexing (which includes a string -- caveat
735 emptor) the elements are used to label the points.
736 ctype : `str`
737 ``ctype`` is the name of a color (e.g. 'red').
738 size : `float`
739 Size of points to create if `symbs` is passed.
740 """
741 if symbs:
742 try:
743 symbs[1]
744 except TypeError:
745 symbs = len(points)*list(symbs)
746
747 for i, xy in enumerate(points):
748 self.dot(symbs[i], *xy, size=size, ctype=ctype)
749 else:
750 if len(points) > 0:
751 if origin == afwImage.PARENT and self._xy0 is not None:
752 x0, y0 = self._xy0
753 _points = list(points) # make a mutable copy
754 for i, p in enumerate(points):
755 _points[i] = (p[0] - x0, p[1] - y0)
756 points = _points
757
758 self._impl._drawLines(points, ctype)
759

◆ maskColorGenerator()

lsst.afw.display.interface.Display.maskColorGenerator ( self,
omitBW = True )
A generator for "standard" colors.

Parameters
----------
omitBW : `bool`
    Don't include `BLACK` and `WHITE`.

Examples
--------

.. code-block:: py

   colorGenerator = interface.maskColorGenerator(omitBW=True)
   for p in planeList:
       print(p, next(colorGenerator))

Definition at line 409 of file interface.py.

409 def maskColorGenerator(self, omitBW=True):
410 """A generator for "standard" colors.
411
412 Parameters
413 ----------
414 omitBW : `bool`
415 Don't include `BLACK` and `WHITE`.
416
417 Examples
418 --------
419
420 .. code-block:: py
421
422 colorGenerator = interface.maskColorGenerator(omitBW=True)
423 for p in planeList:
424 print(p, next(colorGenerator))
425 """
426 _maskColors = [WHITE, BLACK, RED, GREEN,
427 BLUE, CYAN, MAGENTA, YELLOW, ORANGE]
428
429 i = -1
430 while True:
431 i += 1
432 color = _maskColors[i%len(_maskColors)]
433 if omitBW and color in (BLACK, WHITE):
434 continue
435
436 yield color
437

◆ mtv()

lsst.afw.display.interface.Display.mtv ( self,
data,
title = "",
wcs = None )
Display an image on a display, with semi-transparent masks
overlaid, if available.

Notes
-----
Historical note: the name "mtv" comes from Jim Gunn's forth imageprocessing
system, Mirella (named after Mirella Freni); The "m" stands for Mirella.

Definition at line 597 of file interface.py.

597 def mtv(self, data, title="", wcs=None):
598 """Display an image on a display, with semi-transparent masks
599 overlaid, if available.
600
601 Notes
602 -----
603 Historical note: the name "mtv" comes from Jim Gunn's forth imageprocessing
604 system, Mirella (named after Mirella Freni); The "m" stands for Mirella.
605 """
606 self.image(data, title, wcs)
607

◆ pan()

lsst.afw.display.interface.Display.pan ( self,
colc = None,
rowc = None,
origin = afwImage.PARENT )
Pan to a location.

Parameters
----------
colc, rowc
    Coordinates to pan to.
origin : `lsst.afw.image.ImageOrigin`
    Coordinate system for the given positions.

See also
--------
Display.zoom

Definition at line 807 of file interface.py.

807 def pan(self, colc=None, rowc=None, origin=afwImage.PARENT):
808 """Pan to a location.
809
810 Parameters
811 ----------
812 colc, rowc
813 Coordinates to pan to.
814 origin : `lsst.afw.image.ImageOrigin`
815 Coordinate system for the given positions.
816
817 See also
818 --------
819 Display.zoom
820 """
821 self.zoom(None, colc, rowc, origin)
822

◆ scale()

lsst.afw.display.interface.Display.scale ( self,
algorithm,
min,
max = None,
unit = None,
** kwargs )
Set the range of the scaling from DN in the image to the image
display.

Parameters
----------
algorithm : `str`
    Desired scaling (e.g. "linear" or "asinh").
min
    Minimum value, or "minmax" or "zscale".
max
    Maximum value (must be `None` for minmax|zscale).
unit
    Units for min and max (e.g. Percent, Absolute, Sigma; `None` if
    min==minmax|zscale).
**kwargs
    Optional keyword arguments to the backend.

Definition at line 760 of file interface.py.

760 def scale(self, algorithm, min, max=None, unit=None, **kwargs):
761 """Set the range of the scaling from DN in the image to the image
762 display.
763
764 Parameters
765 ----------
766 algorithm : `str`
767 Desired scaling (e.g. "linear" or "asinh").
768 min
769 Minimum value, or "minmax" or "zscale".
770 max
771 Maximum value (must be `None` for minmax|zscale).
772 unit
773 Units for min and max (e.g. Percent, Absolute, Sigma; `None` if
774 min==minmax|zscale).
775 **kwargs
776 Optional keyword arguments to the backend.
777 """
778 if min in ("minmax", "zscale"):
779 assert max is None, f"You may not specify \"{min}\" and max"
780 assert unit is None, f"You may not specify \"{min}\" and unit"
781 elif max is None:
782 raise RuntimeError("Please specify max")
783
784 self._impl._scale(algorithm, min, max, unit, **kwargs)
785

◆ setCallback()

lsst.afw.display.interface.Display.setCallback ( self,
k,
func = None,
noRaise = False )
Set the callback for a key.

Backend displays may provide an equivalent graphical UI action, but
must make the associated key letter visible in the UI in some way.

Parameters
----------
k : `str`
    The key to assign the callback to.
func : callable
    The callback assigned to ``k``.
noRaise : `bool`
    Do not raise if ``k`` is already in use.

Returns
-------
oldFunc : callable
    The callback previously assigned to ``k``.

Definition at line 848 of file interface.py.

848 def setCallback(self, k, func=None, noRaise=False):
849 """Set the callback for a key.
850
851 Backend displays may provide an equivalent graphical UI action, but
852 must make the associated key letter visible in the UI in some way.
853
854 Parameters
855 ----------
856 k : `str`
857 The key to assign the callback to.
858 func : callable
859 The callback assigned to ``k``.
860 noRaise : `bool`
861 Do not raise if ``k`` is already in use.
862
863 Returns
864 -------
865 oldFunc : callable
866 The callback previously assigned to ``k``.
867 """
868
869 if k in "f":
870 if noRaise:
871 return
872 raise RuntimeError(
873 f"Key '{k}' is already in use by display, so I can't add a callback for it")
874
875 ofunc = self._callbacks.get(k)
876 self._callbacks[k] = func if func else noop_callback
877
878 self._impl._setCallback(k, self._callbacks[k])
879
880 return ofunc
881

◆ setDefaultBackend()

lsst.afw.display.interface.Display.setDefaultBackend ( backend)
static

Definition at line 271 of file interface.py.

271 def setDefaultBackend(backend):
272 try:
273 _makeDisplayImpl(None, backend)
274 except Exception as e:
275 raise RuntimeError(
276 f"Unable to set backend to {backend}: \"{e}\"")
277
278 Display._defaultBackend = backend
279

◆ setDefaultFrame()

lsst.afw.display.interface.Display.setDefaultFrame ( frame = 0)
static
Set the default frame for display.

Definition at line 285 of file interface.py.

285 def setDefaultFrame(frame=0):
286 """Set the default frame for display.
287 """
288 Display._defaultFrame = frame
289

◆ setDefaultImageColormap()

lsst.afw.display.interface.Display.setDefaultImageColormap ( cmap)
static
Set the default colormap for images.

Parameters
----------
cmap : `str`
    Name of colormap, as interpreted by the backend.

Notes
-----
The only colormaps that all backends are required to honor
(if they pay any attention to setImageColormap) are "gray" and "grey".

Definition at line 335 of file interface.py.

335 def setDefaultImageColormap(cmap):
336 """Set the default colormap for images.
337
338 Parameters
339 ----------
340 cmap : `str`
341 Name of colormap, as interpreted by the backend.
342
343 Notes
344 -----
345 The only colormaps that all backends are required to honor
346 (if they pay any attention to setImageColormap) are "gray" and "grey".
347 """
348
349 Display._defaultImageColormap = cmap
350

◆ setDefaultMaskPlaneColor()

lsst.afw.display.interface.Display.setDefaultMaskPlaneColor ( name = None,
color = None )
static
Set the default mapping from mask plane names to colors.

Parameters
----------
name : `str` or `dict`
    Name of mask plane, or a dict mapping names to colors
    If name is `None`, use the hard-coded default dictionary.
color
    Desired color, or `None` if name is a dict.

Definition at line 311 of file interface.py.

311 def setDefaultMaskPlaneColor(name=None, color=None):
312 """Set the default mapping from mask plane names to colors.
313
314 Parameters
315 ----------
316 name : `str` or `dict`
317 Name of mask plane, or a dict mapping names to colors
318 If name is `None`, use the hard-coded default dictionary.
319 color
320 Desired color, or `None` if name is a dict.
321 """
322
323 if name is None:
324 name = Display._defaultMaskPlaneColor
325
326 if isinstance(name, dict):
327 assert color is None
328 for k, v in name.items():
329 setDefaultMaskPlaneColor(k, v)
330 return
331 # Set the individual color values
332 Display._defaultMaskPlaneColor[name] = color
333

◆ setDefaultMaskTransparency()

lsst.afw.display.interface.Display.setDefaultMaskTransparency ( maskPlaneTransparency = {})
static

Definition at line 304 of file interface.py.

304 def setDefaultMaskTransparency(maskPlaneTransparency={}):
305 if hasattr(maskPlaneTransparency, "copy"):
306 maskPlaneTransparency = maskPlaneTransparency.copy()
307
308 Display._defaultMaskTransparency = maskPlaneTransparency
309

◆ setImageColormap()

lsst.afw.display.interface.Display.setImageColormap ( self,
cmap )
Set the colormap to use for images.

 Parameters
----------
cmap : `str`
    Name of colormap, as interpreted by the backend.

Notes
-----
The only colormaps that all backends are required to honor
(if they pay any attention to setImageColormap) are "gray" and "grey".

Definition at line 351 of file interface.py.

351 def setImageColormap(self, cmap):
352 """Set the colormap to use for images.
353
354 Parameters
355 ----------
356 cmap : `str`
357 Name of colormap, as interpreted by the backend.
358
359 Notes
360 -----
361 The only colormaps that all backends are required to honor
362 (if they pay any attention to setImageColormap) are "gray" and "grey".
363 """
364
365 self._impl._setImageColormap(cmap)
366

◆ setMaskPlaneColor()

lsst.afw.display.interface.Display.setMaskPlaneColor ( self,
name,
color = None )
Request that mask plane name be displayed as color.

Parameters
----------
name : `str` or `dict`
    Name of mask plane or a dictionary of name -> colorName.
color : `str`
    The name of the color to use (must be `None` if ``name`` is a
    `dict`).

    Colors may be specified as any X11-compliant string (e.g.
    `"orchid"`), or by one of the following constants in
    `lsst.afw.display` : `BLACK`, `WHITE`, `RED`, `BLUE`,
    `GREEN`, `CYAN`, `MAGENTA`, `YELLOW`.

    If the color is "ignore" (or `IGNORE`) then that mask plane is not
    displayed.

    The advantage of using the symbolic names is that the python
    interpreter can detect typos.

Definition at line 438 of file interface.py.

438 def setMaskPlaneColor(self, name, color=None):
439 """Request that mask plane name be displayed as color.
440
441 Parameters
442 ----------
443 name : `str` or `dict`
444 Name of mask plane or a dictionary of name -> colorName.
445 color : `str`
446 The name of the color to use (must be `None` if ``name`` is a
447 `dict`).
448
449 Colors may be specified as any X11-compliant string (e.g.
450 `"orchid"`), or by one of the following constants in
451 `lsst.afw.display` : `BLACK`, `WHITE`, `RED`, `BLUE`,
452 `GREEN`, `CYAN`, `MAGENTA`, `YELLOW`.
453
454 If the color is "ignore" (or `IGNORE`) then that mask plane is not
455 displayed.
456
457 The advantage of using the symbolic names is that the python
458 interpreter can detect typos.
459 """
460 if isinstance(name, dict):
461 assert color is None
462 for k, v in name.items():
463 self.setMaskPlaneColor(k, v)
464 return
465
466 self._maskPlaneColors[name] = color
467

◆ setMaskTransparency()

lsst.afw.display.interface.Display.setMaskTransparency ( self,
transparency = None,
name = None )
Specify display's mask transparency (percent); or `None` to not set
it when loading masks.

Definition at line 486 of file interface.py.

486 def setMaskTransparency(self, transparency=None, name=None):
487 """Specify display's mask transparency (percent); or `None` to not set
488 it when loading masks.
489 """
490 if isinstance(transparency, dict):
491 assert name is None
492 for k, v in transparency.items():
493 self.setMaskTransparency(v, k)
494 return
495
496 if transparency is not None and (transparency < 0 or transparency > 100):
497 print(
498 "Mask transparency should be in the range [0, 100]; clipping", file=sys.stderr)
499 if transparency < 0:
500 transparency = 0
501 else:
502 transparency = 100
503
504 if transparency is not None:
505 self._impl._setMaskTransparency(transparency, name)
506

◆ show()

lsst.afw.display.interface.Display.show ( self)
Uniconify and Raise display.

Notes
-----
Throws an exception if frame doesn't exit.

Definition at line 512 of file interface.py.

512 def show(self):
513 """Uniconify and Raise display.
514
515 Notes
516 -----
517 Throws an exception if frame doesn't exit.
518 """
519 return self._impl._show()
520

◆ verbose() [1/2]

lsst.afw.display.interface.Display.verbose ( self)
The backend's verbosity.

Definition at line 255 of file interface.py.

255 def verbose(self):
256 """The backend's verbosity.
257 """
258 return self._impl.verbose
259

◆ verbose() [2/2]

lsst.afw.display.interface.Display.verbose ( self,
value )

Definition at line 261 of file interface.py.

261 def verbose(self, value):
262 if self._impl:
263 self._impl.verbose = value
264

◆ zoom()

lsst.afw.display.interface.Display.zoom ( self,
zoomfac = None,
colc = None,
rowc = None,
origin = afwImage.PARENT )
Zoom frame by specified amount, optionally panning also

Definition at line 786 of file interface.py.

786 def zoom(self, zoomfac=None, colc=None, rowc=None, origin=afwImage.PARENT):
787 """Zoom frame by specified amount, optionally panning also
788 """
789 if (rowc and colc is None) or (colc and rowc is None):
790 raise RuntimeError(
791 "Please specify row and column center to pan about")
792
793 if rowc is not None:
794 if origin == afwImage.PARENT and self._xy0 is not None:
795 x0, y0 = self._xy0
796 colc -= x0
797 rowc -= y0
798
799 self._impl._pan(colc, rowc)
800
801 if zoomfac is None and rowc is None:
802 zoomfac = 2
803
804 if zoomfac is not None:
805 self._impl._zoom(zoomfac)
806

Member Data Documentation

◆ _callbacks

lsst.afw.display.interface.Display._callbacks
protected

Definition at line 181 of file interface.py.

◆ _defaultBackend

lsst.afw.display.interface.Display._defaultBackend = None
staticprotected

Definition at line 139 of file interface.py.

◆ _defaultFrame

int lsst.afw.display.interface.Display._defaultFrame = 0
staticprotected

Definition at line 140 of file interface.py.

◆ _defaultImageColormap

str lsst.afw.display.interface.Display._defaultImageColormap = "gray"
staticprotected

Definition at line 156 of file interface.py.

◆ _defaultMaskPlaneColor

lsst.afw.display.interface.Display._defaultMaskPlaneColor
staticprotected
Initial value:
= dict(
BAD=RED,
CR=MAGENTA,
EDGE=YELLOW,
INTERPOLATED=GREEN,
SATURATED=GREEN,
DETECTED=BLUE,
DETECTED_NEGATIVE=CYAN,
SUSPECT=YELLOW,
NO_DATA=ORANGE,
# deprecated names
INTRP=GREEN,
SAT=GREEN,
)

Definition at line 141 of file interface.py.

◆ _defaultMaskTransparency

dict lsst.afw.display.interface.Display._defaultMaskTransparency = {}
staticprotected

Definition at line 155 of file interface.py.

◆ _displays

dict lsst.afw.display.interface.Display._displays = {}
staticprotected

Definition at line 138 of file interface.py.

◆ _impl

lsst.afw.display.interface.Display._impl
protected

Definition at line 172 of file interface.py.

◆ _maskPlaneColors

lsst.afw.display.interface.Display._maskPlaneColors
protected

Definition at line 177 of file interface.py.

◆ _xy0

lsst.afw.display.interface.Display._xy0
protected

Definition at line 175 of file interface.py.

◆ frame

lsst.afw.display.interface.Display.frame

Definition at line 171 of file interface.py.

◆ name

lsst.afw.display.interface.Display.name

Definition at line 173 of file interface.py.


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