Hist2d

class atompy.Hist2d(values, xedges, yedges, title='', xlabel='', ylabel='', zlabel='')

A histogram class providing basic 2D-histogram methods.

Parameters:

valuesarray_like, shape (m, n)

The values of the histogram given as a 2D-array, where values[m, n] corresponds to the bin whose edges are given by [xedges[m], xedges[m+1]] and [yedges[n], yedges[n+1]].

xedgesarray_like, shape (m+1,)

The x-edges of the histogram.

yedgesarray_like, shape (n+1,)

The y-edges of the histogram.

titlestr, default “”

Optional title of the histogram.

May be used in plot().

xlabelstr, default “”

Optional xlabel of the histogram.

May be used in plot().

ylabelstr, default “”

Optional ylabel of the histogram.

May be used in plot().

zlabelstr, default “”

Optional zlabel of the histogram.

May be used in plot().

Attributes:

valuesndarray, shape(m, n)

The histogram values.

Hndarray, shape(m, n)

Alias for Hist2d.values

xedgesndarray, shape(m+1,)

The histogram x-edges.

yedgesndarray, shape(n+1,)

The histogram y-edges.

xcentersndarray, shape(m,)

The centers of the histogram x-edges.

ycentersndarray, shape(n,)

The centers of the histogram y-edges.

xbinsint

The number of x bins.

ybinsint

The number of y bins.

nbins(int, int)

(nxbins, nybins)

xlim(float, float)

The x-range of the histogram.

ylim(float, float)

The y-range of the histogram.

limits((float, float), (float, float))

(xlim, ylim)

titlestr

Histogram title.

xlabelstr

Histogram xlabel.

ylabelstr

Histogram ylabel.

zlabelstr

Histogram zlabel.

labels_dictdict

Dictionary of the title and labels.

Methods

binareas()	Compute the area of each 2D bin in the histogram.
binsizes()	Compute the binsizes along x and y.
binsizes_x()	Compute the widths of the bins along the x-axis.
binsizes_y()	Compute the widths of the bins along the y-axis.
copy()	Return a copy of the histogram.
for_pcolormesh()	Prepare the histogram data for plotting with matplotlib.pyplot.pcolormesh.
from_centers(xcenters, ycenters, values[, ...])	Initiate a Hist2d from centers (rather than edges).
from_image(image[, extents, title, xlabel, ...])	Create a Hist2d from a 2D image.
from_root(fname, hname[, title, xlabel, ...])	Initiate a Hist2d from a ROOT file.
from_txt(fname, *[, iteration_order, ...])	Initiate a Hist2d from a text file.
integrate()	Return the integral of the histogram.
keep([xlower, xupper, ylower, yupper, ...])	Return a new histogram with only bins within the specified (x, y) range.
max()	Returns the maximum value of the histogram.
min()	Returns the minimum value of the histogram.
norm_col_to_integral()	Normalize each column to their integral.
norm_col_to_max()	Normalize each column to their maximum.
norm_col_to_sum()	Normalize each column to their sum.
norm_diff(other)	Return the normalized difference between two histograms.
norm_row_to_integral()	Normalize each row to their integral.
norm_row_to_max()	Normalize each row to their maximum.
norm_row_to_sum()	Normalize each row to their sum.
norm_to_integral()	Normalize histogram to it's integral.
norm_to_max()	Normalize histogram to it's maximum.
norm_to_sum()	Normalize histogram to it's maximum.
norm_to_xbins()	Normalize values to the number of x bins.
norm_to_ybins()	Normalize values to the number of y bins.
plot([ax, fname, xlabel, ylabel, zlabel, ...])	Plot the 2D histogram using matplotlib.pyplot.pcolormesh.
profile_along_x([option])	Get the x-profile.
profile_along_y([option])	Get the y-profile.
project_onto_x()	Project histogram onto its x-axis.
project_onto_y()	Project histogram onto its x-axis.
rebin_x(fac)	Rebin the histogram along the x-axis by an integer factor.
rebin_y(fac)	Rebin the histogram along the y-axis by an integer factor.
remove([xlower, xupper, ylower, yupper, setval])	Return a new histogram with bins within the specified (x, y) range set to setval.
remove_zeros()	Replace zeros with NaN, removing them from colormaps.
save_to_file(fname, **savetxt_kwargs)	Save the histogram to a file.
sum()	Return the sum of all bins of the histogram.