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.

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.

figureSize

Size of the figure.

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)

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

figureSize

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

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)

Methods Documentation

__call__(data: MutableMapping[str, ndarray[tuple[int, ...], dtype[_ScalarType_co]] | Scalar | HealSparseMap | Tensor | Mapping], **kwargs) Mapping[str, Figure] | Figure

Call self as a function.

getInputSchema(**kwargs) 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.

makePlot(data: MutableMapping[str, ndarray[tuple[int, ...], dtype[_ScalarType_co]] | Scalar | HealSparseMap | Tensor | Mapping], plotInfo: Mapping[str, str] | None = None, **kwargs) Figure

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:

../_images/wholeSkyPlotExample.png

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