GridPlot#

class lsst.analysis.tools.actions.plot.GridPlot(*args, **kw)#

Bases: PlotAction

Plot a series of plot elements onto a regularly spaced grid.

Attributes Summary

`dpi`	Dots per inch.
`figsize`	Figure size.
`height_ratios`	Height ratios (`List`, default `None`)
`numCols`	Number of columns.
`numRows`	Number of rows.
`panels`	Plot elements.
`suptitle`	String arguments passed into fig.suptitle() defining the figure title.
`valsGroupBy`	Independent data definitions.
`width_ratios`	Width ratios (`List`, default `None`)
`xAxisLabel`	String argument passed into fig.supxlabel() defining the figure x label.
`xDataKeys`	Dependent data definitions.
`yAxisLabel`	String argument passed into fig.supylabel() defining the figure y label.

Methods Summary

`__call__`(data, **kwargs)	Plot data.
`validate`()	Validate configuration.

Attributes Documentation

dpi#: Dots per inch. (float, default 150)

figsize#: Figure size. (List, default [8, 8])

height_ratios#: Height ratios (List, default None)

numCols#: Number of columns. (int, default 1)

numRows#: Number of rows. (int, default 1)

panels#: Plot elements. (ConfigDict)

suptitle#: String arguments passed into fig.suptitle() defining the figure title. (Dict, default None)

valsGroupBy#: Independent data definitions. The key of this dict is the panel ID. The values are keys of data to plot (comma-separated for multiple) where each key may be a subset of a full key. (Dict)

width_ratios#: Width ratios (List, default None)

xAxisLabel#: String argument passed into fig.supxlabel() defining the figure x label. (str, default None)

xDataKeys#: Dependent data definitions. The key of this dict is the panel ID. The values are keys of data to plot (comma-separated for multiple) where each key may be a subset of a full key. (Dict, default {})

yAxisLabel#: String argument passed into fig.supylabel() defining the figure y label. (str, default None)

Methods Documentation

__call__(data: KeyedData, **kwargs) → PlotResultType#: Plot data.

validate()#: Validate configuration.