lsst.display.matplotlib  18.0.0+2
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=True, reopenPlot=False, args, kwargs)
 
def savefig (self, args, kwargs)
 
def show_colorbar (self, show=True)
 
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 = True,
  reopenPlot = False,
  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)

Member Function Documentation

◆ savefig()

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

◆ show_colorbar()

def lsst.display.matplotlib.matplotlib.DisplayImpl.show_colorbar (   self,
  show = True 
)
Show (or hide) the colour bar

◆ wait()

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

@param prompt `str`
   The prompt string.
@param 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: