pygmt.Figure.histogram¶
-
Figure.histogram(table, *, horizontal=None, frame=None, cmap=None, annotate=None, barwidth=None, center=None, fill=None, projection=None, extreme=None, distribution=None, cumulative=None, region=None, stairs=None, series=None, timestamp=None, verbose=None, pen=None, xshift=None, yshift=None, histtype=None, panel=None, label=None, perspective=None, transparency=None, **kwargs)¶ Plots a histogram, and can read data from a file or list, array, or dataframe.
Full option list at https://docs.generic-mapping-tools.org/latest/histogram.html
Aliases:
A = horizontal
B = frame
C = cmap
D = annotate
E = barwidth
F = center
G = fill
J = projection
L = extreme
N = distribution
Q = cumulative
R = region
S = stairs
T = series
U = timestamp
V = verbose
W = pen
X = xshift
Y = yshift
Z = histtype
c = panel
l = label
p = perspective
t = transparency
- Parameters
table (str or list or numpy.ndarray or pandas.DataFrame or xarray.Dataset or geopandas.GeoDataFrame) – Pass in either a file name to an ASCII data table, a Python list, a 2D
numpy.ndarray, apandas.DataFrame, anxarray.Datasetmade up of 1Dxarray.DataArraydata variables, or ageopandas.GeoDataFramecontaining the tabular data.projection (str) – Required if this is the first plot command. projcode[projparams/]width. Select map projection.
region (str or list) – Required if this is the first plot command. xmin/xmax/ymin/ymax[+r][+uunit]. Specify the region of interest.
frame (bool or str or list) – Set map boundary frame and axes attributes.
cmap (str) – File name of a CPT file or a series of comma-separated colors (e.g., color1,color2,color3) to build a linear continuous CPT from those colors automatically.
color (str or 1d array) – Select color or pattern for filling of symbols or polygons. Default is no fill.
pen (str) – Set pen attributes for lines or the outline of symbols.
panel (bool or int or list) – [row,col|index]. Selects a specific subplot panel. Only allowed when in subplot mode. Use
panel=Trueto advance to the next panel in the selected order. Instead of row,col you may also give a scalar value index which depends on the order you set viaautolabelwhen the subplot was defined. Note: row, col, and index all start at 0.annotate (bool or str) – [+b][+ffont][+ooff][+r]. Annotate each bar with the count it represents. Append any of the following modifiers: Use +b to place the labels beneath the bars instead of above; use +f to change to another font than the default annotation font; use +o to change the offset between bar and label [6p]; use +r to rotate the labels from horizontal to vertical.
barwidth (int or float or str) – width[+ooffset]. Use an alternative histogram bar width than the default set via
series, and optionally shift all bars by an offset. Here width is either an alternative width in data units, or the user may append a valid plot dimension unit (c|i|p) for a fixed dimension instead. Optionally, all bins may be shifted along the axis by offset. As for width, it may be given in data units of plot dimension units by appending the relevant unit.center (bool) – Center bin on each value. [Default is left edge].
distribution (bool or int or float or str) –
[mode][+ppen]. Draw the equivalent normal distribution; append desired pen [Default is 0.25p,black]. The mode selects which central location and scale to use:
0 = mean and standard deviation [Default];
1 = median and L1 scale (1.4826 * median absolute deviation; MAD);
2 = LMS (least median of squares) mode and scale.
cumulative (bool or str) – [r]. Draw a cumulative histogram by passing
True. Use r to display a reverse cumulative histogram.extreme (str) – l|h|b. The modifiers specify the handling of extreme values that fall outside the range set by
series. By default these values are ignored. Append b to let these values be included in the first or last bins. To only include extreme values below first bin into the first bin, use l, and to only include extreme values above the last bin into that last bin, use h.stairs (bool) – Draws a stairs-step diagram which does not include the internal bars of the default histogram.
horizontal (bool) – Plot the histogram using horizonal bars instead of the default vertical bars.
series (int or str or list) – [min/max/]inc[+n]. Set the interval for the width of each bar in the histogram.
[type][+w]. Choose between 6 types of histograms:
0 = counts [Default]
1 = frequency_percent
2 = log (1.0 + count)
3 = log (1.0 + frequency_percent)
4 = log10 (1.0 + count)
5 = log10 (1.0 + frequency_percent).
To use weights provided as a second data column instead of pure counts, append +w.
xshift (str) – [a|c|f|r][xshift]. Shift plot origin in x-direction.
yshift (str) – [a|c|f|r][yshift]. Shift plot origin in y-direction. Full documentation is at https://docs.generic-mapping-tools.org/latest/gmt.html#xy-full.
Select verbosity level [Default is w], which modulates the messages written to stderr. Choose among 7 levels of verbosity:
q - Quiet, not even fatal error messages are produced
e - Error messages only
w - Warnings [Default]
t - Timings (report runtimes for time-intensive algorithms);
i - Informational messages (same as
verbose=True)c - Compatibility warnings
d - Debugging messages
label (str) – Add a legend entry for the symbol or line being plotted.
perspective (list or str) – [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]. Select perspective view and set the azimuth and elevation angle of the viewpoint. Default is [180, 90]. Full documentation is at https://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full.
transparency (int or float) – Set transparency level, in [0-100] percent range. Default is 0, i.e., opaque. Only visible when PDF or raster format output is selected. Only the PNG format selection adds a transparency layer in the image (for further processing).
