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

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_comparisons_compare_matrix_perturbation.py:


Matrix Perturbation Correlation Comparison
==========================================
This example demonstrates how to generate a matrix comparison plot for the perturbation correlation method (described in 
:ref:`sphx_glr_auto_examples_matrix_plot_matrix_of_perturbation_plots.py` and 
:ref:`sphx_glr_auto_examples_correlation_plot_perturbation_correlation_plot.py`). This example compares the calculated correlation
correlation coefficient to the TSUNAMI-IP calculated :math:`c_k` value for a set of dummy SDFs taken becuase they only use cross
sections available in the dummy 56 group library. **Note** before running this example, please ensure that the necessary cross section 
libraries are cached by running the :ref:`sphx_glr_auto_examples_correlation_plot_perturbation_correlation_plot.py` example.)

.. GENERATED FROM PYTHON SOURCE LINES 13-18

Getting TSUNAMI-IP :math:`c_k` Values
-------------------------------------
First, we need to get the TSUNAMI-IP :math:`c_k` values for the experiment and application SDFs we want to compare. We can do this
by using the :func:`tsunami_ip_utils.integral_indices.get_integral_indices` function, as shown in 
:ref:`sphx_glr_auto_examples_integral_index_reader.py`.

.. GENERATED FROM PYTHON SOURCE LINES 18-30

.. code-block:: Python


    from tsunami_ip_utils.integral_indices import get_integral_indices
    from paths import EXAMPLES

    application_sdfs = [ EXAMPLES / 'data' / 'example_sdfs' / 'u235-dummy' / f'sphere_model_{i}.sdf' for i in range(1, 4) ]
    experiment_sdfs = application_sdfs

    # Get the TSUNAMI-IP integral indices
    coverx_library = '56groupcov7.1'
    integral_indices = get_integral_indices(application_sdfs, experiment_sdfs, coverx_library=coverx_library)
    c_k = integral_indices['c_k']








.. GENERATED FROM PYTHON SOURCE LINES 31-36

Generating the Comparison
-------------------------
A matrix comparison plot comparing the computed correlation coefficient to the TSUNAMI-IP :math:`c_k` values can be generated using
the :func:`tsunami_ip_utils.comparisons.correlation_comparison` function. Note this function is used to compare any method for computing
any of the available TSUNAMI-IP integral indices (:math:`E` and :math:`c_k`). 

.. GENERATED FROM PYTHON SOURCE LINES 36-44

.. code-block:: Python


    from pathlib import Path
    from tsunami_ip_utils.comparisons import correlation_comparison

    # Define paths used for generating cross section perturbations
    multigroup_library = EXAMPLES / 'data' / 'dummy_56_v7.1'
    perturbation_factors = Path("~/codes/SCALE-6.3.1/data/perturb/56n.v7.1")








.. GENERATED FROM PYTHON SOURCE LINES 45-48

50 Points
---------
First, we'll generate a comparison for 50 points

.. GENERATED FROM PYTHON SOURCE LINES 48-64

.. code-block:: Python


    num_perturbations = 50
    comparisons, fig = correlation_comparison(
        integral_index_matrix=c_k,
        integral_index_name='c_k',
        application_files=application_sdfs, 
        experiment_files=experiment_sdfs, 
        method='perturbation',
        base_library=multigroup_library,
        perturbation_factors=perturbation_factors,
        num_perturbations=num_perturbations,
    )

    fig.show()
    print(comparisons)




.. raw:: html

    <div class="zoomControls">
        <button type="button" onclick="zoom(1, this)">- Zoom Out</button>
        <button type="button" onclick="zoom(-1, this)">+ Zoom In</button>
    </div>
    <div class="iframe_container">
        <iframe src="../../_static/plot_27f407d6-59b3-4c2e-8490-5299983caf22.html" width="100%" height="100%" frameborder="0" class="myiframe"></iframe>
    </div>
    <script>
        function zoom(direction, element) {
            // Find the closest parent container that includes both the buttons and the iframe
            const zoomContainer = element.closest('.zoomControls');
            const iframeContainer = zoomContainer.nextElementSibling;
            const iframe = iframeContainer.querySelector('.myiframe');

            // Initialize or retrieve the current scale
            let currentScale = parseFloat($(iframe).data('scale')) || 0.5;
            let originalWidth = parseFloat($(iframe).data('originalWidth')) || $(iframe).width();
            let originalHeight = parseFloat($(iframe).data('originalHeight')) || $(iframe).height();

            if (direction === 1) {
                currentScale /= 1.1;
            } else {
                currentScale *= 1.1;
            }

            let scaledWidth = originalWidth / currentScale;
            let scaledHeight = originalHeight / currentScale;

            // Store the updated scale
            $(iframe).data('scale', currentScale);

            // Apply the new scale as a CSS transform
            $(iframe).css('transform', `scale(${currentScale})`);
            $(iframe).css('width', `${scaledWidth}px`);
            $(iframe).css('height', `${scaledHeight}px`);
        }

        function applyInitialScale() {
            document.querySelectorAll('.myiframe').forEach(iframe => {
                let initialScale = 0.5;
                let originalWidth = $(iframe).width();
                let originalHeight = $(iframe).height();

                $(iframe).data('scale', initialScale);
                $(iframe).data('originalWidth', originalWidth);
                $(iframe).data('originalHeight', originalHeight);

                let scaledWidth = originalWidth / initialScale;
                let scaledHeight = originalHeight / initialScale;

                iframe.style.width = `${scaledWidth}px`;
                iframe.style.height = `${scaledHeight}px`;
                iframe.style.transform = 'scale(0.5)'; // Apply a neutral scale since size is already adjusted
                iframe.style.transformOrigin = '0 0'; // Transform from top left corner
            });
        }

        window.onload = function() {
            // Apply initial scale to all iframes when the page loads
            applyInitialScale();
        };
    </script>
            

.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    Generating perturbation points:   0%|          | 0/50 [00:00<?, ?it/s]
    Generating perturbation points:  66%|██████▌   | 33/50 [00:00<00:00, 328.53it/s]
    Generating perturbation points: 100%|██████████| 50/50 [00:00<00:00, 334.99it/s]

    Generating perturbation points:   0%|          | 0/50 [00:00<?, ?it/s]
    Generating perturbation points: 100%|██████████| 50/50 [00:00<00:00, 1581.31it/s]

    Generating perturbation points:   0%|          | 0/50 [00:00<?, ?it/s]
    Generating perturbation points:  44%|████▍     | 22/50 [00:00<00:00, 191.56it/s]
    Generating perturbation points: 100%|██████████| 50/50 [00:00<00:00, 378.56it/s]

    Generating perturbation points:   0%|          | 0/50 [00:00<?, ?it/s]
    Generating perturbation points: 100%|██████████| 50/50 [00:00<00:00, 1470.43it/s]

    Generating perturbation points:   0%|          | 0/50 [00:00<?, ?it/s]
    Generating perturbation points: 100%|██████████| 50/50 [00:00<00:00, 1452.48it/s]

    Generating perturbation points:   0%|          | 0/50 [00:00<?, ?it/s]
    Generating perturbation points:  44%|████▍     | 22/50 [00:00<00:00, 163.63it/s]
    Generating perturbation points: 100%|██████████| 50/50 [00:00<00:00, 329.29it/s]
    Application Number          1                                           ...          3                                         
    Attribute          Calculated            TSUNAMI-IP Percent Difference  ... Calculated            TSUNAMI-IP Percent Difference
    Experiment Number                                                       ...                                                    
    1                   1.000E+00  1.000E+00+/-5.00E-03    0.00+/-5.00E-01  ...  9.954E-01  9.985E-01+/-5.00E-03    0.31+/-4.99E-01
    2                   9.974E-01  9.994E-01+/-5.00E-03    0.20+/-4.99E-01  ...  9.859E-01  9.998E-01+/-5.00E-03    1.39+/-4.93E-01
    3                   9.954E-01  9.985E-01+/-5.00E-03    0.31+/-4.99E-01  ...  1.000E+00  1.000E+00+/-5.00E-03    0.00+/-5.00E-01

    [3 rows x 9 columns]




.. GENERATED FROM PYTHON SOURCE LINES 65-71

From this we can see an interactive matrix plot showing the perturbation correlation plots with the computed pearson and spearman
correlation coefficients and the TSUNAMI-IP computed :math:`c_k` values. Note that any plots disagreeing more than 5% are highlighted
in red. In addition, we get a multi-index pandas dataframe showing the comparisons (which can be written to excel as in
:ref:`sphx_glr_auto_examples_comparisons_compare_E.py`).
Note that all of the plot objects are generated using the defaults, and the matrix plot is also generated using the defaults.
If you want to customize the plot, just pass in ``plot_object_kwargs`` or ``matrix_plot_kwargs`` to the function.

.. GENERATED FROM PYTHON SOURCE LINES 73-77

200 Points
----------
Now, using a slightly larger number of points: 200 (remember 1000 is the maximum), we can generate another comparison, but this time
using static matplotlib plots and including labels

.. GENERATED FROM PYTHON SOURCE LINES 77-99

.. code-block:: Python


    num_perturbations = 200
    labels = {
        'applications': [ application_file.name for application_file in application_sdfs ],
        'experiments': [ experiment_file.name for experiment_file in experiment_sdfs ],
    }
    comparisons, fig = correlation_comparison(
        integral_index_matrix=c_k,
        integral_index_name='c_k',
        application_files=application_sdfs, 
        experiment_files=experiment_sdfs, 
        method='perturbation',
        base_library=multigroup_library,
        perturbation_factors=perturbation_factors,
        num_perturbations=num_perturbations,
        plot_objects_kwargs={'plot_type': 'scatter'},
        matrix_plot_kwargs={'labels': labels}
    )

    fig.show()
    print(comparisons)




.. raw:: html

    <div class="zoomControls">
        <button type="button" onclick="zoom(1, this)">- Zoom Out</button>
        <button type="button" onclick="zoom(-1, this)">+ Zoom In</button>
    </div>
    <div class="iframe_container">
        <iframe src="../../_static/plot_e605d076-a8b6-4351-b739-d86386eaff65.html" width="100%" height="100%" frameborder="0" class="myiframe"></iframe>
    </div>
    <script>
        function zoom(direction, element) {
            // Find the closest parent container that includes both the buttons and the iframe
            const zoomContainer = element.closest('.zoomControls');
            const iframeContainer = zoomContainer.nextElementSibling;
            const iframe = iframeContainer.querySelector('.myiframe');

            // Initialize or retrieve the current scale
            let currentScale = parseFloat($(iframe).data('scale')) || 0.5;
            let originalWidth = parseFloat($(iframe).data('originalWidth')) || $(iframe).width();
            let originalHeight = parseFloat($(iframe).data('originalHeight')) || $(iframe).height();

            if (direction === 1) {
                currentScale /= 1.1;
            } else {
                currentScale *= 1.1;
            }

            let scaledWidth = originalWidth / currentScale;
            let scaledHeight = originalHeight / currentScale;

            // Store the updated scale
            $(iframe).data('scale', currentScale);

            // Apply the new scale as a CSS transform
            $(iframe).css('transform', `scale(${currentScale})`);
            $(iframe).css('width', `${scaledWidth}px`);
            $(iframe).css('height', `${scaledHeight}px`);
        }

        function applyInitialScale() {
            document.querySelectorAll('.myiframe').forEach(iframe => {
                let initialScale = 0.5;
                let originalWidth = $(iframe).width();
                let originalHeight = $(iframe).height();

                $(iframe).data('scale', initialScale);
                $(iframe).data('originalWidth', originalWidth);
                $(iframe).data('originalHeight', originalHeight);

                let scaledWidth = originalWidth / initialScale;
                let scaledHeight = originalHeight / initialScale;

                iframe.style.width = `${scaledWidth}px`;
                iframe.style.height = `${scaledHeight}px`;
                iframe.style.transform = 'scale(0.5)'; // Apply a neutral scale since size is already adjusted
                iframe.style.transformOrigin = '0 0'; // Transform from top left corner
            });
        }

        window.onload = function() {
            // Apply initial scale to all iframes when the page loads
            applyInitialScale();
        };
    </script>
            

.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  56%|█████▌    | 111/200 [00:00<00:00, 1099.98it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 496.19it/s] 

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  62%|██████▎   | 125/200 [00:00<00:00, 643.97it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 826.68it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  72%|███████▏  | 143/200 [00:00<00:00, 620.13it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 749.66it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  74%|███████▍  | 149/200 [00:00<00:00, 1488.94it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 1469.33it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  74%|███████▍  | 148/200 [00:00<00:00, 1471.39it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 1471.32it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  66%|██████▌   | 131/200 [00:00<00:00, 512.98it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 667.80it/s]
    Application Number          1                                           ...          3                                         
    Attribute          Calculated            TSUNAMI-IP Percent Difference  ... Calculated            TSUNAMI-IP Percent Difference
    Experiment Number                                                       ...                                                    
    1                   1.000E+00  1.000E+00+/-5.00E-03    0.00+/-5.00E-01  ...  1.000E+00  9.985E-01+/-5.00E-03   -0.15+/-5.02E-01
    2                   1.000E+00  9.994E-01+/-5.00E-03   -0.06+/-5.01E-01  ...  1.000E+00  9.998E-01+/-5.00E-03   -0.02+/-5.00E-01
    3                   1.000E+00  9.985E-01+/-5.00E-03   -0.15+/-5.02E-01  ...  1.000E+00  1.000E+00+/-5.00E-03    0.00+/-5.00E-01

    [3 rows x 9 columns]




.. GENERATED FROM PYTHON SOURCE LINES 100-103

Note that for these examples, adding more poins hardly changes the agreement, because the TSUNAMI_IP :math:`c_k` values are ~1, only
a small number of points are needed to get a small uncertainty on the correlation coefficient (see :ref:`the technical manual <sec-pearson-coefficient>`
for details).

.. GENERATED FROM PYTHON SOURCE LINES 105-106

These plots can also be saved to an image

.. GENERATED FROM PYTHON SOURCE LINES 106-123

.. code-block:: Python


    comparisons, fig = correlation_comparison(
        integral_index_matrix=c_k,
        integral_index_name='c_k',
        application_files=application_sdfs, 
        experiment_files=experiment_sdfs, 
        method='perturbation',
        base_library=multigroup_library,
        perturbation_factors=perturbation_factors,
        num_perturbations=num_perturbations,
        plot_objects_kwargs={'plot_type': 'scatter'},
        matrix_plot_kwargs={'labels': labels}
    )
    fig.to_image( EXAMPLES / '_static' / 'perturbation_matrix_comparison.png' )

    # sphinx_gallery_thumbnail_path = '../../examples/_static/perturbation_matrix_comparison.png'




.. raw:: html

    <div class="zoomControls">
        <button type="button" onclick="zoom(1, this)">- Zoom Out</button>
        <button type="button" onclick="zoom(-1, this)">+ Zoom In</button>
    </div>
    <div class="iframe_container">
        <iframe src="../../_static/plot_d19311f5-09c8-4100-8b0e-84dff6adfba1.html" width="100%" height="100%" frameborder="0" class="myiframe"></iframe>
    </div>
    <script>
        function zoom(direction, element) {
            // Find the closest parent container that includes both the buttons and the iframe
            const zoomContainer = element.closest('.zoomControls');
            const iframeContainer = zoomContainer.nextElementSibling;
            const iframe = iframeContainer.querySelector('.myiframe');

            // Initialize or retrieve the current scale
            let currentScale = parseFloat($(iframe).data('scale')) || 0.5;
            let originalWidth = parseFloat($(iframe).data('originalWidth')) || $(iframe).width();
            let originalHeight = parseFloat($(iframe).data('originalHeight')) || $(iframe).height();

            if (direction === 1) {
                currentScale /= 1.1;
            } else {
                currentScale *= 1.1;
            }

            let scaledWidth = originalWidth / currentScale;
            let scaledHeight = originalHeight / currentScale;

            // Store the updated scale
            $(iframe).data('scale', currentScale);

            // Apply the new scale as a CSS transform
            $(iframe).css('transform', `scale(${currentScale})`);
            $(iframe).css('width', `${scaledWidth}px`);
            $(iframe).css('height', `${scaledHeight}px`);
        }

        function applyInitialScale() {
            document.querySelectorAll('.myiframe').forEach(iframe => {
                let initialScale = 0.5;
                let originalWidth = $(iframe).width();
                let originalHeight = $(iframe).height();

                $(iframe).data('scale', initialScale);
                $(iframe).data('originalWidth', originalWidth);
                $(iframe).data('originalHeight', originalHeight);

                let scaledWidth = originalWidth / initialScale;
                let scaledHeight = originalHeight / initialScale;

                iframe.style.width = `${scaledWidth}px`;
                iframe.style.height = `${scaledHeight}px`;
                iframe.style.transform = 'scale(0.5)'; // Apply a neutral scale since size is already adjusted
                iframe.style.transformOrigin = '0 0'; // Transform from top left corner
            });
        }

        window.onload = function() {
            // Apply initial scale to all iframes when the page loads
            applyInitialScale();
        };
    </script>
            

.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  72%|███████▏  | 143/200 [00:00<00:00, 1420.84it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 1458.27it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  26%|██▋       | 53/200 [00:00<00:00, 289.04it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 715.16it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  24%|██▍       | 49/200 [00:00<00:00, 312.14it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 880.67it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 776.19it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  44%|████▍     | 88/200 [00:00<00:00, 427.41it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 719.03it/s]

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  75%|███████▌  | 150/200 [00:00<00:00, 1494.52it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 674.53it/s] 

    Generating perturbation points:   0%|          | 0/200 [00:00<?, ?it/s]
    Generating perturbation points:  76%|███████▌  | 151/200 [00:00<00:00, 1502.80it/s]
    Generating perturbation points: 100%|██████████| 200/200 [00:00<00:00, 1498.52it/s]




.. GENERATED FROM PYTHON SOURCE LINES 124-130

A Comparison Without a Plot
---------------------------
Sometimes generating the plots themselves can be extremely memory intensive when making a matrix plot comparison over an entire
series of critical experiments, so sometimes it is desirable to generate the comparison without the plot. This can be done by
passing ``make_plot=False`` to the :func:`tsunami_ip_utils.comparisons.correlation_comparison` function. This will return only
the comparisons dataframe.

.. GENERATED FROM PYTHON SOURCE LINES 130-144

.. code-block:: Python


    comparisons = correlation_comparison(
        integral_index_matrix=c_k,
        integral_index_name='c_k',
        application_files=application_sdfs, 
        experiment_files=experiment_sdfs, 
        method='perturbation',
        base_library=multigroup_library,
        perturbation_factors=perturbation_factors,
        num_perturbations=num_perturbations,
        make_plot=False,
    )
    print(comparisons)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Application Number          1                                           ...          3                                         
    Attribute          Calculated            TSUNAMI-IP Percent Difference  ... Calculated            TSUNAMI-IP Percent Difference
    Experiment Number                                                       ...                                                    
    1                   1.000E+00  1.000E+00+/-5.00E-03    0.00+/-5.00E-01  ...  9.959E-01  9.985E-01+/-5.00E-03    0.26+/-4.99E-01
    2                   9.976E-01  9.994E-01+/-5.00E-03    0.18+/-4.99E-01  ...  9.872E-01  9.998E-01+/-5.00E-03    1.26+/-4.94E-01
    3                   9.959E-01  9.985E-01+/-5.00E-03    0.26+/-4.99E-01  ...  1.000E+00  1.000E+00+/-5.00E-03    0.00+/-5.00E-01

    [3 rows x 9 columns]




.. GENERATED FROM PYTHON SOURCE LINES 145-146

Note also that, since generating points for perturbation plots can be time consuming, this function by default runs in parallel
with two less than the number of cores available on your machine. This can be changed by passing the ``num_cores`` argument.


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

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


.. _sphx_glr_download_auto_examples_comparisons_compare_matrix_perturbation.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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