FocalPlanePlot¶
- class lsst.analysis.tools.actions.plot.FocalPlanePlot(*args, **kw)¶
Bases:
PlotAction
Plots the focal plane distribution of a parameter.
Given the detector positions in x and y, the focal plane positions are calculated using the camera model. A 2d binned statistic (default is mean) is then calculated and plotted for the parameter z as a function of the focal plane coordinates.
Attributes Summary
Add a histogram of all input points (
bool
, defaultFalse
)If set to True, the number of bins is adapted to the source density, with lower densities using fewer bins.
Number of bins to use in histogram (
int
, default30
)Number of bins to use within the effective plot ranges along the spatial directions.
Maximum in z-value to display in the focal plane plot and in the histogram plot, if applicable (
float
, defaultNone
)Minimum in z-value to display in the focal plane plot and in the histogram plot, if applicable (
float
, defaultNone
)Show statistics for plotted data (
bool
, defaultTrue
)Operation to perform in binned_statistic_2d (
str
, default'mean'
)Label to use for the x axis.
Label to use for the y axis.
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, camera[, plotInfo])Prep the catalogue and then make a focalPlanePlot of the given column.
statsAndText
(arr[, mask])Calculate some stats from an array and return them and some text.
Attributes Documentation
- doUseAdaptiveBinning¶
If set to True, the number of bins is adapted to the source density, with lower densities using fewer bins. Under these circumstances the nBins parameter sets the minimum number of bins. (
bool
, defaultFalse
)
- nBins¶
Number of bins to use within the effective plot ranges along the spatial directions. (
int
, default200
)
- plotMax¶
Maximum in z-value to display in the focal plane plot and in the histogram plot, if applicable (
float
, defaultNone
)
- plotMin¶
Minimum in z-value to display in the focal plane plot and in the histogram plot, if applicable (
float
, defaultNone
)
Methods Documentation
- __call__(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap | Tensor], **kwargs) Mapping[str, Figure] | Figure ¶
Call self as a function.
- getInputSchema(**kwargs) Tensor]]] ¶
Return the schema an
AnalysisAction
expects to be present in the arguments supplied to the __call__ method.- Returns:
- result
KeyedDataSchema
The schema this action requires to be present when calling this action, keys are unformatted.
- result
- makePlot(data: MutableMapping[str, ndarray[Any, dtype[ScalarType]] | Scalar | HealSparseMap | Tensor], camera: Camera, plotInfo: Mapping[str, str] | None = None, **kwargs) Figure ¶
Prep the catalogue and then make a focalPlanePlot of the given column.
Uses the axisLabels config options
x
andy
to make an image, where the color corresponds to the 2d binned statistic (the mean is the default) applied to thez
column. A summary panel is shown in the upper right corner of the resultant plot. The code uses the selectorActions to decide which points to plot and the statisticSelector actions to determine which points to use for the printed statistics.- Parameters:
- data
pandas.core.frame.DataFrame
The catalog to plot the points from.
- camera
lsst.afw.cameraGeom.Camera
The camera used to map from pixel to focal plane positions.
- plotInfo
dict
A dictionary of information about the data being plotted with keys:
- data
- Returns:
- fig
matplotlib.figure.Figure
The resulting figure.
- fig
- statsAndText(arr, mask=None)¶
Calculate some stats from an array and return them and some text.