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

applyContext	Apply a Context to an AnalysisAction recursively.
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.
history
identity	If a configurable action is assigned to a ConfigurableActionField, or a ConfigurableActionStructField the name of the field will be bound to this variable when it is retrieved.
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.
addInputSchema(inputSchema)	Add the supplied inputSchema argument to the class such that it will be returned along side any other arguments in a call to getInputSchema.
compare(other[, shortcut, rtol, atol, output])	Compare this configuration to another Config for equality.
formatHistory(name, **kwargs)	Format a configuration field's history to a human-readable format.
freeze()	Make this config, and all subconfigs, read-only.
getFormattedInputSchema(**kwargs)	Return input schema, with keys formatted with any arguments supplied by kwargs passed to this method.
getInputSchema()	Return the schema an AnalysisAction expects to be present in the arguments supplied to the __call__ method.
getOutputNames([config])	Returns a list of names that will be used as keys if this action's call method returns a mapping.
getOutputSchema()	Return the schema an AnalysisAction will produce, if the __call__ method returns KeyedData, otherwise this may return None.
getPlotType()
items()	Get configurations as (field name, field value) pairs.
keys()	Get field names.
load(filename[, root])	Modify this config in place by executing the Python code in a configuration file.
loadFromStream(stream[, root, filename, ...])	Modify this Config in place by executing the Python code in the provided stream.
loadFromString(code[, root, filename, ...])	Modify this Config in place by executing the Python code in the provided string.
makePlot(data[, plotInfo])	Plot a matrix of values.
names()	Get all the field names in the config, recursively.
save(filename[, root])	Save a Python script to the named file, which, when loaded, reproduces this config.
saveToStream(outfile[, root, skipImports])	Save a configuration file to a stream, which, when loaded, reproduces this config.
saveToString([skipImports])	Return the Python script form of this configuration as an executable string.
setDefaults()	Subclass hook for computing defaults.
toDict()	Make a dictionary of field names and their values.
update(**kw)	Update values of fields specified by the keyword arguments.
validate()	Validate the Config, raising an exception if invalid.
values()	Get field values.

Attributes Documentation

applyContext

Apply a Context to an AnalysisAction recursively.

Generally this method is called from within an AnalysisTool to configure all AnalysisActions at one time to make sure that they all are consistently configured. However, it is permitted to call this method if you are aware of the effects, or from within a specific execution environment like a python shell or notebook.

Parameters:

contextContext

The specific execution context, this may be a single context or a joint context, see Context for more info.

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 [])

history

Read-only history.

identity: str | None = None

If a configurable action is assigned to a ConfigurableActionField, or a ConfigurableActionStructField the name of the field will be bound to this variable when it is retrieved.

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.

addInputSchema(inputSchema: Tensor]]]) → None

Add the supplied inputSchema argument to the class such that it will be returned along side any other arguments in a call to getInputSchema.

Parameters:

inputSchemaKeyedDataSchema

A schema that is to be merged in with any existing schema when a call to getInputSchema is made.

compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)

Compare this configuration to another Config for equality.

Parameters:

otherlsst.pex.config.Config

Other Config object to compare against this config.

shortcutbool, optional

If True, return as soon as an inequality is found. Default is True.

rtolfloat, optional

Relative tolerance for floating point comparisons.

atolfloat, optional

Absolute tolerance for floating point comparisons.

outputcallable, optional

A callable that takes a string, used (possibly repeatedly) to report inequalities.

Returns:

isEqualbool

True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

See also

lsst.pex.config.compareConfigs

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField fields are not considered by this method.

Floating point comparisons are performed by numpy.allclose.

formatHistory(name, **kwargs)

Format a configuration field’s history to a human-readable format.

Parameters:

namestr

Name of a Field in this config.

**kwargs

Keyword arguments passed to lsst.pex.config.history.format.

Returns:

historystr

A string containing the formatted history.

See also

lsst.pex.config.history.format

freeze()

Make this config, and all subconfigs, read-only.

getFormattedInputSchema(**kwargs) → Tensor]]]

Return input schema, with keys formatted with any arguments supplied by kwargs passed to this method.

Returns:

resultKeyedDataSchema

The schema this action requires to be present when calling this action, formatted with any input arguments (e.g. band=’i’)

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.

getOutputNames(config: Config | None = 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.

getOutputSchema() → Tensor]]] | None

Return the schema an AnalysisAction will produce, if the __call__ method returns KeyedData, otherwise this may return None.

Returns:

resultKeyedDataSchema or None

The schema this action will produce when returning from call. This will be unformatted if any templates are present. Should return None if action does not return KeyedData.

getPlotType() → str

items()

Get configurations as (field name, field value) pairs.

Returns:

itemsItemsView

Iterator of tuples for each configuration. Tuple items are:

0. Field name.

1. Field value.

keys()

Get field names.

Returns:

namesKeysView

List of lsst.pex.config.Field names.

load(filename, root='config')

Modify this config in place by executing the Python code in a configuration file.

Parameters:

filenamestr

Name of the configuration file. A configuration file is Python module.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

See also

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

loadFromStream(stream, root='config', filename=None, extraLocals=None)

Modify this Config in place by executing the Python code in the provided stream.

Parameters:

streamfile-like object, str, bytes, or CodeType

Stream containing configuration override code. If this is a code object, it should be compiled with mode="exec".

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

extraLocalsdict of str to object, optional

Any extra variables to include in local scope when loading.

See also

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromString

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

Notes

For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use loadFromString instead for most of these types.

loadFromString(code, root='config', filename=None, extraLocals=None)

Modify this Config in place by executing the Python code in the provided string.

Parameters:

codestr, bytes, or CodeType

Stream containing configuration override code.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

extraLocalsdict of str to object, optional

Any extra variables to include in local scope when loading.

Raises:

ValueError

Raised if a key in extraLocals is the same value as the value of the root argument.

See also

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

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.

names()

Get all the field names in the config, recursively.

Returns:

nameslist of str

Field names.

save(filename, root='config')

Save a Python script to the named file, which, when loaded, reproduces this config.

Parameters:

filenamestr

Desination filename of this configuration.

rootstr, optional

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

See also

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.saveToString

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

saveToStream(outfile, root='config', skipImports=False)

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters:

outfilefile-like object

Destination file object write the config into. Accepts strings not bytes.

rootstr, optional

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

skipImportsbool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

See also

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToString

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

saveToString(skipImports=False)

Return the Python script form of this configuration as an executable string.

Parameters:

skipImportsbool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

Returns:

codestr

A code string readable by loadFromString.

See also

lsst.pex.config.Config.save

lsst.pex.config.Config.saveToStream

lsst.pex.config.Config.load

lsst.pex.config.Config.loadFromStream

lsst.pex.config.Config.loadFromString

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

toDict()

Make a dictionary of field names and their values.

Returns:

dict_dict

Dictionary with keys that are Field names. Values are Field values.

See also

lsst.pex.config.Field.toDict

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict method for this method to work.

update(**kw)

Update values of fields specified by the keyword arguments.

Parameters:

**kw

Keywords are configuration field names. Values are configuration field values.

Notes

The __at and __label keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert a Config instance’s history.

Examples

This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update fieldA and fieldC:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'

validate()

Validate the Config, raising an exception if invalid.

Raises:

lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.

values()

Get field values.

Returns:

valuesValuesView

Iterator of field values.