Merge pull request #50 from Freeman-Trader/refactor-annotations

Refactor annotations

Author: ColCarroll

README.md

@@ -278,6 +278,50 @@ ridges.plot(*scipp_coords, 'o',
             zorder=len(values)+10)
 ```
 
+#### Updated Annotation and Custom Text Color
+The above code still works, but now there is a simplified method (Shown Below) that will produce the same image.
+
+```python
+import matplotlib.pyplot as plt
+import numpy as np
+
+from ridge_map import RidgeMap
+
+bgcolor = np.array([65,74,76])/255.
+
+rm = RidgeMap((-122.087116,36.945365,-121.999226,37.023250))
+values = rm.get_elevation_data(num_lines=150)
+values = rm.preprocess(
+    values=values, 
+    lake_flatness=1, 
+    water_ntile=0, 
+    vertical_ratio=240
+)
+            
+rm.plot_map(
+    values=values,
+    label='Santa Cruz\nMountains',
+    label_x=0.75,
+    label_y=0.05,
+    label_size=36,
+    label_color='white',
+    kind='elevation',
+    linewidth=1,
+    background_color=bgcolor,
+    line_color = plt.get_cmap('cool')
+)
+
+rm.plot_annotation(
+    label='SCIPP', 
+    coordinates=(-122.060510, 36.998776), 
+    x_offset=0.005, 
+    y_offset=0.005, 
+    label_size=20, 
+    annotation_size=6, 
+    color='white',
+    background=False
+)
+```
 ![png](https://github.com/ColCarroll/ridge_map/blob/main/examples/santa_cruz.png?raw=true)
 
 Elevation Data

ridge_map/ridge_map.py

@@ -79,7 +79,7 @@ def __init__(self, bbox=(-71.928864, 43.758201, -70.957947, 44.465151), font=Non
         if font is None:
             font = FontManager().prop
         self.font = font
-        self.annotations = []
+        self.ax = None
 
     @property
     def lats(self):
@@ -181,7 +181,7 @@ def preprocess(
         return values
 
     # pylint: disable=too-many-arguments,too-many-positional-arguments
-    def add_annotation(
+    def plot_annotation(
         self,
         label="Mount Washington",
         coordinates=(-71.3173, 44.2946),
@@ -191,10 +191,11 @@ def add_annotation(
         annotation_size=8,
         color=None,
         background=True,
+        ax=None,
     ):
-        """Save an annotation.
+        """Plot an annotation to an existing map
 
-        Must call before plot_map()
+        It is recommended to call this function only after calling map_plot()
 
         Parameters
         ----------
@@ -214,20 +215,60 @@ def add_annotation(
             Color for the label. If None, then uses label_color of map
         background : bool
             If there is a background or not
-        """
-        self.annotations.append(
-            (
-                label,
-                coordinates,
-                x_offset,
-                y_offset,
-                label_size,
-                annotation_size,
-                color,
-                background,
-            )
+        ax : matplotlib Axes
+            You can pass your own axes, but probably best not to
+            
+        Returns
+        -------
+        matplotlib.Axes
+        """        
+        if ax is None and self.ax is None:
+            raise ValueError("No axes found: Either plot_map() beforehand or pass an matplotlib.Axes value through")
+        elif ax is None:
+            ax = self.ax
+            
+        highest_zorder = max(text.zorder for text in ax.texts) if ax.texts else 1
+            
+        rel_coordinates = (
+            (coordinates[0] - self.longs[0]) / (self.longs[1] - self.longs[0]),
+            (coordinates[1] - self.lats[0]) / (self.lats[1] - self.lats[0]),
         )
+        
+        annotation_color = "black"
+        if color:
+            annotation_color = color
+        elif ax.texts[0].get_color():
+            annotation_color = ax.texts[0].get_color()
 
+        ax.text(
+            rel_coordinates[0] + x_offset,
+            rel_coordinates[1] + y_offset,
+            label,
+            fontproperties=self.font,
+            size=label_size,
+            color=annotation_color,
+            transform=ax.transAxes,
+            bbox=(
+                {"facecolor": ax.get_facecolor(), "alpha": 1, "linewidth": 1}
+                if background
+                else None
+            ),
+            verticalalignment="bottom",
+            zorder=highest_zorder,
+        )
+
+        ax.plot(
+            *rel_coordinates,
+            "o",
+            color=annotation_color,
+            transform=ax.transAxes,
+            ms=annotation_size,
+            zorder=highest_zorder,
+        )
+        
+        self.ax = ax
+        return ax
+        
     # pylint: disable=too-many-arguments,too-many-locals
     def plot_map(
         self,
@@ -286,47 +327,6 @@ def plot_map(
         matplotlib.Axes
         """
 
-        def plot_annotations():
-            """Plot the annotations.
-
-            Takes all the annotations from self.annotations and adds them to the map
-            """
-            for annotation in self.annotations:
-                rel_coordinates = (
-                    (annotation[1][0] - self.longs[0])
-                    / (self.longs[1] - self.longs[0]),
-                    (annotation[1][1] - self.lats[0]) / (self.lats[1] - self.lats[0]),
-                )
-                annotation_color = ax.texts[0].get_color()
-                if annotation[6] is not None:
-                    annotation_color = annotation[6]
-
-                ax.text(
-                    rel_coordinates[0] + annotation[2],
-                    rel_coordinates[1] + annotation[3],
-                    annotation[0],
-                    fontproperties=self.font,
-                    size=annotation[4],
-                    color=annotation_color,
-                    transform=ax.transAxes,
-                    bbox=(
-                        {"facecolor": background_color, "alpha": 1, "linewidth": 1}
-                        if annotation[7]
-                        else None
-                    ),
-                    verticalalignment="bottom",
-                    zorder=len(values) + 10,
-                )
-
-                ax.plot(
-                    *rel_coordinates,
-                    "o",
-                    color=annotation_color,
-                    transform=ax.transAxes,
-                    ms=annotation[5],
-                    zorder=len(values) + 10
-                )
-
         if kind not in {"gradient", "elevation"}:
             raise TypeError("Argument `kind` must be one of 'gradient' or 'elevation'")
         if values is None:
@@ -383,7 +383,6 @@ def plot_annotations():
         for spine in ax.spines.values():
             spine.set_visible(False)
         ax.set_facecolor(background_color)
-
-        plot_annotations()
-
+        
+        self.ax = ax
         return ax