get_bivariate_histogram#

DPCSignal2D.get_bivariate_histogram(histogram_range=None, masked=None, bins=200, spatial_std=3)[source]#

Useful for finding the distribution of magnetic vectors(?).

Parameters:

histogram_range (tuple, optional) – Set the minimum and maximum of the histogram range. Default is setting it automatically.
masked (2-D NumPy bool array, optional) – Mask parts of the data. The array must be the same size as the signal. The True values are masked. Default is not masking anything.
bins (integer, default 200) – Number of bins in the histogram
spatial_std (number, optional) – If histogram_range is not given, this value will be used to set the automatic histogram range. Default value is 3.

Returns:

s_hist

Return type:

HyperSpy Signal2D

Examples

>>> s = pxm.data.dummy_data.get_stripe_pattern_dpc_signal()
>>> s_hist = s.get_bivariate_histogram()
>>> s_hist.plot()