Add labelling scheme and field subset example to plot templates

Author: morganjwilliams

docs/source/gallery/examples/plotting/templates.py

@@ -116,6 +116,24 @@
 JensenPlot(linewidth=0.4, add_labels=True, figsize=(7, 7))
 plt.show()
 ########################################################################################
+# Customization - Labelling Schemes and Field Subsets
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# For most templates, you're able to customize which labels are applied to each field.
+# This includes swapping between the 'ID' and the 'name'  (and for TAS, swapping between
+# intrusive and volcanic equivalents), as well as specifing that only fields with specific
+# IDs are added to the diagram. For example, here we add volcanic labels for a subset of
+# fields in a TAS diagram (in this case, the LeMaitre version):
+#
+ax = TAS(
+    linewidth=0.5,
+    add_labels=True,
+    which_model="LeMaitre",
+    which_labels="volcanic",
+    which_ids=["Pc", "Ba", "Bs", "O1", "O2", "U1", "U2", "U3", "S1", "S2", "S3"],
+    figsize=(10, 5),
+)
+ax.figure
+########################################################################################
 # References and other notes for diagram templates can be found within the docstrings
 # and within the pyrolite documentation:
 #

pyrolite/plot/templates/TAS.py

@@ -46,13 +46,13 @@ def TAS(
     -----------
     .. [#ref_1] Middlemost, E. A. K. (1994).
                 Naming materials in the magma/igneous rock system.
-                Earth-Science Reviews, 37(3), 215–224.
+                Earth-Science Reviews, 37(3), 215-224.
                 doi: {Middlemost1994}
 
     .. [#ref_2] Le Bas, M.J., Le Maitre, R.W., Woolley, A.R. (1992).
                 The construction of the Total Alkali-Silica chemical
                 classification of volcanic rocks.
-                Mineralogy and Petrology 46, 1–22.
+                Mineralogy and Petrology 46, 1-22.
                 doi: {LeBas1992}
 
     """

pyrolite/util/classification.py

@@ -246,8 +246,12 @@ def _add_polygons_to_axes(
             poly_config.pop("color", None)
 
         use_keys = not which_labels.lower().startswith("name")
+
+        if not which_ids:
+            which_ids = list(self.fields.keys())
+
         for k, cfg in self.fields.items():
-            if cfg["poly"] and ((k in which_ids) or (len(which_ids) == 0)):
+            if cfg["poly"] and (k in which_ids):
                 verts = self.transform(np.array(_read_poly(cfg["poly"]))) * rescale_by
                 pg = matplotlib.patches.Polygon(
                     verts,
@@ -322,6 +326,7 @@ def add_to_axes(
         ax : :class:`matplotlib.axes.Axes`
         """
         ax = init_axes(ax=ax, projection=self.projection)
+
         ax = self._add_polygons_to_axes(
             ax=ax,
             fill=fill,
@@ -466,9 +471,13 @@ def add_to_axes(
         if axes_scale is not None:  # rescale polygons to fit ax
             if not np.isclose(self.default_scale, axes_scale):
                 rescale_by = axes_scale / self.default_scale
+
+        if not which_ids:
+            which_ids = list(self.fields.keys())
+
         if add_labels:
             for k, cfg in self.fields.items():
-                if cfg["poly"] and ((k in which_ids) or (len(which_ids) == 0)):
+                if cfg["poly"] and (k in which_ids):
                     if which_labels.lower().startswith("id"):
                         label = k
                     elif which_labels.lower().startswith(