lsst.display.matplotlib  21.0.0-2-gfc62afb+a9f57e981a
Public Member Functions | List of all members
lsst.display.matplotlib.matplotlib.DisplayImpl Class Reference
Inheritance diagram for lsst.display.matplotlib.matplotlib.DisplayImpl:

Public Member Functions

def __init__ (self, display, verbose=False, interpretMaskBits=True, mtvOrigin=afwImage.PARENT, fastMaskDisplay=False, reopenPlot=False, useSexagesimal=False, dpi=None, *args, **kwargs)
 
def savefig (self, *args, **kwargs)
 
def show_colorbar (self, show=True, where="right", axSize="5%", axPad=None, **kwargs)
 
def useSexagesimal (self, useSexagesimal)
 
def wait (self, prompt="[c(ontinue) p(db)] :", allowPdb=True)
 

Detailed Description

Provide a matplotlib backend for afwDisplay

Recommended backends in notebooks are:
  %matplotlib notebook
or
  %matplotlib ipympl
or
  %matplotlib qt
  %gui qt
or
  %matplotlib inline
or
  %matplotlib osx

Apparently only qt supports Display.interact(); the list of interactive
backends is given by lsst.display.matplotlib.interactiveBackends

Constructor & Destructor Documentation

◆ __init__()

def lsst.display.matplotlib.matplotlib.DisplayImpl.__init__ (   self,
  display,
  verbose = False,
  interpretMaskBits = True,
  mtvOrigin = afwImage.PARENT,
  fastMaskDisplay = False,
  reopenPlot = False,
  useSexagesimal = False,
  dpi = None,
args,
**  kwargs 
)
Initialise a matplotlib display

@param fastMaskDisplay      If True only show the first bitplane that's
                            set in each pixel
                            (e.g. if (SATURATED & DETECTED)
                            ignore DETECTED)
                            Not really what we want, but a bit faster
@param interpretMaskBits    Interpret the mask value under the cursor
@param mtvOrigin            Display pixel coordinates with LOCAL origin
                            (bottom left == 0,0 not XY0)
@param reopenPlot           If true, close the plot before opening it.
                            (useful with e.g. %ipympl)
@param useSexagesimal       If True, display coordinates in sexagesimal
                            E.g. hh:mm:ss.ss (default:False)
                            May be changed by calling
                                  display.useSexagesimal()
@param dpi                  Number of dpi (passed to pyplot.figure)

The `frame` argument to `Display` may be a matplotlib figure; this
permits code such as
   fig, axes = plt.subplots(1, 2)

   disp = afwDisplay.Display(fig)
   disp.scale('asinh', 'zscale', Q=0.5)

   for axis, exp in zip(axes, exps):
      plt.sca(axis)    # make axis active
      disp.mtv(exp)

Member Function Documentation

◆ savefig()

def lsst.display.matplotlib.matplotlib.DisplayImpl.savefig (   self,
args,
**  kwargs 
)
Defer to figure.savefig()

Parameters
----------
args : `list`
  Passed through to figure.savefig()
kwargs : `dict`
  Passed through to figure.savefig()

◆ show_colorbar()

def lsst.display.matplotlib.matplotlib.DisplayImpl.show_colorbar (   self,
  show = True,
  where = "right",
  axSize = "5%",
  axPad = None,
**  kwargs 
)
Show (or hide) the colour bar

Parameters
----------
show : `bool`
  Should I show the colour bar?
where : `str`
  Location of colour bar: "right" or "bottom"
axSize : `float` or `str`
  Size of axes to hold the colour bar; fraction of current x-size
axPad : `float` or `str`
  Padding between axes and colour bar; fraction of current x-size
args : `list`
  Passed through to colorbar()
kwargs : `dict`
  Passed through to colorbar()

We set the default padding to put the colourbar in a reasonable
place for roughly square plots, but you may need to fiddle for
plots with extreme axis ratios.

You can only configure the colorbar when it isn't yet visible, but
as you can easily remove it this is not in practice a difficulty.

◆ useSexagesimal()

def lsst.display.matplotlib.matplotlib.DisplayImpl.useSexagesimal (   self,
  useSexagesimal 
)
Control the formatting coordinates as HH:MM:SS.ss

Parameters
----------
useSexagesimal : `bool`
   Print coordinates as e.g. HH:MM:SS.ss iff True

N.b. can also be set in Display's ctor
Are we formatting coordinates as HH:MM:SS.ss?

◆ wait()

def lsst.display.matplotlib.matplotlib.DisplayImpl.wait (   self,
  prompt = "[c(ontinue) p(db)] :",
  allowPdb = True 
)
Wait for keyboard input

Parameters
----------
prompt : `str`
   The prompt string.
allowPdb : `bool`
   If true, entering a 'p' or 'pdb' puts you into pdb

Returns the string you entered

Useful when plotting from a programme that exits such as a processCcd
Any key except 'p' continues; 'p' puts you into pdb (unless
allowPdb is False)

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