plothist 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

plothist/examples/model_ex/model_examples_pull_no_model_unc.py

@@ -0,0 +1,59 @@
+"""
+Pull plot, no model uncertainty
+===============================
+
+Compare data and model with pulls, without model uncertainty.
+"""
+
+from plothist_utils import get_dummy_data
+
+df = get_dummy_data()
+
+from plothist import get_color_palette, make_hist
+
+# Define the histograms
+
+key = "variable_1"
+range = (-9, 12)
+category = "category"
+
+# Define masks
+signal_mask = df[category] == 7
+data_mask = df[category] == 8
+
+background_categories = [0, 1, 2]
+background_categories_labels = [f"c{i}" for i in background_categories]
+background_categories_colors = get_color_palette(
+    "cubehelix", len(background_categories)
+)
+
+background_masks = [df[category] == p for p in background_categories]
+
+# Make histograms
+data_hist = make_hist(df[key][data_mask], bins=50, range=range, weights=1)
+background_hists = [
+    make_hist(df[key][mask], bins=50, range=range, weights=1)
+    for mask in background_masks
+]
+
+# Optional: scale to data
+background_scaling_factor = data_hist.sum().value / sum(background_hists).sum().value
+background_hists = [background_scaling_factor * h for h in background_hists]
+
+###
+from plothist import add_luminosity, plot_data_model_comparison
+
+fig, ax_main, ax_comparison = plot_data_model_comparison(
+    data_hist=data_hist,
+    stacked_components=background_hists,
+    stacked_labels=background_categories_labels,
+    stacked_colors=background_categories_colors,
+    xlabel=rf"${key}\,\,[eV/c^2]$",
+    ylabel=r"Hits in the LMN per $4.2\times 10^{-1}\,\,eV/c^2$",
+    comparison="pull",
+    model_uncertainty=False,  # <--
+)
+
+add_luminosity(collaboration="plothist", ax=ax_main, is_data=False)
+
+fig.savefig("model_examples_pull_no_model_unc.svg", bbox_inches="tight")

plothist/examples/model_ex/model_examples_stacked.py

@@ -0,0 +1,74 @@
+"""
+Data vs model with stacked components
+=====================================
+
+Plot data and a model with stacked components.
+"""
+
+from plothist_utils import get_dummy_data
+
+df = get_dummy_data()
+
+from plothist import get_color_palette, make_hist
+
+# Define the histograms
+
+key = "variable_1"
+range = (-9, 12)
+category = "category"
+
+# Define masks
+signal_mask = df[category] == 7
+data_mask = df[category] == 8
+
+background_categories = [0, 1, 2]
+background_categories_labels = [f"c{i}" for i in background_categories]
+background_categories_colors = get_color_palette(
+    "cubehelix", len(background_categories)
+)
+
+background_masks = [df[category] == p for p in background_categories]
+
+# Make histograms
+data_hist = make_hist(df[key][data_mask], bins=50, range=range, weights=1)
+background_hists = [
+    make_hist(df[key][mask], bins=50, range=range, weights=1)
+    for mask in background_masks
+]
+signal_hist = make_hist(df[key][signal_mask], bins=50, range=range, weights=1)
+
+# Optional: scale to data
+background_scaling_factor = data_hist.sum().value / sum(background_hists).sum().value
+background_hists = [background_scaling_factor * h for h in background_hists]
+
+signal_scaling_factor = data_hist.sum().value / signal_hist.sum().value
+signal_hist *= signal_scaling_factor
+
+###
+from plothist import add_luminosity, plot_data_model_comparison, plot_hist
+
+fig, ax_main, ax_comparison = plot_data_model_comparison(
+    data_hist=data_hist,
+    stacked_components=background_hists,
+    stacked_labels=background_categories_labels,
+    stacked_colors=background_categories_colors,
+    xlabel=key,
+    ylabel="Entries",
+)
+
+# Signal histogram not part of the model and therefore not included in the comparison
+plot_hist(
+    signal_hist,
+    ax=ax_main,
+    color="red",
+    label="Signal",
+    histtype="step",
+)
+
+ax_main.legend()
+
+add_luminosity(
+    collaboration="plothist", ax=ax_main, lumi=3, lumi_unit="zb", preliminary=True
+)
+
+fig.savefig("model_examples_stacked.svg", bbox_inches="tight")

plothist/examples/model_ex/model_examples_stacked_unstacked.py

@@ -0,0 +1,60 @@
+"""
+Data vs model with stacked and unstacked components
+===================================================
+
+Plot data and a model with stacked and unstacked components.
+"""
+
+from plothist_utils import get_dummy_data
+
+df = get_dummy_data()
+
+from plothist import get_color_palette, make_hist
+
+# Define the histograms
+
+key = "variable_1"
+range = (-9, 12)
+category = "category"
+
+# Define masks
+signal_mask = df[category] == 7
+data_mask = df[category] == 8
+
+background_categories = [0, 1, 2]
+background_categories_labels = [f"c{i}" for i in background_categories]
+background_categories_colors = get_color_palette(
+    "cubehelix", len(background_categories)
+)
+
+background_masks = [df[category] == p for p in background_categories]
+
+# Make histograms
+data_hist = make_hist(df[key][data_mask], bins=50, range=range, weights=1)
+background_hists = [
+    make_hist(df[key][mask], bins=50, range=range, weights=1)
+    for mask in background_masks
+]
+
+# Optional: scale to data
+background_scaling_factor = data_hist.sum().value / sum(background_hists).sum().value
+background_hists = [background_scaling_factor * h for h in background_hists]
+
+###
+from plothist import plot_data_model_comparison
+
+fig, ax_main, ax_comparison = plot_data_model_comparison(
+    data_hist=data_hist,
+    stacked_components=background_hists[:2],
+    stacked_labels=background_categories_labels[:2],
+    stacked_colors=background_categories_colors[:2],
+    unstacked_components=background_hists[2:],
+    unstacked_labels=background_categories_labels[2:],
+    unstacked_colors=background_categories_colors[2:],
+    xlabel=key,
+    ylabel="Entries",
+    model_sum_kwargs={"show": True, "label": "Model", "color": "navy"},
+    comparison_ylim=(0.5, 1.5),
+)
+
+fig.savefig("model_examples_stacked_unstacked.svg", bbox_inches="tight")

plothist/examples/model_ex/model_examples_unstacked.py

@@ -0,0 +1,57 @@
+"""
+Data vs model with unstacked components
+=====================================
+
+Plot data and a model with unstacked components.
+"""
+
+from plothist_utils import get_dummy_data
+
+df = get_dummy_data()
+
+from plothist import get_color_palette, make_hist
+
+# Define the histograms
+
+key = "variable_1"
+range = (-9, 12)
+category = "category"
+
+# Define masks
+signal_mask = df[category] == 7
+data_mask = df[category] == 8
+
+background_categories = [0, 1, 2]
+background_categories_labels = [f"c{i}" for i in background_categories]
+background_categories_colors = get_color_palette(
+    "cubehelix", len(background_categories)
+)
+
+background_masks = [df[category] == p for p in background_categories]
+
+# Make histograms
+data_hist = make_hist(df[key][data_mask], bins=50, range=range, weights=1)
+background_hists = [
+    make_hist(df[key][mask], bins=50, range=range, weights=1)
+    for mask in background_masks
+]
+
+# Optional: scale to data
+background_scaling_factor = data_hist.sum().value / sum(background_hists).sum().value
+background_hists = [background_scaling_factor * h for h in background_hists]
+
+###
+from plothist import plot_data_model_comparison
+
+fig, ax_main, ax_comparison = plot_data_model_comparison(
+    data_hist=data_hist,
+    unstacked_components=background_hists,
+    unstacked_labels=background_categories_labels,
+    unstacked_colors=background_categories_colors,
+    xlabel=key,
+    ylabel="Entries",
+    model_sum_kwargs={"label": "Sum(hists)", "color": "navy"},
+    comparison_ylim=[0.5, 1.5],
+)
+
+fig.savefig("model_examples_unstacked.svg", bbox_inches="tight")

plothist/examples/model_ex/model_with_stacked_and_unstacked_function_components.py

@@ -0,0 +1,50 @@
+"""
+Model with stacked and unstacked functional components
+======================================================
+
+Plot a model with stacked and unstacked functional components.
+"""
+
+key = "variable_1"
+range = (-9, 12)
+
+background_categories = [0, 1, 2]
+background_categories_labels = [f"c{i}" for i in background_categories]
+
+
+# Define some random functions that will be used as model components with functions
+from scipy.stats import norm
+
+
+def f_signal(x):
+    return 1000 * norm.pdf(x, loc=0.5, scale=3)
+
+
+def f_background1(x):
+    return 1000 * norm.pdf(x, loc=-1.5, scale=4)
+
+
+def f_background2(x):
+    return 3000 * norm.pdf(x, loc=-1.8, scale=1.8)
+
+
+###
+from plothist import add_text, plot_model
+
+fig, ax = plot_model(
+    stacked_components=[f_background1, f_background2],
+    stacked_labels=background_categories_labels[:2],
+    unstacked_components=[f_signal],
+    unstacked_labels=["Signal"],
+    unstacked_colors=["black"],
+    xlabel=key,
+    ylabel=f"f({key})",
+    model_sum_kwargs={"show": True, "label": "Model", "color": "navy"},
+    function_range=range,
+)
+
+add_text("Model made of functions", ax=ax)
+
+fig.savefig(
+    "model_with_stacked_and_unstacked_function_components.svg", bbox_inches="tight"
+)

plothist/examples/model_ex/model_with_stacked_and_unstacked_histograms_components.py

@@ -0,0 +1,69 @@
+"""
+Model with stacked and unstacked components
+===========================================
+
+Plot a model with stacked and unstacked components.
+"""
+
+from plothist_utils import get_dummy_data
+
+df = get_dummy_data()
+
+from plothist import get_color_palette, make_hist
+
+# Define the histograms
+
+key = "variable_1"
+range = (-9, 12)
+category = "category"
+
+# Define masks
+signal_mask = df[category] == 7
+data_mask = df[category] == 8
+
+background_categories = [0, 1, 2]
+background_categories_labels = [f"c{i}" for i in background_categories]
+background_categories_colors = get_color_palette(
+    "cubehelix", len(background_categories)
+)
+
+background_masks = [df[category] == p for p in background_categories]
+
+# Make histograms
+data_hist = make_hist(df[key][data_mask], bins=50, range=range, weights=1)
+background_hists = [
+    make_hist(df[key][mask], bins=50, range=range, weights=1)
+    for mask in background_masks
+]
+signal_hist = make_hist(df[key][signal_mask], bins=50, range=range, weights=1)
+
+# Optional: scale to data
+background_scaling_factor = data_hist.sum().value / sum(background_hists).sum().value
+background_hists = [background_scaling_factor * h for h in background_hists]
+
+signal_scaling_factor = data_hist.sum().value / signal_hist.sum().value
+signal_hist *= signal_scaling_factor
+
+###
+from plothist import add_text, plot_model
+
+fig, ax = plot_model(
+    stacked_components=background_hists,
+    stacked_labels=background_categories_labels,
+    stacked_colors=background_categories_colors,
+    unstacked_components=[signal_hist],
+    unstacked_labels=["Signal"],
+    unstacked_colors=["black"],
+    unstacked_kwargs_list=[{"linestyle": "dotted"}],
+    xlabel=key,
+    ylabel="Entries",
+    model_sum_kwargs={"show": True, "label": "Model", "color": "navy"},
+    model_uncertainty_label="Stat. unc.",
+)
+
+add_text("Model made of histograms", ax=ax)
+
+fig.savefig(
+    "model_with_stacked_and_unstacked_histograms_components.svg",
+    bbox_inches="tight",
+)

plothist/examples/model_ex/ratio_data_vs_model_with_stacked_and_unstacked_function_components.py

@@ -0,0 +1,61 @@
+"""
+Data vs functional model
+========================
+
+Compare data and model with stacked and unstacked functional components.
+"""
+
+from plothist_utils import get_dummy_data
+
+df = get_dummy_data()
+
+from plothist import make_hist
+
+# Define the histograms
+
+key = "variable_1"
+range = (-9, 12)
+category = "category"
+
+# Define masks
+data_mask = df[category] == 8
+
+# Make histograms
+data_hist = make_hist(df[key][data_mask], bins=50, range=range, weights=1)
+
+# Define some random functions that will be used as model components with functions
+from scipy.stats import norm
+
+
+def f_signal(x):
+    return 1000 * norm.pdf(x, loc=0.5, scale=3)
+
+
+def f_background1(x):
+    return 1000 * norm.pdf(x, loc=-1.5, scale=4)
+
+
+def f_background2(x):
+    return 3000 * norm.pdf(x, loc=-1.8, scale=1.8)
+
+
+###
+from plothist import plot_data_model_comparison
+
+fig, ax_main, ax_comparison = plot_data_model_comparison(
+    data_hist=data_hist,
+    stacked_components=[f_background1, f_background2],
+    stacked_labels=["c0", "c1"],
+    unstacked_components=[f_signal],
+    unstacked_labels=["Signal"],
+    unstacked_colors=["#8EBA42"],
+    xlabel=key,
+    ylabel="Entries",
+    model_sum_kwargs={"show": True, "label": "Model", "color": "navy"},
+    comparison="pull",
+)
+
+fig.savefig(
+    "ratio_data_vs_model_with_stacked_and_unstacked_function_components.svg",
+    bbox_inches="tight",
+)

plothist/examples/utility/README.rst

@@ -0,0 +1,4 @@
+Utilities
+---------
+
+Gallery of images that are used in the utility section.

plothist/examples/utility/add_text_example.py

@@ -0,0 +1,39 @@
+"""
+Add text
+========
+
+Examples of use of ``add_text()``.
+"""
+
+###
+import matplotlib.pyplot as plt
+
+from plothist import add_text
+
+fig, ax = plt.subplots()
+
+positions = [
+    ("right_in", "top_in"),
+    ("left_in", "top_in"),
+    ("left_in", "bottom_in"),
+    ("right_in", "bottom_in"),
+    ("right", "top_out"),
+    ("left", "top_out"),
+    ("right_out", "top_in"),
+    ("right_out", "bottom_in"),
+    ("right", "bottom_out"),
+    ("left", "bottom_out"),
+]
+
+for x, y in positions:
+    x_label = x.replace("_", r"\_")
+    y_label = y.replace("_", r"\_")
+    add_text(
+        f"$\\mathtt{{add\\_text()}}$\n"
+        f'$\\mathtt{{x = }}$"$\\mathtt{{{x_label}}}$"\n'
+        f'$\\mathtt{{y = }}$"$\\mathtt{{{y_label}}}$"',
+        x=x,
+        y=y,
+    )
+
+fig.savefig("add_text_example.svg", bbox_inches="tight")

plothist/examples/utility/color_palette_hists.py

@@ -0,0 +1,94 @@
+"""
+Color palettes in stacked histograms
+====================================
+
+Examples of color palettes in stacked histograms.
+"""
+
+from plothist_utils import get_dummy_data
+
+df = get_dummy_data()
+
+import matplotlib.pyplot as plt
+
+from plothist import add_text, get_color_palette, make_hist, plot_error_hist, plot_model
+
+# Define the histograms
+key = "variable_1"
+xrange = (-8, 10)
+category = "category"
+
+# Define masks
+signal_mask = df[category] == 7
+data_mask = df[category] == 8
+
+background_categories = [0, 1, 2, 3, 4, 5]
+background_categories_labels = [f"c{i}" for i in background_categories]
+background_masks = [df[category] == p for p in background_categories]
+
+# Make histograms
+data_hist = make_hist(df[key][data_mask], bins=50, range=xrange, weights=1)
+background_hists = [
+    make_hist(df[key][mask], bins=50, range=xrange, weights=1)
+    for mask in background_masks
+]
+signal_hist = make_hist(df[key][signal_mask], bins=50, range=xrange, weights=1)
+
+# Optional: scale to data
+background_scaling_factor = data_hist.sum().value / sum(background_hists).sum().value
+background_hists = [background_scaling_factor * h for h in background_hists]
+
+signal_scaling_factor = data_hist.sum().value / signal_hist.sum().value
+signal_hist *= signal_scaling_factor
+
+
+# Plotting section
+nrows, ncols = 2, 2
+
+fig, axes = plt.subplots(
+    nrows=nrows,
+    ncols=ncols,
+    figsize=(12, 10),
+)
+fig.subplots_adjust(hspace=0.25)
+
+cmap_list = ["viridis", "ggplot", "coolwarm", "YlGnBu_r"]
+ax_coords = [(x, y) for x in range(nrows) for y in range(ncols)]
+
+for k, cmap_name in enumerate(cmap_list):
+    background_categories_colors = get_color_palette(
+        cmap_name, len(background_categories)
+    )
+
+    ax = axes[ax_coords[k]]
+
+    plot_model(
+        stacked_components=background_hists,
+        stacked_labels=background_categories_labels,
+        stacked_colors=background_categories_colors,
+        xlabel=key,
+        ylabel="Entries",
+        model_uncertainty=False,
+        fig=fig,
+        ax=ax,
+    )
+
+    plot_error_hist(
+        data_hist,
+        color="black",
+        label="Data",
+        ax=ax,
+    )
+
+    ax.set_xlim(xrange)
+    ax.legend()
+
+    cmap_name = cmap_name.replace("_", r"\_")
+    add_text(
+        rf"$\mathrm{{\mathbf{{cmap = {cmap_name}}}}}$", x="right", fontsize=12, ax=ax
+    )
+
+fig.savefig(
+    "color_palette_hists.svg",
+    bbox_inches="tight",
+)

plothist/examples/utility/color_palette_squares.py

@@ -0,0 +1,100 @@
+"""
+Color palettes
+==============
+
+Examples of color palettes.
+"""
+
+import matplotlib.colors as mcolors
+import matplotlib.pyplot as plt
+import numpy as np
+from matplotlib import patches
+
+from plothist import get_color_palette
+
+
+def create_palette_plot(colors, fig_name, add_text=False, add_black_border=False):
+    ncolors = len(colors)
+
+    # Create a figure and axis
+    fig, ax = plt.subplots(figsize=(ncolors, 1))
+
+    # Plot the colored squares with small spacing
+    square_size = 1
+    spacing = 0.1
+    x = 0
+
+    for color in colors:
+        rect = patches.Rectangle((x, 0), square_size, square_size, color=color)
+        ax.add_patch(rect)
+        x += square_size + spacing
+
+        if add_text:
+            # Add text displaying the color value
+            ax.text(
+                x - (square_size + spacing) / 1.81,
+                -0.18,
+                mcolors.rgb2hex(color).upper(),
+                ha="center",
+                fontsize=10,
+            )
+
+    # Set the x-axis limits and show the ticks
+    ax.set_xlim(-0.5, x - spacing)
+    ax.set_xticks(np.arange(0, x, square_size + spacing))
+    ax.set_xticklabels(np.arange(1, ncolors + 1), fontsize=8)
+    ax.set_xticklabels([])  # Remove the x-tick labels
+
+    # Set the y-axis ticks and labels
+    ax.set_yticks([])
+    ax.set_yticklabels([])
+
+    # Remove the borders around the plot
+    ax.spines["top"].set_visible(False)
+    ax.spines["bottom"].set_visible(False)
+    ax.spines["left"].set_visible(False)
+    ax.spines["right"].set_visible(False)
+
+    # Remove the x-label and y-label
+    ax.set_xlabel("")
+    ax.set_ylabel("")
+
+    if add_black_border:
+        # Add a black border rectangle
+        border_rect = patches.Rectangle(
+            (0, 0),
+            x - spacing,
+            square_size,
+            edgecolor="black",
+            facecolor="none",
+            linewidth=1,
+        )
+        ax.add_patch(border_rect)
+
+    # Adjust the padding and remove extra whitespace
+    plt.margins(0)
+    plt.gca().set_axis_off()
+    plt.subplots_adjust(left=0.05, right=0.95)
+
+    plt.savefig(fig_name, bbox_inches="tight")
+
+    return fig
+
+
+figs = []
+
+ncolors = 7
+
+ncolors_ggplot = 7 if ncolors > 7 else ncolors
+colors = get_color_palette("ggplot", ncolors_ggplot)
+figs.append(
+    create_palette_plot(colors, fig_name="usage_style_cycle.svg", add_text=True)
+)
+
+colors = get_color_palette("cubehelix", ncolors)
+figs.append(create_palette_plot(colors, fig_name="usage_cubehelix.svg"))
+
+cmap_list = ["viridis", "coolwarm", "YlGnBu_r"]
+for cmap_name in cmap_list:
+    colors = get_color_palette(cmap_name, ncolors)
+    figs.append(create_palette_plot(colors, fig_name=f"usage_{cmap_name}_palette.svg"))