Plot a 2D hexagonally binned histogram. standard 2D histogram.
*args (y
or x
, y
) – The data passed as positional or keyword arguments. Interpreted as follows:
If only y
coordinates are passed, try to infer the x
coordinates from the Series
or DataFrame
indices or the DataArray
coordinates. Otherwise, the x
coordinates are np.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 with boxplot
, violinplot
, or when using means=True
or medians=True
).
If any arguments are pint.Quantity
, auto-add the pint unit registry to matplotlib’s unit registry using setup_matplotlib
. A pint.Quantity
embedded in an xarray.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
or Dataset
). If passed, each data argument can optionally be a string key
and the arrays used for plotting are retrieved with data[key]
. This is a native matplotlib feature.
autoformat (bool
, default: rc.autoformat
= True
) – Whether the x
axis labels, y
axis labels, axis formatters, axes titles, legend titles, and colorbar labels are automatically configured when a Series
, DataFrame
, DataArray
, or Quantity
is passed to the plotting command. Formatting of pint.Quantity
unit strings is controlled by rc.unitformat
= 'L'
.
cmap (colormap-spec
, default: rc['cmap.sequential']
= 'Fire'
or rc['cmap.diverging']
= 'BuRd'
) – The colormap specifer, passed to the Colormap
constructor function. If rc['cmap.autodiverging']
is True
and the normalization range contains negative and positive values then rc['cmap.diverging']
is used. Otherwise rc['cmap.sequential']
is used.
c, color, colors (color-spec
or sequence of color-spec
, optional) – The color(s) used to create a DiscreteColormap
. If not passed, cmap
is used.
norm (norm-spec
, default: Normalize
or DivergingNorm
) – The data value normalizer, passed to the Norm
constructor function. If discrete
is True
then 1) this affects the default level-generation algorithm (e.g. norm='log'
builds levels in log-space) and 2) this is passed to DiscreteNorm
to scale the colors before they are discretized (if norm
is not already a DiscreteNorm
). If rc['cmap.autodiverging']
is True
and the normalization range contains negative and positive values then DivergingNorm
is used. Otherwise Normalize
is used.
extend ({'neither', 'both', 'min', 'max'}
, default: 'neither'
) – Direction for drawing colorbar “extensions” indicating out-of-bounds data on the end of the colorbar.
discrete (bool
, default: rc['cmap.discrete']
= None
) – If False
, then DiscreteNorm
is not applied to the colormap. Instead, for non-contour plots, the number of levels will be roughly controlled by rc['cmap.lut']
. This has a similar effect to using levels=large_number
but it may improve rendering speed. Default is True
only for contouring commands like contourf
and pseudocolor commands like pcolor
.
sequential, diverging, cyclic, qualitative (bool
, default: None
) – Boolean arguments used if cmap
is not passed. Set these to True
to use the default rc['cmap.sequential']
, rc['cmap.diverging']
, rc['cmap.cyclic']
, and rc['cmap.qualitative']
colormaps. The diverging
option also applies DivergingNorm
as the default continuous normalizer.
vmin, vmax (float
, optional) – The minimum and maximum color scale values used with the norm
normalizer. If discrete
is False
these are the absolute limits, and if discrete
is True
these are the approximate limits used to automatically determine levels
or values
lists at “nice” intervals. If levels
or values
were already passed as lists, these are ignored, and vmin
and vmax
are set to the minimum and maximum of the lists. If robust
was passed, the default vmin
and vmax
are some percentile range of the data values. Otherwise, the default vmin
and vmax
are the minimum and maximum of the data values.
N – Shorthand for levels
.
levels (int
or sequence of float
, default: rc['cmap.levels']
= 11
) – 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 with contour
plots).
values (int
or sequence of float
, default: None
) – 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 using edges
. This will override any levels
input.
robust (bool
, float
, or 2-tuple
, default: rc['cmap.robust']
= False
) – If True
and vmin
or vmax
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.
inbounds (bool
, default: rc['cmap.inbounds']
= True
) – If True
and vmin
or vmax
were not provided, when axis limits have been explicitly restricted with set_xlim
or set_ylim
, out-of-bounds data is ignored. See also rc['cmap.inbounds']
and rc['axes.inbounds']
.
locator (locator-spec
, default: matplotlib.ticker.MaxNLocator
) – The locator used to determine level locations if levels
or values
were not already passed as lists. Passed to the Locator
constructor. Default is MaxNLocator
with levels
integer levels.
locator_kw (dict-like, optional) – Keyword arguments passed to matplotlib.ticker.Locator
class.
symmetric (bool
, default: False
) – If True
, the normalization range or discrete colormap levels are symmetric about zero.
positive (bool
, default: False
) – If True
, the normalization range or discrete colormap levels are positive with a minimum at zero.
negative (bool
, default: False
) – If True
, the normaliation range or discrete colormap levels are negative with a minimum at zero.
nozero (bool
, default: False
) – If True
, 0
is removed from the level list. This is mainly useful for single-color contour
plots.
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 by matplotlib.contour.ContourSet.legend_elements
.
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
is False
. Extra keyword args for the labels. For contour plots, this is passed to clabel
. Otherwise, this is passed to text
.
formatter, fmt (formatter-spec
, optional) – The Formatter
used to format number labels. Passed to the Formatter
constructor.
formatter_kw (dict-like, optional) – Keyword arguments passed to matplotlib.ticker.Formatter
class.
precision (int
, optional) – The maximum number of decimal places for number labels generated with the default formatter Simpleformatter
.
colorbar (bool
, int
, or str
, optional) – If not None
, this is a location specifying where to draw an inset or outer colorbar from the resulting object(s). If True
, the default rc['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 in colorbar
.
colorbar_kw (dict-like, optional) – Extra keyword args for the call to colorbar
.
legend (bool
, int
, or str
, optional) – Location specifying where to draw an inset or outer legend from the resulting object(s). If True
, the default rc['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 in legend
.
legend_kw (dict-like, optional) – Extra keyword args for the call to legend
.
**kwargs – Passed to hexbin
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4