from ...util.classification import JensenPlot as _JensenPlot
from ...util.log import Handle
from ...util.meta import update_docstring_references
from ...util.plot.axes import init_axes
logger = Handle(__name__)
[docs]@update_docstring_references
def JensenPlot(ax=None, add_labels=False, color="k", **kwargs):
"""
Jensen Plot for classification of sub-alkaline volcanic rocks [#ref_1]_.
Parameters
----------
ax : :class:`matplotlib.axes.Axes`
Axes to add the template on to.
add_labels : :class:`bool`
Whether to include the labels for the diagram.
color : :class:`str`
Line color for the diagram.
Returns
-------
ax : :class:`matplotlib.axes.Axes`
References
----------
.. [#ref_1] Jensen, L. S. (1976). A new cation plot for classifying
sub-alkaline volcanic rocks.
Ontario Division of Mines. Miscellaneous Paper No. 66.
Notes
-----
Diagram used for the classification classification of subalkalic volcanic rocks.
The diagram is constructed for molar cation percentages of Al, Fe+Ti and Mg,
on account of these elements' stability upon metamorphism.
This particular version uses updated labels relative to Jensen (1976),
in which the fields have been extended to the full range of the ternary plot.
"""
ax = init_axes(ax=ax, projection="ternary", **kwargs)
clf = _JensenPlot()
clf.add_to_axes(ax=ax, color=color, add_labels=add_labels, **kwargs)
return ax