MatrixPlot

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

Bases: PlotAction

Make the plot of a matrix (2D array).

Notes

The xAxisTickLabels and yAxisTickLabels attributes of this class serve as dictionaries to map axis tick positions to their corresponding labels. If any positions do not align with major ticks (either provided by x/yAxisTickValues or automatically set by matplotlib), they will be designated as minor ticks. Thus, these tick labels operate independently, meaning their corresponding positions do not need to match those in x/yAxisTickValues or anything else. The code automatically adjusts to handle any overlaps caused by user input and across various plotting scenarios. Note that when component1Key and component2Key are specified, the x and y tick values and labels will be dynamically configured, thereby eliminating the need for providing x/yAxisTickValues and x/yAxisTickLabels. When componentGroup1Key and componentGroup2Key are specified, the x and y axis labels are dynamically updated to include the group names, prefixed by xAxisLabel and yAxisLabel for a more descriptive labeling.

Attributes Summary

axisLabelFontSize	The font size for the axis labels.
colorbarCmap	The colormap to use for the colorbar.
colorbarLabel	The label to use for the colorbar.
colorbarLabelFontSize	The font size for the colorbar label.
colorbarTickLabelFontSize	The font size for the colorbar tick labels.
component1Key	The key to access a list of names for the first set of components in a correlation analysis.
component2Key	The key to access a list of names for the second set of components in a correlation analysis.
componentGroup1Key	The key to access a list of group names for the first set of components in a correlation analysis.
componentGroup2Key	The key to access a list of group names for the second set of components in a correlation analysis.
dpi	The resolution of the figure.
figsize	The size of the figure.
guideLines	Dictionary of guide lines for the x and y axes.
hideMajorTicks	List of axis names for which to hide the major ticks.
hideMinorTicks	List of axis names for which to hide the minor ticks.
inputDim	The dimensionality of the input data.
matrixKey	The key for the input matrix.
matrixOrigin	Determines the starting corner ('upper', 'lower') for matrix plots.
setPositionsAtPixelBoundaries	Whether to consider the positions at the pixel boundaries rather than the center of the pixel.
tickLabelsFontSize	The font size for the tick labels.
tickLabelsRotation	The rotation of the tick labels.
title	The title of the figure.
titleFontSize	The font size for the title.
vmax	The vmax value for the colorbar.
vmin	The vmin value for the colorbar.
xAxisLabel	The label to use for the x-axis.
xAxisTickLabels	Dictionary mapping x-axis tick positions to their corresponding labels.
xAxisTickValues	List of x-axis tick values.
yAxisLabel	The label to use for the y-axis.
yAxisTickLabels	Dictionary mapping y-axis tick positions to their corresponding labels.
yAxisTickValues	List of y-axis tick values.

Methods Summary

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

Attributes Documentation

axisLabelFontSize

The font size for the axis labels. (float, default 9)

colorbarCmap

The colormap to use for the colorbar. (str, default 'viridis')

Allowed values:

'magma'

magma

'inferno'

inferno

'plasma'

plasma

'viridis'

viridis

'cividis'

cividis

'twilight'

twilight

'twilight_shifted'

twilight_shifted

'turbo'

turbo

'Blues'

Blues

'BrBG'

BrBG

'BuGn'

BuGn

'BuPu'

BuPu

'CMRmap'

CMRmap

'GnBu'

GnBu

'Greens'

Greens

'Greys'

Greys

'OrRd'

OrRd

'Oranges'

Oranges

'PRGn'

PRGn

'PiYG'

PiYG

'PuBu'

PuBu

'PuBuGn'

PuBuGn

'PuOr'

PuOr

'PuRd'

PuRd

'Purples'

Purples

'RdBu'

RdBu

'RdGy'

RdGy

'RdPu'

RdPu

'RdYlBu'

RdYlBu

'RdYlGn'

RdYlGn

'Reds'

Reds

'Spectral'

Spectral

'Wistia'

Wistia

'YlGn'

YlGn

'YlGnBu'

YlGnBu

'YlOrBr'

YlOrBr

'YlOrRd'

YlOrRd

'afmhot'

afmhot

'autumn'

autumn

'binary'

binary

'bone'

bone

'brg'

brg

'bwr'

bwr

'cool'

cool

'coolwarm'

coolwarm

'copper'

copper

'cubehelix'

cubehelix

'flag'

flag

'gist_earth'

gist_earth

'gist_gray'

gist_gray

'gist_heat'

gist_heat

'gist_ncar'

gist_ncar

'gist_rainbow'

gist_rainbow

'gist_stern'

gist_stern

'gist_yarg'

gist_yarg

'gnuplot'

gnuplot

'gnuplot2'

gnuplot2

'gray'

gray

'hot'

hot

'hsv'

hsv

'jet'

jet

'nipy_spectral'

nipy_spectral

'ocean'

ocean

'pink'

pink

'prism'

prism

'rainbow'

rainbow

'seismic'

seismic

'spring'

spring

'summer'

summer

'terrain'

terrain

'winter'

winter

'Accent'

Accent

'Dark2'

Dark2

'Paired'

Paired

'Pastel1'

Pastel1

'Pastel2'

Pastel2

'Set1'

Set1

'Set2'

Set2

'Set3'

Set3

'tab10'

tab10

'tab20'

tab20

'tab20b'

tab20b

'tab20c'

tab20c

'grey'

grey

'gist_grey'

gist_grey

'gist_yerg'

gist_yerg

'Grays'

Grays

'magma_r'

magma_r

'inferno_r'

inferno_r

'plasma_r'

plasma_r

'viridis_r'

viridis_r

'cividis_r'

cividis_r

'twilight_r'

twilight_r

'twilight_shifted_r'

twilight_shifted_r

'turbo_r'

turbo_r

'Blues_r'

Blues_r

'BrBG_r'

BrBG_r

'BuGn_r'

BuGn_r

'BuPu_r'

BuPu_r

'CMRmap_r'

CMRmap_r

'GnBu_r'

GnBu_r

'Greens_r'

Greens_r

'Greys_r'

Greys_r

'OrRd_r'

OrRd_r

'Oranges_r'

Oranges_r

'PRGn_r'

PRGn_r

'PiYG_r'

PiYG_r

'PuBu_r'

PuBu_r

'PuBuGn_r'

PuBuGn_r

'PuOr_r'

PuOr_r

'PuRd_r'

PuRd_r

'Purples_r'

Purples_r

'RdBu_r'

RdBu_r

'RdGy_r'

RdGy_r

'RdPu_r'

RdPu_r

'RdYlBu_r'

RdYlBu_r

'RdYlGn_r'

RdYlGn_r

'Reds_r'

Reds_r

'Spectral_r'

Spectral_r

'Wistia_r'

Wistia_r

'YlGn_r'

YlGn_r

'YlGnBu_r'

YlGnBu_r

'YlOrBr_r'

YlOrBr_r

'YlOrRd_r'

YlOrRd_r

'afmhot_r'

afmhot_r

'autumn_r'

autumn_r

'binary_r'

binary_r

'bone_r'

bone_r

'brg_r'

brg_r

'bwr_r'

bwr_r

'cool_r'

cool_r

'coolwarm_r'

coolwarm_r

'copper_r'

copper_r

'cubehelix_r'

cubehelix_r

'flag_r'

flag_r

'gist_earth_r'

gist_earth_r

'gist_gray_r'

gist_gray_r

'gist_heat_r'

gist_heat_r

'gist_ncar_r'

gist_ncar_r

'gist_rainbow_r'

gist_rainbow_r

'gist_stern_r'

gist_stern_r

'gist_yarg_r'

gist_yarg_r

'gnuplot_r'

gnuplot_r

'gnuplot2_r'

gnuplot2_r

'gray_r'

gray_r

'hot_r'

hot_r

'hsv_r'

hsv_r

'jet_r'

jet_r

'nipy_spectral_r'

nipy_spectral_r

'ocean_r'

ocean_r

'pink_r'

pink_r

'prism_r'

prism_r

'rainbow_r'

rainbow_r

'seismic_r'

seismic_r

'spring_r'

spring_r

'summer_r'

summer_r

'terrain_r'

terrain_r

'winter_r'

winter_r

'Accent_r'

Accent_r

'Dark2_r'

Dark2_r

'Paired_r'

Paired_r

'Pastel1_r'

Pastel1_r

'Pastel2_r'

Pastel2_r

'Set1_r'

Set1_r

'Set2_r'

Set2_r

'Set3_r'

Set3_r

'tab10_r'

tab10_r

'tab20_r'

tab20_r

'tab20b_r'

tab20b_r

'tab20c_r'

tab20c_r

'None'

Field is optional

colorbarLabel

The label to use for the colorbar. (str, default '')

colorbarLabelFontSize

The font size for the colorbar label. (float, default 10)

colorbarTickLabelFontSize

The font size for the colorbar tick labels. (float, default 8)

component1Key

The key to access a list of names for the first set of components in a correlation analysis. This will be used to determine x-axis tick values and tick labels. (str, default None)

component2Key

The key to access a list of names for the second set of components in a correlation analysis. This will be used to determine y-axis tick values and tick labels. (str)

componentGroup1Key

The key to access a list of group names for the first set of components in a correlation analysis. This will be used to determine the x-axis label. (str, default None)

componentGroup2Key

The key to access a list of group names for the second set of components in a correlation analysis. This will be used to determine the y-axis label. (str, default None)

dpi

The resolution of the figure. (int, default 300)

figsize

The size of the figure. (List, default [5, 5])

guideLines

Dictionary of guide lines for the x and y axes. The keys are ‘x’ and ‘y’, and the values are instances of GuideLinesConfig. (ConfigDict, default {})

hideMajorTicks

List of axis names for which to hide the major ticks. The options to include in the list are ‘x’ and ‘y’. This does not affect the visibility of major tick ‘labels’. For example, setting this field to [‘x’, ‘y’] will hide both major ticks. (List, default [])

hideMinorTicks

List of axis names for which to hide the minor ticks. The options to include in the list are ‘x’ and ‘y’. This does not affect the visibility of minor tick labels. For example, setting this field to [‘x’, ‘y’] will hide both minor ticks. (List, default [])

inputDim

The dimensionality of the input data. (int, default 1)

Allowed values:

'1'

1D inputs are automatically reshaped into square 2D matrices.

'2'

2D inputs are directly utilized as is.

'None'

Field is optional

matrixKey

The key for the input matrix. (str, default 'matrix')

matrixOrigin

Determines the starting corner (‘upper’, ‘lower’) for matrix plots. It only affects the visual appearance of the plot. (str, default 'upper')

Allowed values:

'upper'

The origin is at the upper left corner.

'lower'

The origin is at the lower left corner.

'None'

Field is optional

setPositionsAtPixelBoundaries

Whether to consider the positions at the pixel boundaries rather than the center of the pixel. (bool, default False)

tickLabelsFontSize

The font size for the tick labels. (float, default 8)

tickLabelsRotation

The rotation of the tick labels. (float, default 0)

title

The title of the figure. (str, default '')

titleFontSize

The font size for the title. (float, default 10)

vmax

The vmax value for the colorbar. (float, default None)

vmin

The vmin value for the colorbar. (float, default None)

xAxisLabel

The label to use for the x-axis. (str, default '')

xAxisTickLabels

Dictionary mapping x-axis tick positions to their corresponding labels. For behavior details, refer to the ‘Notes’ section of the class docstring. (Dict, default None)

xAxisTickValues

List of x-axis tick values. If not set, the ticks will be set automatically by matplotlib. (List, default None)

yAxisLabel

The label to use for the y-axis. (str, default '')

yAxisTickLabels

Dictionary mapping y-axis tick positions to their corresponding labels. For behavior details, refer to the ‘Notes’ section of the class docstring. (Dict, default None)

yAxisTickValues

List of y-axis tick values. If not set, the ticks will be set automatically by matplotlib. (List, default None)

Methods Documentation

__call__(data: KeyedData, **kwargs) → Figure

Call self as a function.

getInputSchema() → KeyedDataSchema

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: KeyedData, plotInfo: Mapping[str, str] | None = None, **kwargs: Any) → Figure

Plot a matrix of values.

Parameters:

dataKeyedData

The data to plot.

plotInfodict, optional

A dictionary of information about the data being plotted.

**kwargs

Additional keyword arguments to pass to the plot.

Returns:

figFigure

The resulting figure.