.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "example_gallery/advanced/asymmetry_comparison_advanced.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_example_gallery_advanced_asymmetry_comparison_advanced.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_example_gallery_advanced_asymmetry_comparison_advanced.py:


Advanced asymmetry comparison
=============================

Plot the asymmetry between 2 histograms and 2 functions.

.. GENERATED FROM PYTHON SOURCE LINES 7-135



.. image-sg:: /example_gallery/advanced/images/sphx_glr_asymmetry_comparison_advanced_001.svg
   :alt: asymmetry comparison advanced
   :srcset: /example_gallery/advanced/images/sphx_glr_asymmetry_comparison_advanced_001.svg
   :class: sphx-glr-single-img





.. code-block:: Python


    # Get dummy data
    from plothist_utils import get_dummy_data

    df = get_dummy_data()

    ###
    import numpy as np
    from scipy.stats import norm

    from plothist import (
        add_luminosity,
        add_text,
        create_comparison_figure,
        make_hist,
        plot_comparison,
        plot_error_hist,
        plot_function,
    )


    # Define some random functions that will be used as Data fit functions
    def f1(x: np.ndarray) -> np.ndarray:
        return 4000 * norm.pdf(x, loc=-0.5, scale=1.6)


    def f2(x: np.ndarray) -> np.ndarray:
        return 4000 * norm.pdf(x, loc=0.5, scale=1.6)


    name = "variable_1"
    category = "category"

    x1 = df[name][df[category] == 5]

    x_range = (-9, 9)

    # Create the histograms used as data
    h1 = make_hist(x1 - 2.5, bins=50, range=x_range)
    h2 = make_hist(x1 - 1.5, bins=50, range=x_range)

    # Create the figure
    fig, (ax_main, ax_comparison) = create_comparison_figure(
        gridspec_kw={"height_ratios": [2, 1]}
    )

    # Define the marker style
    marker_1 = {
        "color": "tab:red",
        "markeredgecolor": "tab:red",
        "ls": "None",
        "fmt": "o",
        "markersize": 5,
        "label": "$Data_1$",
    }

    marker_2 = {
        "color": "tab:blue",
        "markerfacecolor": "white",
        "markeredgecolor": "tab:blue",
        "ls": "None",
        "fmt": "o",
        "markersize": 5,
        "label": "$Data_2$",
    }

    # Plot the data
    plot_error_hist(
        h1,
        ax_main,
        uncertainty_type="symmetrical",
        density=False,
        **marker_1,
    )

    plot_error_hist(
        h2,
        ax_main,
        uncertainty_type="symmetrical",
        density=False,
        **marker_2,
    )

    # Plot the functions
    plot_function(f1, x_range, ax_main, color=marker_1["color"], label="Data$_1$ fit")
    plot_function(
        f2, x_range, ax_main, color=marker_2["color"], linestyle="--", label="Data$_2$ fit"
    )

    # Plot the asymmetry comparison between the 2 histograms
    plot_comparison(
        h1,
        h2,
        ax=ax_comparison,
        h1_label=r"$Data_1$",
        h2_label=r"$Data_2$",
        comparison="asymmetry",
        comparison_ylim=(-1, 1),
    )


    # Define the asymmetry of the 2 functions
    def asymmetry(x):
        return (f1(x) - f2(x)) / (f1(x) + f2(x))


    # Plot the asymmetry of the 2 functions
    plot_function(asymmetry, x_range, ax_comparison, color="black")

    ax_main.legend()

    fig.align_ylabels()

    ax_main.set_xlim(x_range)
    ax_main.set_ylim(ymin=0)
    ax_main.set_ylabel("Entries")
    ax_main.legend()

    ax_comparison.set_xlim(x_range)
    ax_comparison.set_xlabel(name)

    add_text("Data and fit asymmetry comparison", ax=ax_comparison, x="right")

    add_luminosity(
        collaboration="LMN 3", ax=ax_main, lumi="(1 + 0.3)", preliminary=True, x="left"
    )

    fig.savefig("asymmetry_comparison_advanced.svg", bbox_inches="tight")


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.996 seconds)


.. _sphx_glr_download_example_gallery_advanced_asymmetry_comparison_advanced.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: asymmetry_comparison_advanced.ipynb <asymmetry_comparison_advanced.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: asymmetry_comparison_advanced.py <asymmetry_comparison_advanced.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: asymmetry_comparison_advanced.zip <asymmetry_comparison_advanced.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_