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

.. only:: html

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

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

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

.. _sphx_glr_gen_examples_output_parsing_plot_field_quality.py:


Field quality plots
===================

Use the output of a harmonic coil and show the Field quality

Download Input files

* :download:`dipole_2d.data <../../../../../examples/input_files/dipole_2d.data>`
* :download:`dipole_2d.post.xml <../../../../../examples/input_files/dipole_2d.post.xml>`

.. GENERATED FROM PYTHON SOURCE LINES 14-18

Setting up
----------
Standard Loading of input, Parsing and Initializing RoxiePlotOutputs object


.. GENERATED FROM PYTHON SOURCE LINES 18-24

.. code-block:: Python

    from roxieapi.output.plots import RoxiePlotOutputs

    plots = RoxiePlotOutputs(
        "../input_files/dipole_2d.post.xml", "../input_files/dipole_2d.data"
    )








.. GENERATED FROM PYTHON SOURCE LINES 25-30

Field quality tables
--------------------
Field quality tables are parsed and accessible in the parser.
To load, we select the Harmonic coil id and get it from the parser.


.. GENERATED FROM PYTHON SOURCE LINES 30-36

.. code-block:: Python

    harmonic_coil = plots.output.get_harmonic_coil(1)
    assert (
        harmonic_coil is not None
    )  # We assume the input file is correct and harmonic coils are defined
    dfs = plots.tables.print_harmonic_coil(harmonic_coil)








.. GENERATED FROM PYTHON SOURCE LINES 37-39

The output returns 3 Tables:
- Coil definites

.. GENERATED FROM PYTHON SOURCE LINES 39-41

.. code-block:: Python

    dfs[0]






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>type</th>
          <th>reference radius (mm)</th>
          <th>x position (mm)</th>
          <th>y position (mm)</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>Cylindrical</td>
          <td>17.0</td>
          <td>0.0</td>
          <td>0.0</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 42-43

- Field information

.. GENERATED FROM PYTHON SOURCE LINES 43-45

.. code-block:: Python

    dfs[1]






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>main field (T)</th>
          <th>reference magnet strength (T)</th>
          <th>error of harmonic analysis of br</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>-7.169634072777</td>
          <td>-7.169634072777</td>
          <td>0.0003159894656828</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 46-47

- Harmonics table

.. GENERATED FROM PYTHON SOURCE LINES 47-49

.. code-block:: Python

    dfs[2]






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead th {
            text-align: right;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>Order</th>
          <th>bn</th>
          <th>an</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>1</td>
          <td>1.000000e+04</td>
          <td>1.986444e-12</td>
        </tr>
        <tr>
          <th>1</th>
          <td>2</td>
          <td>7.947441e-13</td>
          <td>7.458240e-13</td>
        </tr>
        <tr>
          <th>2</th>
          <td>3</td>
          <td>2.456824e+00</td>
          <td>-1.330748e-13</td>
        </tr>
        <tr>
          <th>3</th>
          <td>4</td>
          <td>1.161683e-12</td>
          <td>-2.706258e-12</td>
        </tr>
        <tr>
          <th>4</th>
          <td>5</td>
          <td>-4.926023e+00</td>
          <td>-2.231423e-12</td>
        </tr>
        <tr>
          <th>5</th>
          <td>6</td>
          <td>-1.054013e-12</td>
          <td>1.504351e-12</td>
        </tr>
        <tr>
          <th>6</th>
          <td>7</td>
          <td>1.787194e+00</td>
          <td>2.314897e-12</td>
        </tr>
        <tr>
          <th>7</th>
          <td>8</td>
          <td>5.846220e-13</td>
          <td>-7.246530e-13</td>
        </tr>
        <tr>
          <th>8</th>
          <td>9</td>
          <td>1.380537e-01</td>
          <td>-1.520078e-12</td>
        </tr>
        <tr>
          <th>9</th>
          <td>10</td>
          <td>8.335324e-13</td>
          <td>1.977976e-12</td>
        </tr>
        <tr>
          <th>10</th>
          <td>11</td>
          <td>6.914776e-01</td>
          <td>8.256689e-13</td>
        </tr>
        <tr>
          <th>11</th>
          <td>12</td>
          <td>7.313067e-13</td>
          <td>3.205894e-13</td>
        </tr>
        <tr>
          <th>12</th>
          <td>13</td>
          <td>5.154286e-02</td>
          <td>-1.034959e-12</td>
        </tr>
        <tr>
          <th>13</th>
          <td>14</td>
          <td>3.502288e-13</td>
          <td>-8.002637e-13</td>
        </tr>
        <tr>
          <th>14</th>
          <td>15</td>
          <td>4.286381e-02</td>
          <td>-1.639240e-12</td>
        </tr>
        <tr>
          <th>15</th>
          <td>16</td>
          <td>3.381311e-13</td>
          <td>-1.618674e-12</td>
        </tr>
        <tr>
          <th>16</th>
          <td>17</td>
          <td>-5.466254e-02</td>
          <td>1.075487e-12</td>
        </tr>
        <tr>
          <th>17</th>
          <td>18</td>
          <td>-2.703234e-12</td>
          <td>8.475658e-12</td>
        </tr>
        <tr>
          <th>18</th>
          <td>19</td>
          <td>-1.079437e-03</td>
          <td>1.327724e-12</td>
        </tr>
        <tr>
          <th>19</th>
          <td>20</td>
          <td>6.151687e-13</td>
          <td>-1.265663e-11</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 50-53

Plotting as bar graph
---------------------
Alternatively, the Harmonics can be plotted as bar graph:

.. GENERATED FROM PYTHON SOURCE LINES 53-55

.. code-block:: Python

    figure = plots.graphs.plot_harmonics(harmonic_coil)
    figure





.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>                            <div id="b53665e6-ed8b-4317-91ef-43ff646091af" class="plotly-graph-div" style="height:525px; width:100%;"></div>            <script type="text/javascript">                require(["plotly"], function(Plotly) {                    window.PLOTLYENV=window.PLOTLYENV || {};                                    if (document.getElementById("b53665e6-ed8b-4317-91ef-43ff646091af")) {                    Plotly.newPlot(                        "b53665e6-ed8b-4317-91ef-43ff646091af",                        [{"name":"bn","x":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],"y":[0,7.9474412e-13,2.4568238,1.1616829e-12,-4.9260226,-1.0540132e-12,1.7871937,5.8462197e-13,0.1380537,8.3353241e-13,0.69147758,7.3130674e-13,0.051542859,3.5022879e-13,0.042863807,3.3813107e-13,-0.054662545,-2.7032339e-12,-0.0010794374,6.151687e-13],"type":"bar"},{"name":"an","x":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],"y":[1.9864444e-12,7.4582399e-13,-1.3307484e-13,-2.7062584e-12,-2.2314231e-12,1.5043506e-12,2.3148973e-12,-7.24653e-13,-1.5200776e-12,1.977976e-12,8.256689e-13,3.2058939e-13,-1.0349593e-12,-8.002637e-13,-1.6392401e-12,-1.618674e-12,1.0754867e-12,8.4756576e-12,1.327724e-12,-1.2656627e-11],"type":"bar"}],                        {"template":{"data":{"histogram2dcontour":[{"type":"histogram2dcontour","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"choropleth":[{"type":"choropleth","colorbar":{"outlinewidth":0,"ticks":""}}],"histogram2d":[{"type":"histogram2d","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"heatmap":[{"type":"heatmap","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"heatmapgl":[{"type":"heatmapgl","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"contourcarpet":[{"type":"contourcarpet","colorbar":{"outlinewidth":0,"ticks":""}}],"contour":[{"type":"contour","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"surface":[{"type":"surface","colorbar":{"outlinewidth":0,"ticks":""},"colorscale":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]]}],"mesh3d":[{"type":"mesh3d","colorbar":{"outlinewidth":0,"ticks":""}}],"scatter":[{"fillpattern":{"fillmode":"overlay","size":10,"solidity":0.2},"type":"scatter"}],"parcoords":[{"type":"parcoords","line":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterpolargl":[{"type":"scatterpolargl","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"bar":[{"error_x":{"color":"#2a3f5f"},"error_y":{"color":"#2a3f5f"},"marker":{"line":{"color":"#E5ECF6","width":0.5},"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"bar"}],"scattergeo":[{"type":"scattergeo","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterpolar":[{"type":"scatterpolar","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"histogram":[{"marker":{"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"histogram"}],"scattergl":[{"type":"scattergl","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatter3d":[{"type":"scatter3d","line":{"colorbar":{"outlinewidth":0,"ticks":""}},"marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattermapbox":[{"type":"scattermapbox","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scatterternary":[{"type":"scatterternary","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"scattercarpet":[{"type":"scattercarpet","marker":{"colorbar":{"outlinewidth":0,"ticks":""}}}],"carpet":[{"aaxis":{"endlinecolor":"#2a3f5f","gridcolor":"white","linecolor":"white","minorgridcolor":"white","startlinecolor":"#2a3f5f"},"baxis":{"endlinecolor":"#2a3f5f","gridcolor":"white","linecolor":"white","minorgridcolor":"white","startlinecolor":"#2a3f5f"},"type":"carpet"}],"table":[{"cells":{"fill":{"color":"#EBF0F8"},"line":{"color":"white"}},"header":{"fill":{"color":"#C8D4E3"},"line":{"color":"white"}},"type":"table"}],"barpolar":[{"marker":{"line":{"color":"#E5ECF6","width":0.5},"pattern":{"fillmode":"overlay","size":10,"solidity":0.2}},"type":"barpolar"}],"pie":[{"automargin":true,"type":"pie"}]},"layout":{"autotypenumbers":"strict","colorway":["#636efa","#EF553B","#00cc96","#ab63fa","#FFA15A","#19d3f3","#FF6692","#B6E880","#FF97FF","#FECB52"],"font":{"color":"#2a3f5f"},"hovermode":"closest","hoverlabel":{"align":"left"},"paper_bgcolor":"white","plot_bgcolor":"#E5ECF6","polar":{"bgcolor":"#E5ECF6","angularaxis":{"gridcolor":"white","linecolor":"white","ticks":""},"radialaxis":{"gridcolor":"white","linecolor":"white","ticks":""}},"ternary":{"bgcolor":"#E5ECF6","aaxis":{"gridcolor":"white","linecolor":"white","ticks":""},"baxis":{"gridcolor":"white","linecolor":"white","ticks":""},"caxis":{"gridcolor":"white","linecolor":"white","ticks":""}},"coloraxis":{"colorbar":{"outlinewidth":0,"ticks":""}},"colorscale":{"sequential":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]],"sequentialminus":[[0.0,"#0d0887"],[0.1111111111111111,"#46039f"],[0.2222222222222222,"#7201a8"],[0.3333333333333333,"#9c179e"],[0.4444444444444444,"#bd3786"],[0.5555555555555556,"#d8576b"],[0.6666666666666666,"#ed7953"],[0.7777777777777778,"#fb9f3a"],[0.8888888888888888,"#fdca26"],[1.0,"#f0f921"]],"diverging":[[0,"#8e0152"],[0.1,"#c51b7d"],[0.2,"#de77ae"],[0.3,"#f1b6da"],[0.4,"#fde0ef"],[0.5,"#f7f7f7"],[0.6,"#e6f5d0"],[0.7,"#b8e186"],[0.8,"#7fbc41"],[0.9,"#4d9221"],[1,"#276419"]]},"xaxis":{"gridcolor":"white","linecolor":"white","ticks":"","title":{"standoff":15},"zerolinecolor":"white","automargin":true,"zerolinewidth":2},"yaxis":{"gridcolor":"white","linecolor":"white","ticks":"","title":{"standoff":15},"zerolinecolor":"white","automargin":true,"zerolinewidth":2},"scene":{"xaxis":{"backgroundcolor":"#E5ECF6","gridcolor":"white","linecolor":"white","showbackground":true,"ticks":"","zerolinecolor":"white","gridwidth":2},"yaxis":{"backgroundcolor":"#E5ECF6","gridcolor":"white","linecolor":"white","showbackground":true,"ticks":"","zerolinecolor":"white","gridwidth":2},"zaxis":{"backgroundcolor":"#E5ECF6","gridcolor":"white","linecolor":"white","showbackground":true,"ticks":"","zerolinecolor":"white","gridwidth":2}},"shapedefaults":{"line":{"color":"#2a3f5f"}},"annotationdefaults":{"arrowcolor":"#2a3f5f","arrowhead":0,"arrowwidth":1},"geo":{"bgcolor":"white","landcolor":"#E5ECF6","subunitcolor":"white","showland":true,"showlakes":true,"lakecolor":"white"},"title":{"x":0.05},"mapbox":{"style":"light"}}},"title":{"text":"Harmonic coil 1"},"xaxis":{"title":{"text":"Order"}},"yaxis":{"title":{"text":"Multipole in units"}},"barmode":"group"},                        {"responsive": true}                    ).then(function(){
                            
    var gd = document.getElementById('b53665e6-ed8b-4317-91ef-43ff646091af');
    var x = new MutationObserver(function (mutations, observer) {{
            var display = window.getComputedStyle(gd).display;
            if (!display || display === 'none') {{
                console.log([gd, 'removed!']);
                Plotly.purge(gd);
                observer.disconnect();
            }}
    }});

    // Listen for the removal of the full notebook cells
    var notebookContainer = gd.closest('#notebook-container');
    if (notebookContainer) {{
        x.observe(notebookContainer, {childList: true});
    }}

    // Listen for the clearing of the current output cell
    var outputEl = gd.closest('.output');
    if (outputEl) {{
        x.observe(outputEl, {childList: true});
    }}

                            })                };                });            </script>        </div>
    </div>
    <br />
    <br />


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

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


.. _sphx_glr_download_gen_examples_output_parsing_plot_field_quality.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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