geodata.mask.show
=================

.. py:function:: geodata.mask.show(raster: rasterio.DatasetReader | str, shape: Optional[geopandas.GeoSeries] = None, shape_width: float = 0.5, shape_color: str = 'black', figsize: tuple[float, float] = (10, 6), title: Optional[str] = None, title_size: float = 12, lat_lon: bool = True, colorbar: bool = True, grid: bool = False, return_fig: bool = False, **kwargs) -> Optional[matplotlib.pyplot.Figure]

   Plot a raster file.

   :param raster: A `rasterio.DatasetReader` or string. If a string is passed,
                  the method will open the raster file using `open_tif()` method.
   :type raster: ras.DatasetReader | str
   :param shape: Shapes to be plotted over the raster. None by default.
   :type shape: geopandas.GeoSeries
   :param shape_width: The line width for plotting shapes. 0.5 by default.
   :type shape_width: float
   :param shape_color: Color of the shape border. Black by default.
   :type shape_color: str
   :param figsize: The size of the figure. (10, 6) by default.
   :type figsize: tuple[float, float]
   :param title: The title of the plot. If not specified, the title will be the name of the raster.
   :type title: str
   :param lat_lon: Whether the program will show the lat/long coordinates in the plot. True by default.
   :type lat_lon: bool
   :param colorbar: Whether the program shows the legend for the values of the plot. True by default.
   :type colorbar: bool
   :param grid: whether the program shows the grid. False by default.
   :type grid: bool
   :param return_fig: Whether to return the matplotlib figure. False by default.
   :type return_fig: bool
   :param \*\*kwargs: Other keyword arguments to be passed to `matplotlib.pyplot.imshow()`.

   :returns: The matplotlib figure. Only returned if `return_fig` is True.
   :rtype: matplotlib.figure.Figure