PlotAxes.hexbin¶
- PlotAxes.hexbin(x, y, weights, **kwargs)[source]¶
Plot a 2D hexagonally binned histogram.
- Parameters
*args (
y
orx
,y
) – The data passed as positional or keyword arguments. Interpreted as follows:If only
y
coordinates are passed, try to infer thex
coordinates from theSeries
orDataFrame
indices or theDataArray
coordinates. Otherwise, thex
coordinates arenp.arange(0, y.shape[0])
.If the
y
coordinates are a 2D array, plot each column of data in succession (except where each column of data represents a statistical distribution, as withboxplot
,violinplot
, or when usingmeans=True
ormedians=True
).If any arguments are
pint.Quantity
, auto-add the pint unit registry to matplotlib’s unit registry usingsetup_matplotlib
. Apint.Quantity
embedded in anxarray.DataArray
is also supported.
weights (array-like, optional) – The weights associated with each point. If string this can be retrieved from
data
(see below).data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataArray
). If passed, positional arguments can optionally be stringdata
keys 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
.
- Other Parameters
cmap (
colormap spec
, optional) – The colormap specifer, passed to theColormap
constructor function.norm (
normalizer spec
, optional) – The continuous colormap normalizer, passed to theNorm
constructor function. Ifdiscrete
isTrue
this is also used to normalize values passed toDiscreteNorm
before colors is selected.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 isFalse
forimshow
,matshow
,spy
,hexbin
,hist2d
, andheatmap
plots, butTrue
otherwise.sequential (
bool
, optional) – Userc['cmap.sequential']
='fire'
as the default colormap.diverging (
bool
, optional) – Userc['cmap.diverging']
='negpos'
as the default colormap and useDivergingNorm
as the default continuous normalizer. This will also ensure auto-generated levels include a value at zero.cyclic (
bool
, optional) – Userc['cmap.cyclic']
='twilight'
as the default colormap and modify the default arguments passed toDiscreteNorm
so that colors on either end are distinct.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. The latter three options also change level- and norm-generation behavior.extend (
{{'neither', 'min', 'max', 'both'}}
, optional) – Whether to assign unique colors to out-of-bounds data and draw colorbar “extensions” when a colorbar is drawn.N – Shorthand for
levels
.levels (
int
orlist
offloat
, optional) – The number of level edges or a list 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 that decreasing levels will only work withpcolor
plots, notcontour
plots). Default isrc['cmap.levels']
=11
.values (
int
orlist
offloat
, optional) – The number of level centers or a list 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) – Used to determine level locations iflevels
orvalues
is an integer. Actual levels may not fall exactly onvmin
andvmax
, but the minimum level will be no smaller thanvmin
and the maximum level will be no larger thanvmax
. Ifvmin
orvmax
are not provided, the minimum and maximum data values are used.labels (
bool
, optional) – Whether to apply labels to contours and grid boxes. The text will be white when the luminance of the underlying filled contour or grid box is less than 50 and black otherwise.labels_kw (dict-like, optional) – Ignored if
labels
isFalse
. Extra keyword args for the labels. For contour plots, this is passed toclabel
. Otherwise, this is passed totext
.fmt (
format-spec
, optional) – Passed to theNorm
constructor, used to format number labels. You can also use theprecision
keyword arg.precision (
int
, optional) – Maximum number of decimal places for the number labels. Number labels are generated with theSimpleFormatter
formatter, which permits limiting the precision.label (
str
, optional) – The legend label to be used for this object. In the case of contours, this is paired with the the central artist in the artist list returned bymatplotlib.contour.ContourSet.legend_elements
.colorbar (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or panel colorbar from the resulting object(s). IfTrue
, the defaultrc['colorbar.loc']
='right'
is used. Valid locations are described incolorbar
.colorbar_kw (dict-like, optional) – Extra keyword args for the call to
colorbar
.legend (
bool
,int
, orstr
, optional) – If notNone
, this is a location specifying where to draw an inset or panel legend from the resulting object(s). IfTrue
, the defaultrc['legend.loc']
='best'
is used. Valid locations are described inlegend
.legend_kw (dict-like, optional) – Extra keyword args for the call to
legend
.**kwargs – Passed to
hexbin
.
See also