Public Member Functions
def	__init__ (self, tag, bins1d=20, bins2d=(20, 20), kwds1d=None, kwds2d=None)

def	hist1d (self, data, dim, limits)

def	hist2d (self, data, xDim, yDim, xLimits, yLimits)

def	plotX (self, axes, data, dim)

def	plotY (self, axes, data, dim)

def	plotXY (self, axes, data, xDim, yDim)

Public Attributes
	tag

	bins1d

	bins2d

	kwds1d

	kwds2d

Static Public Attributes
	defaults1d = dict(facecolor='b', alpha=0.5)

	defaults2d = dict(cmap=matplotlib.cm.Blues, vmin=0.0, interpolation='nearest')

Detailed Description

A Layer class for DensityPlot for gridded histograms, drawing bar plots in 1-d and
colormapped large-pixel images in 2-d.

Relies on two data object attributes:

   values ----- a (M,N) array of data points, where N is the dimension of the dataset and M is the
                number of data points

   weights ---- (optional) an array of weights with shape (M,); if not present, all weights will
                be set to unity

The need for these data object attributes can be removed by subclassing HistogramLayer and overriding
the hist1d and hist2d methods.

Definition at line 63 of file densityPlot.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.modelfit.display.densityPlot.HistogramLayer.__init__	(	self,
		tag,
		bins1d = `20`,
		bins2d = `(20, 20)`,
		kwds1d = `None`,
		kwds2d = `None`
	)

Definition at line 82 of file densityPlot.py.

     def __init__(self, tag, bins1d=20, bins2d=(20, 20), kwds1d=None, kwds2d=None):
         self.tag = tag
         self.bins1d = bins1d
         self.bins2d = bins2d
         self.kwds1d = mergeDefaults(kwds1d, self.defaults1d)
         self.kwds2d = mergeDefaults(kwds2d, self.defaults2d)
  

Member Function Documentation

◆ hist1d()

def lsst.meas.modelfit.display.densityPlot.HistogramLayer.hist1d	(	self,
		data,
		dim,
		limits
	)

Extract points from the data object and compute a 1-d histogram.

Return value should match that of numpy.histogram: a tuple of (hist, edges),
where hist is a 1-d array with size=bins1d, and edges is a 1-d array with
size=self.bins1d+1 giving the upper and lower edges of the bins.

Definition at line 89 of file densityPlot.py.

     def hist1d(self, data, dim, limits):
         """Extract points from the data object and compute a 1-d histogram.
  
         Return value should match that of numpy.histogram: a tuple of (hist, edges),
         where hist is a 1-d array with size=bins1d, and edges is a 1-d array with
         size=self.bins1d+1 giving the upper and lower edges of the bins.
         """
         i = data.dimensions.index(dim)
         if hasattr(data, "weights") and data.weights is not None:
             weights = data.weights
         else:
             weights = None
         return numpy.histogram(data.values[:, i], bins=self.bins1d, weights=weights,
                                range=limits, normed=True)
  

◆ hist2d()

def lsst.meas.modelfit.display.densityPlot.HistogramLayer.hist2d	(	self,
		data,
		xDim,
		yDim,
		xLimits,
		yLimits
	)

Extract points from the data object and compute a 1-d histogram.

Return value should match that of numpy.histogram2d: a tuple of (hist, xEdges, yEdges),
where hist is a 2-d array with shape=bins2d, xEdges is a 1-d array with size=bins2d[0]+1,
and yEdges is a 1-d array with size=bins2d[1]+1.

Definition at line 104 of file densityPlot.py.

     def hist2d(self, data, xDim, yDim, xLimits, yLimits):
         """Extract points from the data object and compute a 1-d histogram.
  
         Return value should match that of numpy.histogram2d: a tuple of (hist, xEdges, yEdges),
         where hist is a 2-d array with shape=bins2d, xEdges is a 1-d array with size=bins2d[0]+1,
         and yEdges is a 1-d array with size=bins2d[1]+1.
         """
         i = data.dimensions.index(yDim)
         j = data.dimensions.index(xDim)
         if hasattr(data, "weights") and data.weights is not None:
             weights = data.weights
         else:
             weights = None
         return numpy.histogram2d(data.values[:, j], data.values[:, i], bins=self.bins2d, weights=weights,
                                  range=(xLimits, yLimits), normed=True)
  

◆ plotX()

def lsst.meas.modelfit.display.densityPlot.HistogramLayer.plotX	(	self,
		axes,
		data,
		dim
	)

Definition at line 120 of file densityPlot.py.

     def plotX(self, axes, data, dim):
         y, xEdge = self.hist1d(data, dim, axes.get_xlim())
         xCenter = 0.5*(xEdge[:-1] + xEdge[1:])
         width = xEdge[1:] - xEdge[:-1]
         return axes.bar(xCenter, y, width=width, align='center', **self.kwds1d)
  

◆ plotXY()

def lsst.meas.modelfit.display.densityPlot.HistogramLayer.plotXY	(	self,
		axes,
		data,
		xDim,
		yDim
	)

Definition at line 132 of file densityPlot.py.

     def plotXY(self, axes, data, xDim, yDim):
         z, xEdge, yEdge = self.hist2d(data, xDim, yDim, axes.get_xlim(), axes.get_ylim())
         return axes.imshow(z.transpose(), aspect='auto', extent=(xEdge[0], xEdge[-1], yEdge[0], yEdge[-1]),
                            origin='lower', **self.kwds2d)
  
  

◆ plotY()

def lsst.meas.modelfit.display.densityPlot.HistogramLayer.plotY	(	self,
		axes,
		data,
		dim
	)

Definition at line 126 of file densityPlot.py.

     def plotY(self, axes, data, dim):
         x, yEdge = self.hist1d(data, dim, axes.get_ylim())
         yCenter = 0.5*(yEdge[:-1] + yEdge[1:])
         height = yEdge[1:] - yEdge[:-1]
         return axes.barh(yCenter, x, height=height, align='center', **self.kwds1d)
  

Member Data Documentation

◆ bins1d

lsst.meas.modelfit.display.densityPlot.HistogramLayer.bins1d

Definition at line 84 of file densityPlot.py.

◆ bins2d

lsst.meas.modelfit.display.densityPlot.HistogramLayer.bins2d

Definition at line 85 of file densityPlot.py.

◆ defaults1d

lsst.meas.modelfit.display.densityPlot.HistogramLayer.defaults1d = dict(facecolor='b', alpha=0.5)

static

Definition at line 79 of file densityPlot.py.

◆ defaults2d

lsst.meas.modelfit.display.densityPlot.HistogramLayer.defaults2d = dict(cmap=matplotlib.cm.Blues, vmin=0.0, interpolation='nearest')

static

Definition at line 80 of file densityPlot.py.

◆ kwds1d

lsst.meas.modelfit.display.densityPlot.HistogramLayer.kwds1d

Definition at line 86 of file densityPlot.py.

◆ kwds2d

lsst.meas.modelfit.display.densityPlot.HistogramLayer.kwds2d

Definition at line 87 of file densityPlot.py.

◆ tag

lsst.meas.modelfit.display.densityPlot.HistogramLayer.tag

Definition at line 83 of file densityPlot.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_modelfit/22.0.1-4-g44f2e3d+9e4ab0f4fa/python/lsst/meas/modelfit/display/densityPlot.py

Public Member Functions

Public Attributes

Static Public Attributes