histogram_tetraptych

kgpy.ctis.inversion.mart.stats.histogram_tetraptych(x, y, percentile_threshold_x=0.1, percentile_threshold_y=1.0, num_histogram_bins=100, x_axis_labels=('', '', '', ''), y_axis_labels=('', '', '', ''), red_line=False, interquartile_contour=False, min_iqr_count=10)

Produces a figure with four subplots, each a 2D histogram between corresponding entries in x and y

Parameters:

• x (typing.Tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray, numpy.ndarray]) – tuple of 4 arrays

• y (typing.Tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray, numpy.ndarray]) – tuple of 4 arrays

• percentile_threshold_x (float) – parameter used to calculate max and min percentile values for arrays in x

• percentile_threshold_y (float) – parameter used to calculate max and min percentile values for arrays in y

• num_histogram_bins (int) – how many bins in each the x and y axes for the histogram

• x_axis_labels (typing.Tuple[str, str, str, str]) –

• y_axis_labels (typing.Tuple[str, str, str, str]) –

• red_line (bool) – if True, plot the “x=y” line in each subplot as a red line

• interquartile_contour (bool) – if True, plots contour of 25th, 50th, and 75th percentile.

• min_iqr_count (int) – minimum number of unique values in a column for that column to be considered in calculating the interquartile contour

Return type:

matplotlib.figure.Figure

Returns: