PropertyMapPlot

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

Bases: PlotAction

Attributes Summary

plotName

The name for the plotting task.

Methods Summary

__call__(data, tractInfo, plotConfig, ...)	Call self as a function.
addPlotInfo(fig, plotInfo, mapName)	Add useful information to the plot.
getOutputNames([config])	Returns a list of names that will be used as keys if this action's call method returns a mapping.
makePlot(data, tractInfo, plotConfig, plotInfo)	Make the survey property map plot.
prettyPrintFloat(n)

Attributes Documentation

plotName

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

Methods Documentation

__call__(data: MutableMapping[str, ndarray[Any, dtype[_ScalarType_co]] | Scalar | HealSparseMap | Tensor | Mapping], tractInfo: ExplicitTractInfo, plotConfig: PropertyMapTractAnalysisConfig, 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], mapName: Mapping[str, 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.

mapNamestr

The name of the map being plotted.

Returns:

figmatplotlib.figure.Figure

The figure with the information added.

getOutputNames(config=None) → Iterable[str]

Returns a list of names that will be used as keys if this action’s call method returns a mapping. Otherwise return an empty Iterable.

Parameters:

configlsst.pex.config.Config, optional

Configuration of the task. This is only used if the output naming needs to be config-aware.

Returns:

resultIterable of str

If a PlotAction produces more than one plot, this should be the keys the action will use in the returned Mapping.

makePlot(data: MutableMapping[str, ndarray[Any, dtype[_ScalarType_co]] | Scalar | HealSparseMap | Tensor | Mapping], tractInfo: ExplicitTractInfo, plotConfig: PropertyMapTractAnalysisConfig, 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

PropertyMapTractAnalysisConfig The configuration for the plot.

plotInfodict

A dictionary of information about the data being plotted.

Returns:

figDictdict [Figure]

The resulting figures.

static prettyPrintFloat(n)