lsst.meas.modelfit  22.0.1-1-g1b65d06+bd09b5c7d8
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.modelfit.display.densityPlot.HistogramLayer Class Reference

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.

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.

◆ 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.

◆ plotX()

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

Definition at line 120 of file densityPlot.py.

◆ plotXY()

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

Definition at line 132 of file densityPlot.py.

◆ plotY()

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

Definition at line 126 of file densityPlot.py.

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: