:orphan:

.. _examples-index:

.. _gallery:

########
Examples
########

This gallery contains examples of mpltern.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    </div>

Introductory
============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Lines and curves can be put using ax.plot in the same way as Matplotlib.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_00.line_and_curve_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_00.line_and_curve.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Line and curve</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Scatter plots can be done using ax.scatter.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_01.scatter_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_01.scatter.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Scatter</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Contour plots can be done using ax.tricontour or ax.tricontourf.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_02.contour_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_02.contour.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Contour</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Pseudocolor plots can be done using ax.tripcolor.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_03.pseudocolor_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_03.pseudocolor.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Pseudocolor</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The normalization constant of ternary plots can be modified using ternary_sum.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_04.normalization_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_04.normalization.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Normalization</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A line or a band horizontal to an ternary axis can be plotted by the commands axtline, axlline,...">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_05.span_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_05.span.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Span</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Texts cant be put using ax.text in the same way as Matplotlib.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_06.text_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_06.text.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Text</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Polygons in ternary plots can be put using ax.fill.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_07.polygon_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_07.polygon.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Polygon</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="2D field of arrows can be plotted using ax.quiver.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_08.quiver_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_08.quiver.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Quiver</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The grid along the tick positions can be plotted using ax.grid. See also tick locators &lt;../axis...">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_09.grid_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_09.grid.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Grid</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Axis labels can be given using e.g. ax.set_tlabel. For more detailed control, see sphx_glr_gall...">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_10.axis_labels_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_10.axis_labels.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Axis labels</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A triangular grid can be plotted by giving the grid points to ax.triplot.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_11.triangular_grid_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_11.triangular_grid.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Triangular grid</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="An infinitely long straight line can be added using ax.axline in a similar way as Matplotlib. T...">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_axline_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_axline.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">AxLine</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The legend can be put using ax.legend in the same way as Matplotlib.">

.. only:: html

  .. image:: /gallery/introductory/images/thumb/sphx_glr_legend_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_introductory_legend.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Legend</div>
    </div>


.. raw:: html

    </div>

Intermediate
============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Ternary plots of mpltern can be combined with normal Matplotlib plots very straightforwardly.">

.. only:: html

  .. image:: /gallery/intermediate/images/thumb/sphx_glr_00.with_normal_plots_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_intermediate_00.with_normal_plots.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">With normal Matplotlib plots</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="You can use style sheets in the same way as Matplotlib. This applies also for the style sheets ...">

.. only:: html

  .. image:: /gallery/intermediate/images/thumb/sphx_glr_01.style_sheets_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_intermediate_01.style_sheets.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Style sheets</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Inset">

.. only:: html

  .. image:: /gallery/intermediate/images/thumb/sphx_glr_99.inset_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_intermediate_99.inset.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Inset</div>
    </div>


.. raw:: html

    </div>

Statistics
==========



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="ax.hexbin is a 2D histogram plot, in which the bins are hexagons and the color represents the n...">

.. only:: html

  .. image:: /gallery/statistics/images/thumb/sphx_glr_hexbin_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_statistics_hexbin.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">HexBin</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="ax.tribin is a 2D histogram plot, in which the bins are triangles and the color represents the ...">

.. only:: html

  .. image:: /gallery/statistics/images/thumb/sphx_glr_tribin_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_statistics_tribin.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">TriBin</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A binned plot can be shown together with a scatter plot.">

.. only:: html

  .. image:: /gallery/statistics/images/thumb/sphx_glr_with_scatter_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_statistics_with_scatter.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Binned & scatter</div>
    </div>


.. raw:: html

    </div>

Axis and Tick
=============

The examples below show how to control tick markers, tick labels, and axis
labels.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Axis-label position can be controlled via e.g. ax.taxis.set_label_position.">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_00.axis_label_position_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_00.axis_label_position.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Axis-label position</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Axis-label rotation can be controlled via e.g. ax.taxis.set_label_rotation_mode.">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_01.axis_label_rotation_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_01.axis_label_rotation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Axis-label rotation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tick position can be controlled via e.g. ax.taxis.set_ticks_position.">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_10.tick_position_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_10.tick_position.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tick position</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tick direction can be modified via ax.tick_params(direction={&#x27;in&#x27;, &#x27;out&#x27;, &#x27;inout&#x27;}).">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_11.tick_direction_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_11.tick_direction.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tick direction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tick rotation can be modified via ax.tick_params(labelrotation={&#x27;tick&#x27;, &#x27;axis&#x27;, &#x27;horizontal&#x27;}).">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_12.tick_rotation_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_12.tick_rotation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tick rotation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tick formatters can be given in the same way as Matplotlib. Among available formatters, |Percen...">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_20.tick-formatters_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_20.tick-formatters.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tick formatters</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tick locators can be given both for major and minor ticks in the same way as Matplotlib. Gridli...">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_21.tick-locators_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_21.tick-locators.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tick locators</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tick positions can be given manually in the same way as Matplotlib.">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_30.manual_tick_positions_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_30.manual_tick_positions.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Manual tick positions</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Tick labels can be given manually in the same way as Matplotlib.">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_31.manual_ticklabels_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_31.manual_ticklabels.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Manual tick labels</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="You can give a different color for each axis.">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_98.colored_axes_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_98.colored_axes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Colored axes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="You can put tick labels inside triangle by setting labelrotation=manual and then specifying app...">

.. only:: html

  .. image:: /gallery/axis_and_tick/images/thumb/sphx_glr_99.tick_labels_inside_triangle_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_axis_and_tick_99.tick_labels_inside_triangle.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Tick labels inside triangle</div>
    </div>


.. raw:: html

    </div>

Ternary Limits
==============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Suppose we would like to crop or expand the following gray-shaded region.">

.. only:: html

  .. image:: /gallery/limits/images/thumb/sphx_glr_00.triangular_limits_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_limits_00.triangular_limits.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Triangular limits</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="    Available with mpltern&gt;=1.0.0">

.. only:: html

  .. image:: /gallery/limits/images/thumb/sphx_glr_01.hexagonal_limits_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_limits_01.hexagonal_limits.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Hexagonal limits</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="When the ternary limits are modified, the plotting region can be expanded or cropped in a diffe...">

.. only:: html

  .. image:: /gallery/limits/images/thumb/sphx_glr_02.fit_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_limits_02.fit.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plotting region fitting</div>
    </div>


.. raw:: html

    </div>

Transforms
==========

.. |Transform| replace:: ``Transform``
.. _Transform: https://matplotlib.org/stable/tutorials/advanced/transforms_tutorial.html

Mpltern is implemented as a new
`projection <https://matplotlib.org/stable/api/projections_api.html>`__
of Matplotlib by implementing several new |Transform|_ classes for ternary
plots.
This allows us to auto-position tick markers, tick labels, and axis labels with
reasonable paddings consistent with Matplotlib.

The examples below show how to use such |Transform|_ classes in mpltern.



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In mpltern, the x- and y-limits are initially [−3\ −1/2, +3\ −1/2] and [0, 1], respectively. Th...">

.. only:: html

  .. image:: /gallery/transforms/images/thumb/sphx_glr_00.cartesian_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_transforms_00.cartesian.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cartesian coordinates</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In mpltern, tick markers, tick labels, and grid lines are plotted based on ax.get_{t,l,r}axis_t...">

.. only:: html

  .. image:: /gallery/transforms/images/thumb/sphx_glr_01.ticks_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_transforms_01.ticks.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ticks</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="You can plot onto the fixed positions of the triangle by specifying tranform=ax.transTernaryAxe...">

.. only:: html

  .. image:: /gallery/transforms/images/thumb/sphx_glr_06.plot_fixed_onto_triangle_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_transforms_06.plot_fixed_onto_triangle.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot fixed onto triangle</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Arrows along the axes can be put in barycentric coordinates using transforms for TernaryAxes in...">

.. only:: html

  .. image:: /gallery/transforms/images/thumb/sphx_glr_99.arrows_along_axes_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_transforms_99.arrows_along_axes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Arrows along axes</div>
    </div>


.. raw:: html

    </div>

Triangle
========



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The triangle aspect can be modified by ax.set_aspect. For more general triangles, use rotation ...">

.. only:: html

  .. image:: /gallery/triangle/images/thumb/sphx_glr_00.aspect_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_triangle_00.aspect.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Aspect</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The triangle for a ternary plot can be rotated by rotation. Axis labels, tick labels, and tick ...">

.. only:: html

  .. image:: /gallery/triangle/images/thumb/sphx_glr_01.triangle_rotation_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_triangle_01.triangle_rotation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Triangle rotation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="You can make a ternary plot on an triangle with arbitrary shape.">

.. only:: html

  .. image:: /gallery/triangle/images/thumb/sphx_glr_02.arbitrary_triangle_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_triangle_02.arbitrary_triangle.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Arbitrary triangle</div>
    </div>


.. raw:: html

    </div>

Miscellaneous
=============



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example generates the current mpltern logo. This is based on the matplotlib logo. The dark...">

.. only:: html

  .. image:: /gallery/miscellaneous/images/thumb/sphx_glr_00.logos_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_miscellaneous_00.logos.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Mpltern logo</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Dirichlet distribution">

.. only:: html

  .. image:: /gallery/miscellaneous/images/thumb/sphx_glr_dirichlet_pdf_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_miscellaneous_dirichlet_pdf.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Dirichlet distribution</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="replicator equation">

.. only:: html

  .. image:: /gallery/miscellaneous/images/thumb/sphx_glr_evolutionary_game_theory_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_miscellaneous_evolutionary_game_theory.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Evolutionary game theory</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="USDA soil texture classes">

.. only:: html

  .. image:: /gallery/miscellaneous/images/thumb/sphx_glr_soil_texture_thumb.svg
    :alt:

  :ref:`sphx_glr_gallery_miscellaneous_soil_texture.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">USDA soil texture classes</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /gallery/introductory/index.rst
   /gallery/intermediate/index.rst
   /gallery/statistics/index.rst
   /gallery/axis_and_tick/index.rst
   /gallery/limits/index.rst
   /gallery/transforms/index.rst
   /gallery/triangle/index.rst
   /gallery/miscellaneous/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

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

      :download:`Download all examples in Python source code: gallery_python.zip </gallery/gallery_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: gallery_jupyter.zip </gallery/gallery_jupyter.zip>`


.. only:: html

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

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