PlotAxes.spy¶
- PlotAxes.spy(z, **kwargs)[source]¶
Plot a sparcity pattern.
- Parameters
z (array-like) – The data passed as a positional argument or keyword argument.
data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataset
). If passed, each data argument can optionally be a stringkey
and the arrays used for plotting are retrieved withdata[key]
. This is a native matplotlib feature.autoformat (
bool
, optional) – Whether thex
axis labels,y
axis labels, axis formatters, axes titles, legend titles, and colorbar labels are automatically configured when aSeries
,DataFrame
,DataArray
, orQuantity
is passed to the plotting command. Default isrc.autoformat
=True
. Formatting ofpint.Quantity
unit strings is controlled byrc.unitformat
='L'
.
- Other Parameters
cmap (
colormap-spec
, optional) – The colormap specifer, passed to theColormap
constructor function.c, color, colors (
color-spec
or sequence ofcolor-spec
, optional) – The color(s) used to create aDiscreteColormap
. If not passed,cmap
is used.norm (
norm-spec
, optional) – The data value normalizer, passed to theNorm
constructor function. Ifdiscrete
isTrue
then 1) this affects the default level-generation algorithm (e.g.norm='log'
builds levels in log-space) and 2) this is passed toDiscreteNorm
to scale the colors before they are discretized (ifnorm
is not already aDiscreteNorm
).extend (
{'neither', 'both', 'min', 'max'}
, optional) – Direction for drawing colorbar “extensions” (i.e. color keys for out-of-bounds data on the end of the colorbar). Default is'neither'
.discrete (
bool
, optional) – IfFalse
, thenDiscreteNorm
is not applied to the colormap. Instead, for non-contour plots, the number of levels will be roughly controlled byrc['cmap.lut']
. This has a similar effect to usinglevels=large_number
but it may improve rendering speed. Default isTrue
for only contour-plotting commands likecontourf
and pseudocolor-plotting commands likepcolor
.sequential, diverging, cyclic, qualitative (
bool
, optional) – Boolean arguments used ifcmap
is not passed. Set these toTrue
to use the defaultrc['cmap.sequential']
,rc['cmap.diverging']
,rc['cmap.cyclic']
, andrc['cmap.qualitative']
colormaps. Thediverging
option also appliesDivergingNorm
as the default continuous normalizer.N – Shorthand for
levels
.levels (
int
or sequence offloat
, optional) – The number of level edges or a sequence of level edges. If the former,locator
is used to generate this many level edges at “nice” intervals. If the latter, the levels should be monotonically increasing or decreasing (note decreasing levels fail withcontour
plots). Default isrc['cmap.levels']
=11
.values (
int
or sequence offloat
, optional) – The number of level centers or a sequence of level centers. If the former,locator
is used to generate this many level centers at “nice” intervals. If the latter, levels are inferred usingedges
. This will override anylevels
input.vmin, vmax (
float
, optional) – The minimum and maximum color scale values used with thenorm
normalizer. Ifdiscrete
isFalse
these are the absolute limits, and ifdiscrete
isTrue
these are the approximate limits used to automatically determinelevels
orvalues
lists at “nice” intervals. Iflevels
orvalues
were already passed as lists, the defaultvmin
andvmax
are the minimum and maximum of the lists. Ifrobust
was passed, the defaultvmin
andvmax
are some percentile range of the data values. Otherwise, the defaultvmin
andvmax
are the minimum and maximum of the data values.robust (
bool
,float
, or2-tuple
, optional) – IfTrue
andvmin
orvmax
were not provided, they are determined from the 2nd and 98th data percentiles rather than the minimum and maximum. If float, this percentile range is used (for example,90
corresponds to the 5th to 95th percentiles). If 2-tuple of float, these specific percentiles should be used. This feature is useful when your data has large outliers. Default isrc['cmap.robust']
=False
.inbounds (
bool
, optional) – IfTrue
andvmin
orvmax
were not provided, when axis limits have been explicitly restricted withset_xlim
orset_ylim
, out-of-bounds data is ignored. Default isrc['cmap.inbounds']
=True
. See alsorc['axes.inbounds']
.locator (
locator-spec
, optional) – The locator used to determine level locations iflevels
orvalues
were not already passed as lists. Passed to theLocator
constructor. Default isMaxNLocator
withlevels
integer levels.locator_kw (dict-like, optional) – Keyword arguments passed to
matplotlib.ticker.Locator
class.symmetric (
bool
, optional) – IfTrue
, automatically generated levels are symmetric about zero. Default is alwaysFalse
.positive (
bool
, optional) – IfTrue
, automatically generated levels are positive with a minimum at zero. Default is alwaysFalse
.negative (
bool
, optional) – IfTrue
, automatically generated levels are negative with a maximum at zero. Default is alwaysFalse
.nozero (
bool
, optional) – IfTrue
,0
is removed from the level list. This is mainly useful for single-colorcontour
plots.colorbar (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or outer colorbar from the resulting object(s). IfTrue
, the defaultrc['colorbar.loc']
='right'
is used. If the same location is used in successive plotting calls, object(s) will be added to the existing colorbar in that location (valid for colorbars built from lists of artists). Valid locations are shown in incolorbar
.colorbar_kw (dict-like, optional) – Extra keyword args for the call to
colorbar
.legend (
bool
,int
, orstr
, optional) – Location specifying where to draw an inset or outer legend from the resulting object(s). IfTrue
, the defaultrc['legend.loc']
='best'
is used. If the same location is used in successive plotting calls, object(s) will be added to existing legend in that location. Valid locations are shown inlegend
.legend_kw (dict-like, optional) – Extra keyword args for the call to
legend
.**kwargs – Passed to
matplotlib.axes.Axes.spy
.