matplotlib-map-utils 3.0.0__tar.gz → 3.0.1__tar.gz

{matplotlib_map_utils-3.0.0 → matplotlib_map_utils-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matplotlib-map-utils
-Version: 3.0.0
+Version: 3.0.1
 Summary: A suite of tools for creating maps in matplotlib
 Author-email: David Moss <davidmoss1221@gmail.com>
 Project-URL: Homepage, https://github.com/moss-xyz/matplotlib-map-utils/
@@ -211,6 +211,8 @@ There are two available styles for the scale bars: `boxes` and `ticks`. The quic
 
 ```python
 # Setting up a plot
+# NOTE: you MUST set the desired DPI here, when the subplots are created
+# so that the scale_bar's DPI matches!
 fig, ax = matplotlib.pyplot.subplots(1,1, figsize=(5,5), dpi=150)
 # Adding a scale bar to the upper-right corner of the axis, in the same projection as whatever geodata you plotted
 # Here, this scale bar will have the "boxes" style
@@ -221,6 +223,8 @@ An object-oriented approach is also supported:
 
 ```python
 # Setting up a plot
+# NOTE: you MUST set the desired DPI here, when the subplots are created
+# so that the scale_bar's DPI matches!
 fig, ax = matplotlib.pyplot.subplots(1,1, figsize=(5,5), dpi=150)
 # Adding a scale bar to the upper-right corner of the axis, in the same projection as whatever geodata you plotted
 # Here, we change the boxes to "ticks"
@@ -378,6 +382,8 @@ Two more projects assisted with the creation of this script:
 
 - `v3.0.0`: Release of inset map and extent and detail indicator classes and functions.
 
+- `v3.0.1`: Fixed a bug that led to an incorrect Scale Bar being rendered when using the function method (`scale_bar()`) on a plot containing raster data (see [here](https://github.com/moss-xyz/matplotlib-map-utils/issues/10) for details).
+
 #### Future Roadmap
 
 With the release of `v3.x`, this project has achieved full coverage of the "main" map elements I think are necessary.

{matplotlib_map_utils-3.0.0 → matplotlib_map_utils-3.0.1}/README.md

@@ -192,6 +192,8 @@ There are two available styles for the scale bars: `boxes` and `ticks`. The quic
 
 ```python
 # Setting up a plot
+# NOTE: you MUST set the desired DPI here, when the subplots are created
+# so that the scale_bar's DPI matches!
 fig, ax = matplotlib.pyplot.subplots(1,1, figsize=(5,5), dpi=150)
 # Adding a scale bar to the upper-right corner of the axis, in the same projection as whatever geodata you plotted
 # Here, this scale bar will have the "boxes" style
@@ -202,6 +204,8 @@ An object-oriented approach is also supported:
 
 ```python
 # Setting up a plot
+# NOTE: you MUST set the desired DPI here, when the subplots are created
+# so that the scale_bar's DPI matches!
 fig, ax = matplotlib.pyplot.subplots(1,1, figsize=(5,5), dpi=150)
 # Adding a scale bar to the upper-right corner of the axis, in the same projection as whatever geodata you plotted
 # Here, we change the boxes to "ticks"
@@ -359,6 +363,8 @@ Two more projects assisted with the creation of this script:
 
 - `v3.0.0`: Release of inset map and extent and detail indicator classes and functions.
 
+- `v3.0.1`: Fixed a bug that led to an incorrect Scale Bar being rendered when using the function method (`scale_bar()`) on a plot containing raster data (see [here](https://github.com/moss-xyz/matplotlib-map-utils/issues/10) for details).
+
 #### Future Roadmap
 
 With the release of `v3.x`, this project has achieved full coverage of the "main" map elements I think are necessary.

{matplotlib_map_utils-3.0.0 → matplotlib_map_utils-3.0.1}/matplotlib_map_utils/core/scale_bar.py

@@ -280,6 +280,13 @@ def scale_bar(ax, draw=True, style: Literal["ticks","boxes"]="boxes",
     ##### CONFIG #####
 
     # Getting the config for the bar (length, text, divs, etc.)
+    if draw:
+        ax.get_figure().draw_without_rendering()
+
+    # window = ax.get_window_extent()
+    # tight = ax.patch.get_tightbbox()
+    # print(f"{draw} Window: width {round(window.width,2)} ({round(ax.get_figure().dpi_scale_trans.inverted().transform([window.width,0])[0],2)}), height {round(window.height,2)} ({round(ax.get_figure().dpi_scale_trans.inverted().transform([0,window.height])[1],2)})")
+    # print(f"{draw} Tight: width {round(tight.width,2)} ({round(ax.get_figure().dpi_scale_trans.inverted().transform([tight.width,0])[0],2)}), height {round(tight.height,2)} ({round(ax.get_figure().dpi_scale_trans.inverted().transform([0,tight.height])[1],2)})")
     bar_max, bar_length, units_label, major_div, minor_div = _config_bar(ax, _bar)
 
     # Getting the config for the segments (width, label, etc.)
@@ -452,7 +459,6 @@ def scale_bar(ax, draw=True, style: Literal["ticks","boxes"]="boxes",
 
     # AOB will contain the final artist
     aob_box = matplotlib.offsetbox.AnchoredOffsetbox(loc="center", child=major_pack, frameon=False, pad=0, borderpad=0)
-
     # Function that will handle invisibly rendering our object, returning an image
     img_scale_bar = _render_as_image(fig_temp, ax_temp, aob_box, _bar["rotation"])
 
@@ -641,6 +647,11 @@ def _config_bar(ax, bar):
     # Literally just getting the figure for the passed axis
 
     fig = ax.get_figure()
+    # fig.draw_without_rendering()
+    # Sets the canvas for the figure to AGG (Anti-Grain Geometry)
+    # canvas = FigureCanvasAgg(fig)
+    # Draws the figure onto the canvas
+    # canvas.draw()
     
     ## ROTATION ##
     # Calculating if the rotation is vertical or horizontal
@@ -651,15 +662,15 @@ def _config_bar(ax, bar):
     # Finding the max length and optimal divisions of the scale bar
 
     # Finding the dimensions of the axis and the limits
-    # get_tightbbox() returns values in pixel coordinates
+    # get_window_extent() returns values in pixel coordinates
     # so dividing by dpi gets us the inches of the axis
     # Vertical scale bars are oriented against the y-axis (height)
     if bar_vertical==True:
-        ax_dim = ax.patch.get_tightbbox().height / fig.dpi
+        ax_dim = ax.patch.get_window_extent().height / fig.dpi
         min_lim, max_lim = ax.get_ylim()
     # Horizontal scale bars are oriented against the x-axis (width)
     else:
-        ax_dim = ax.patch.get_tightbbox().width / fig.dpi
+        ax_dim = ax.patch.get_window_extent().width / fig.dpi
         min_lim, max_lim = ax.get_xlim()
     # This calculates the range from max to min on the axis of interest
     ax_range = abs(max_lim - min_lim)
@@ -1011,7 +1022,7 @@ def _temp_figure(ax, axis=False, visible=False):
     # Getting the figure of the provided axis
     fig = ax.get_figure()
     # Getting the dimensions of the axis
-    ax_bbox = ax.patch.get_tightbbox()
+    ax_bbox = ax.patch.get_window_extent()
     # Converting to inches and rounding up
     ax_dim = math.ceil(max(ax_bbox.height, ax_bbox.width) / fig.dpi)
     # Creating a new temporary figure

{matplotlib_map_utils-3.0.0 → matplotlib_map_utils-3.0.1}/matplotlib_map_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matplotlib-map-utils
-Version: 3.0.0
+Version: 3.0.1
 Summary: A suite of tools for creating maps in matplotlib
 Author-email: David Moss <davidmoss1221@gmail.com>
 Project-URL: Homepage, https://github.com/moss-xyz/matplotlib-map-utils/
@@ -211,6 +211,8 @@ There are two available styles for the scale bars: `boxes` and `ticks`. The quic
 
 ```python
 # Setting up a plot
+# NOTE: you MUST set the desired DPI here, when the subplots are created
+# so that the scale_bar's DPI matches!
 fig, ax = matplotlib.pyplot.subplots(1,1, figsize=(5,5), dpi=150)
 # Adding a scale bar to the upper-right corner of the axis, in the same projection as whatever geodata you plotted
 # Here, this scale bar will have the "boxes" style
@@ -221,6 +223,8 @@ An object-oriented approach is also supported:
 
 ```python
 # Setting up a plot
+# NOTE: you MUST set the desired DPI here, when the subplots are created
+# so that the scale_bar's DPI matches!
 fig, ax = matplotlib.pyplot.subplots(1,1, figsize=(5,5), dpi=150)
 # Adding a scale bar to the upper-right corner of the axis, in the same projection as whatever geodata you plotted
 # Here, we change the boxes to "ticks"
@@ -378,6 +382,8 @@ Two more projects assisted with the creation of this script:
 
 - `v3.0.0`: Release of inset map and extent and detail indicator classes and functions.
 
+- `v3.0.1`: Fixed a bug that led to an incorrect Scale Bar being rendered when using the function method (`scale_bar()`) on a plot containing raster data (see [here](https://github.com/moss-xyz/matplotlib-map-utils/issues/10) for details).
+
 #### Future Roadmap
 
 With the release of `v3.x`, this project has achieved full coverage of the "main" map elements I think are necessary.

{matplotlib_map_utils-3.0.0 → matplotlib_map_utils-3.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "matplotlib-map-utils"
-version = "3.0.0"
+version = "3.0.1"
 authors = [
   { name="David Moss", email="davidmoss1221@gmail.com" },
 ]