WholeSkyPlot¶

class lsst.analysis.tools.actions.plot.WholeSkyPlot(*args, **kw)¶

Bases: PlotAction

Plots the on sky distribution of a parameter.

Plots the values of the parameter given for the z axis according to the positions given for x and y. Optimised for use with RA and Dec. Also calculates some basic statistics and includes those on the plot.

The default axes limits and figure size were chosen to plot HSC PDR2.

Attributes Summary

`autoAxesLimits`	Find axes limits automatically.
`colorBarMax`	The minimum value of the color bar.
`colorBarMin`	The minimum value of the color bar.
`colorBarRange`	The multiplier for the color bar range.
`colorMap`	List of hexidecimal colors for a user-defined color map.
`colorMapType`	Type of color map to use for the color bar.
`dpi`	DPI size of the figure.
`figureSize`	Size of the figure.
`labelTracts`	Label the tracts.
`showNaNs`	Show the NaNs on the plot.
`showOutliers`	Show the outliers on the plot.
`xAxisLabel`	Label to use for the x axis.
`xLimits`	Plotting limits for the x axis.
`yAxisLabel`	Label to use for the y axis.
`yLimits`	Plotting limits for the y axis.
`zAxisLabel`	Label to use for the z axis.

Methods Summary

`__call__`(data, **kwargs)	Call self as a function.
`getInputSchema`(**kwargs)	Return the schema an `AnalysisAction` expects to be present in the arguments supplied to the __call__ method.
`makePlot`(data[, plotInfo])	Make a WholeSkyPlot of the given data.

Attributes Documentation

autoAxesLimits¶: Find axes limits automatically. (bool, default True)

colorBarMax¶: The minimum value of the color bar. (float, default None)

colorBarMin¶: The minimum value of the color bar. (float, default None)

colorBarRange¶: The multiplier for the color bar range. The max/min range values are: median +/- N * sigmaMad, where N is this config value. (float, default 3.0)

colorMap¶: List of hexidecimal colors for a user-defined color map. (List, default None)

colorMapType¶

Type of color map to use for the color bar. Options: sequential, divergent, userDefined. (str, default 'divergent')

Allowed values:

'sequential': sequential
'divergent': divergent
'None': Field is optional

dpi¶: DPI size of the figure. (int, default 500)

figureSize¶: Size of the figure. (List, default [9.0, 3.5])

labelTracts¶: Label the tracts. (bool, default False)

showNaNs¶: Show the NaNs on the plot. (bool, default True)

showOutliers¶: Show the outliers on the plot. Outliers are values whose absolute value is > colorBarRange * sigmaMAD. (bool, default True)

xAxisLabel¶: Label to use for the x axis. (str, default 'RA (degrees)')

xLimits¶: Plotting limits for the x axis. (List, default [-5.0, 365.0])

yAxisLabel¶: Label to use for the y axis. (str, default 'Dec (degrees)')

yLimits¶: Plotting limits for the y axis. (List, default [-10.0, 60.0])

zAxisLabel¶: Label to use for the z axis. (str, default '')

Methods Documentation

__call__(data: MutableMapping[str, ndarray[tuple[Any, ...], dtype[_ScalarT]] | Scalar | HealSparseMap | Tensor | Mapping], **kwargs) → Mapping[str, Figure] | Figure¶: Call self as a function.

getInputSchema(**kwargs) → Iterable[tuple[str, type[numpy.ndarray[tuple[Any, ...], numpy.dtype[_ScalarT]]] | type[lsst.analysis.tools.interfaces._interfaces.Scalar] | type[healsparse.healSparseMap.HealSparseMap] | type[lsst.analysis.tools.interfaces._interfaces.Tensor] | type[Mapping]]]¶

Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.

Returns:

resultKeyedDataSchema: The schema this action requires to be present when calling this action, keys are unformatted.

Make a WholeSkyPlot of the given data.

Parameters:

dataKeyedData

The catalog to plot the points from.

plotInfodict

A dictionary of information about the data being plotted with keys:

"run": The output run for the plots (str).
"skymap": The type of skymap used for the data (str).
"filter": The filter used for this data (str).
"tract": The tract that the data comes from (str).

Returns:

pipeBase.Struct containing:

skyPlotmatplotlib.figure.Figure: The resulting figure.

Examples

An example of the plot produced from this code is here:

For a detailed example of how to make a plot from the command line please see the getting started guide.

Navigation

WholeSkyPlot¶