pygmt.Figure.histogram

Figure.histogram(table, **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

  • N = normal

  • Q = cumulative

  • R = region

  • S = step

  • T = series

  • W = pen

  • X = xshift

  • Y = yshift

  • Z = type

  • c = panel

  • l = label

  • p = perspective

Parameters

  • table (str, list, or 1d array) – A data file name, list, or 1d numpy array. This is a required argument.

  • 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) – 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=True to 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 via autolabel when 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 -T, 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].

  • normal (bool or int or float or str) –

    [mode][+ppen] Draw the equivalent normal distribution; append desired pen [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.

    The -N option may be repeated to draw several of these curves. Note: If -w is used then only mode = 0 is available and we will determine the parameters of the circular von Mises distribution instead.

  • cumulative (bool or str) – [r] Draw a cumulative histogram. Append r to instead compute the reverse cumulative histogram.

  • step (bool) – Draws a stairs-step diagram which does not include the internal bars of the default histogram.

  • 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.

  • 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.

  • 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.

  • type (int or str) –

    [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.