PerTractPropertyMapPlot

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

Bases: PlotAction

Attributes Summary

draw_patch_bounds

Whether to draw patch inner boundaries or not (bool, default False)

label_patches

Which patches to label by ID (str, default 'none')

plotName

The name for the plotting task.

Methods Summary

__call__(data, tractInfo, plotConfig, ...)

Call self as a function.

addPlotInfo(fig, plotInfo, toolName)

Add useful information to the plot.

makePlot(data, tractInfo, plotConfig, plotInfo)

Make the survey property map plot.

prettyPrintFloat(n)

Attributes Documentation

draw_patch_bounds

Whether to draw patch inner boundaries or not (bool, default False)

label_patches

Which patches to label by ID (str, default 'none')

Allowed values:

'all'

All patches

'edge'

Edge patches only

'none'

No labels

'None'

Field is optional

plotName

The name for the plotting task. (str, default None)

Methods Documentation

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

Call self as a function.

addPlotInfo(fig: Figure, plotInfo: Mapping[str, Mapping[str, str] | str | int], toolName: str) Figure

Add useful information to the plot.

Parameters:
figmatplotlib.figure.Figure

The figure to add the information to.

plotInfodict

A dictionary of the plot information.

toolNamestr

The name of the tool used to generate the plot.

Returns:
figmatplotlib.figure.Figure

The figure with the information added.

makePlot(data: MutableMapping[str, ndarray[tuple[int, ...], dtype[_ScalarType_co]] | Scalar | HealSparseMap | Tensor | Mapping], tractInfo: ExplicitTractInfo, plotConfig: PerTractPropertyMapAnalysisConfig, plotInfo: Mapping[str, Mapping[str, str] | str | int]) Mapping[str, Figure]

Make the survey property map plot.

Parameters:
dataKeyedData

The HealSparseMap to plot the points from.

tractInfo: `~lsst.skymap.tractInfo.ExplicitTractInfo`

The tract info object.

plotConfig

PerTractPropertyMapAnalysisConfig The configuration for the plot.

plotInfodict

A dictionary of information about the data being plotted.

Returns:
figFigure

The resulting figure.

static prettyPrintFloat(n)