Public Member Functions
def	__init__ (self)

def	eval1d (self, dim, x)

def	eval2d (self, xDim, yDim, x, y)

Public Attributes
	dimensions

	mu

	sigma

	lower

	upper

	values

Detailed Description

An example data object for DensityPlot, demonstrating the necessarity interface.

There are two levels of requirements for a data object.  First are the attributes
required by the DensityPlot object itself; these must be present on every data object:

   dimensions ------ a sequence of strings that provide names for the dimensions

   lower ----------- a dictionary of {dimension-name: lower-bound}

   upper ----------- a dictionary of {dimension-name: upper-bound}

The second level of requirements are those of the Layer objects provided here.  These
may be absent if the associated Layer is not used or is subclassed to reimplement the
Layer method that calls the data object method.  Currently, these include:

   eval1d, eval2d -- methods used by the SurfaceLayer class; see their docs for more info

   values ---------- attribute used by the HistogramLayer and ScatterLayer classes, an array
                     with shape (M,N), where N is the number of dimension and M is the number
                     of data points

   weights --------- optional attribute used by the HistogramLayer and ScatterLayer classes,
                     a 1-d array with size=M that provides weights for each data point

Definition at line 438 of file densityPlot.py.

Constructor & Destructor Documentation

◆ init()

def lsst.meas.modelfit.display.densityPlot.ExampleData.__init__ ( self )

Definition at line 464 of file densityPlot.py.

Member Function Documentation

◆ eval1d()

def lsst.meas.modelfit.display.densityPlot.ExampleData.eval1d	(	self,
		dim,
		x
	)

Evaluate the 1-d analytic function for the given dim at points x (a 1-d numpy array;
this method must be numpy-vectorized).

Definition at line 472 of file densityPlot.py.

◆ eval2d()

def lsst.meas.modelfit.display.densityPlot.ExampleData.eval2d	(	self,
		xDim,
		yDim,
		x,
		y
	)

Evaluate the 2-d analytic function for the given xDim and yDim at points x,y
(2-d numpy arrays with the same shape; this method must be numpy-vectorized).

Definition at line 479 of file densityPlot.py.

Member Data Documentation

◆ dimensions

lsst.meas.modelfit.display.densityPlot.ExampleData.dimensions

Definition at line 465 of file densityPlot.py.

◆ lower

lsst.meas.modelfit.display.densityPlot.ExampleData.lower

Definition at line 468 of file densityPlot.py.

◆ mu

lsst.meas.modelfit.display.densityPlot.ExampleData.mu

Definition at line 466 of file densityPlot.py.

◆ sigma

lsst.meas.modelfit.display.densityPlot.ExampleData.sigma

Definition at line 467 of file densityPlot.py.

◆ upper

lsst.meas.modelfit.display.densityPlot.ExampleData.upper

Definition at line 469 of file densityPlot.py.

◆ values

lsst.meas.modelfit.display.densityPlot.ExampleData.values

Definition at line 470 of file densityPlot.py.

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

python/lsst/meas/modelfit/display/densityPlot.py

Public Member Functions

Public Attributes