maps4fs 1.6.81__py3-none-any.whl → 1.7.0__py3-none-any.whl

maps4fs/__init__.py

@@ -1,7 +1,7 @@
 # pylint: disable=missing-module-docstring
 from maps4fs.generator.dtm.dtm import DTMProvider
 from maps4fs.generator.dtm.srtm import SRTM30Provider
-from maps4fs.generator.dtm.usgs import USGS1mProvider
+from maps4fs.generator.dtm.usgs import USGSProvider
 from maps4fs.generator.game import Game
 from maps4fs.generator.map import Map
 from maps4fs.generator.settings import (

maps4fs/generator/component.py

@@ -188,8 +188,7 @@ class Component:
         self,
         coordinates: tuple[float, float] | None = None,
         distance: int | None = None,
-        project_utm: bool = False,
-    ) -> tuple[int, int, int, int]:
+    ) -> tuple[float, float, float, float]:
         """Calculates the bounding box of the map from the coordinates and the height and
         width of the map.
         If coordinates and distance are not provided, the instance variables are used.
@@ -199,24 +198,23 @@ class Component:
                 of the map. Defaults to None.
             distance (int, optional): The distance from the center of the map to the edge of the
                 map in all directions. Defaults to None.
-            project_utm (bool, optional): Whether to project the bounding box to UTM.
 
         Returns:
-            tuple[int, int, int, int]: The bounding box of the map.
+            tuple[float, float, float, float]: The bounding box of the map.
         """
         coordinates = coordinates or self.coordinates
         distance = distance or int(self.map_rotated_size / 2)
 
         west, south, east, north = ox.utils_geo.bbox_from_point(  # type: ignore
-            coordinates, dist=distance, project_utm=project_utm
+            coordinates,
+            dist=distance,
         )
 
         bbox = north, south, east, west
         self.logger.debug(
-            "Calculated bounding box for component: %s: %s, project_utm: %s, distance: %s",
+            "Calculated bounding box for component: %s: %s, distance: %s",
             self.__class__.__name__,
             bbox,
-            project_utm,
             distance,
         )
         return bbox
@@ -225,7 +223,7 @@ class Component:
         """Saves the bounding box of the map to the component instance from the coordinates and the
         height and width of the map.
         """
-        self.bbox = self.get_bbox(project_utm=False)
+        self.bbox = self.get_bbox()
         self.logger.debug("Saved bounding box: %s", self.bbox)
 
     @property
@@ -544,17 +542,10 @@ class Component:
         """
 
         scaling_factor = 1 / self.map.dem_settings.multiplier
-        self.logger.debug("Z scaling factor including DEM multiplier: %s", scaling_factor)
 
         if self.map.shared_settings.height_scale_multiplier:
             scaling_factor *= self.map.shared_settings.height_scale_multiplier
-            self.logger.debug(
-                "Z scaling factor including height scale multiplier: %s", scaling_factor
-            )
         if self.map.shared_settings.mesh_z_scaling_factor:
             scaling_factor *= 1 / self.map.shared_settings.mesh_z_scaling_factor
-            self.logger.debug(
-                "Z scaling factor including mesh z scaling factor: %s", scaling_factor
-            )
 
         return scaling_factor

maps4fs/generator/dtm/dtm.py

@@ -4,6 +4,7 @@ and specific settings for downloading and processing the data."""
 
 from __future__ import annotations
 
+from abc import ABC, abstractmethod
 import os
 from typing import TYPE_CHECKING, Type
 
@@ -23,19 +24,22 @@ class DTMProviderSettings(BaseModel):
     """Base class for DTM provider settings models."""
 
 
-class DTMProvider:
+# pylint: disable=too-many-public-methods
+class DTMProvider(ABC):
     """Base class for DTM providers."""
 
     _code: str | None = None
     _name: str | None = None
     _region: str | None = None
     _icon: str | None = None
-    _resolution: float | None = None
+    _resolution: float | str | None = None
 
     _url: str | None = None
 
     _author: str | None = None
+    _contributors: str | None = None
     _is_community: bool = False
+    _is_base: bool = False
     _settings: Type[DTMProviderSettings] | None = None
 
     _instructions: str | None = None
@@ -120,6 +124,24 @@ class DTMProvider:
         """
         return cls._author
 
+    @classmethod
+    def contributors(cls) -> str | None:
+        """Contributors of the provider.
+
+        Returns:
+            str: Contributors of the provider.
+        """
+        return cls._contributors
+
+    @classmethod
+    def is_base(cls) -> bool:
+        """Is the provider a base provider.
+
+        Returns:
+            bool: True if the provider is a base provider, False otherwise.
+        """
+        return cls._is_base
+
     @classmethod
     def is_community(cls) -> bool:
         """Is the provider a community-driven project.
@@ -190,7 +212,8 @@ class DTMProvider:
         """
         providers = {}
         for provider in cls.__subclasses__():
-            providers[provider._code] = provider.description()  # pylint: disable=W0212
+            if not provider.is_base():
+                providers[provider._code] = provider.description()  # pylint: disable=W0212
         return providers  # type: ignore
 
     def download_tile(self, output_path: str, **kwargs) -> bool:
@@ -235,6 +258,7 @@ class DTMProvider:
         """
         raise NotImplementedError
 
+    @abstractmethod
     def get_numpy(self) -> np.ndarray:
         """Get numpy array of the tile.
         Resulting array must be 16 bit (signed or unsigned) integer and it should be already

maps4fs/generator/dtm/usgs.py

@@ -1,37 +1,47 @@
-"""This module contains provider of USGS 1m data."""
+"""This module contains provider of USGS data."""
 
 import os
 from datetime import datetime
+from zipfile import ZipFile
 
 import numpy as np
-import rasterio  # type: ignore
+import rasterio
 import requests
-from rasterio._warp import Resampling  # type: ignore # pylint: disable=E0611
-from rasterio.merge import merge  # type: ignore
-from rasterio.warp import calculate_default_transform, reproject  # type: ignore
-from rasterio.windows import from_bounds  # type: ignore
+from rasterio.enums import Resampling
+from rasterio.merge import merge
+from rasterio.warp import calculate_default_transform, reproject
+from rasterio.windows import from_bounds
 
 from maps4fs.generator.dtm.dtm import DTMProvider, DTMProviderSettings
 
 
-class USGS1mProviderSettings(DTMProviderSettings):
-    """Settings for the USGS 1m provider."""
+class USGSProviderSettings(DTMProviderSettings):
+    """Settings for the USGS provider."""
 
     max_local_elevation: int = 255
+    dataset: tuple | str = (
+        'Digital Elevation Model (DEM) 1 meter',
+        'Alaska IFSAR 5 meter DEM',
+        'National Elevation Dataset (NED) 1/9 arc-second',
+        'National Elevation Dataset (NED) 1/3 arc-second',
+        'National Elevation Dataset (NED) 1 arc-second',
+        'National Elevation Dataset (NED) Alaska 2 arc-second',
+        'Original Product Resolution (OPR) Digital Elevation Model (DEM)',
+    )
 
 
-# pylint: disable=W0223
-class USGS1mProvider(DTMProvider):
+class USGSProvider(DTMProvider):
     """Provider of USGS."""
 
-    _code = "USGS1m"
-    _name = "USGS 1m"
+    _code = "USGS"
+    _name = "USGS"
     _region = "USA"
     _icon = "🇺🇸"
-    _resolution = 1
+    _resolution = 'variable'
     _data: np.ndarray | None = None
-    _settings = USGS1mProviderSettings
+    _settings = USGSProviderSettings
     _author = "[ZenJakey](https://github.com/ZenJakey)"
+    _contributors = "[kbrandwijk](https://github.com/kbrandwijk)"
     _is_community = True
     _instructions = (
         "ℹ️ Set the max local elevation to approx the local max elevation for your area in"
@@ -40,8 +50,8 @@ class USGS1mProvider(DTMProvider):
     )
 
     _url = (
-        "https://tnmaccess.nationalmap.gov/api/v1/products?prodFormats=GeoTIFF,IMG&prodExtents="
-        "10000 x 10000 meter&datasets=Digital Elevation Model (DEM) 1 meter&polygon="
+        "https://tnmaccess.nationalmap.gov/api/v1/products?prodFormats=GeoTIFF,IMG"
+
     )
 
     def __init__(self, *args, **kwargs):
@@ -64,7 +74,8 @@ class USGS1mProvider(DTMProvider):
             (north, south, east, west) = self.get_bbox()
             response = requests.get(  # pylint: disable=W3101
                 self.url  # type: ignore
-                + f"{west} {south},{east} {south},{east} {north},{west} {north},{west} {south}&="
+                + f"&datasets={self.user_settings.dataset}"  # type: ignore
+                + f"&bbox={west},{north},{east},{south}"
             )
             self.logger.debug("Getting file locations from USGS...")
 
@@ -75,7 +86,7 @@ class USGS1mProvider(DTMProvider):
                 items = json_data["items"]
                 for item in items:
                     urls.append(item["downloadURL"])
-                self.download_tif_files(urls)
+                # self.download_tif_files(urls)
             else:
                 self.logger.error("Failed to get data. HTTP Status Code: %s", response.status_code)
         except requests.exceptions.RequestException as e:
@@ -108,12 +119,24 @@ class USGS1mProvider(DTMProvider):
                         for chunk in response.iter_content(chunk_size=8192):  # Download in chunks
                             file.write(chunk)
                     self.logger.info("File downloaded successfully: %s", file_path)
+                    if file_name.endswith('.zip'):
+                        with ZipFile(file_path, "r") as f_in:
+                            f_in.extract(file_name.replace('.zip', '.img'), self.shared_tiff_path)
+                        tif_files.append(file_path.replace('.zip', '.img'))
+                    else:
+                        tif_files.append(file_path)
                 except requests.exceptions.RequestException as e:
                     self.logger.error("Failed to download file: %s", e)
             else:
                 self.logger.debug("File already exists: %s", file_name)
+                if file_name.endswith('.zip'):
+                    if not os.path.exists(file_path.replace('.zip', '.img')):
+                        with ZipFile(file_path, "r") as f_in:
+                            f_in.extract(file_name.replace('.zip', '.img'), self.shared_tiff_path)
+                    tif_files.append(file_path.replace('.zip', '.img'))
+                else:
+                    tif_files.append(file_path)
 
-            tif_files.append(file_path)
         return tif_files
 
     def merge_geotiff(self, input_files: list[str], output_file: str) -> None:

maps4fs/generator/settings.py

@@ -183,5 +183,5 @@ class SatelliteSettings(SettingsModel):
     """
 
     download_images: bool = False
-    satellite_margin: int = 100
+    satellite_margin: int = 0
     zoom_level: int = 14

maps4fs/generator/texture.py

@@ -336,19 +336,12 @@ class Texture(Component):
     # pylint: disable=W0201
     def _read_parameters(self) -> None:
         """Reads map parameters from OSM data, such as:
-        - minimum and maximum coordinates in UTM format
+        - minimum and maximum coordinates
         - map dimensions in meters
         - map coefficients (meters per pixel)
         """
-        north, south, east, west = self.get_bbox(project_utm=True)
-
-        # Parameters of the map in UTM format (meters).
-        self.minimum_x = min(west, east)
-        self.minimum_y = min(south, north)
-        self.maximum_x = max(west, east)
-        self.maximum_y = max(south, north)
-        self.logger.debug("Map minimum coordinates (XxY): %s x %s.", self.minimum_x, self.minimum_y)
-        self.logger.debug("Map maximum coordinates (XxY): %s x %s.", self.maximum_x, self.maximum_y)
+        bbox = ox.utils_geo.bbox_from_point(self.coordinates, dist=self.map_rotated_size / 2)
+        self.minimum_x, self.minimum_y, self.maximum_x, self.maximum_y = bbox
 
     def info_sequence(self) -> dict[str, Any]:
         """Returns the JSON representation of the generation info for textures."""
@@ -576,29 +569,19 @@ class Texture(Component):
             cv2.imwrite(layer_path, img)
             self.logger.debug("Base texture %s saved.", layer_path)
 
-    def get_relative_x(self, x: float) -> int:
-        """Converts UTM X coordinate to relative X coordinate in map image.
+    def latlon_to_pixel(self, lat: float, lon: float) -> tuple[int, int]:
+        """Converts latitude and longitude to pixel coordinates.
 
         Arguments:
-            x (float): UTM X coordinate.
+            lat (float): Latitude.
+            lon (float): Longitude.
 
         Returns:
-            int: Relative X coordinate in map image.
+            tuple[int, int]: Pixel coordinates.
         """
-        return int(self.map_rotated_size * (x - self.minimum_x) / (self.maximum_x - self.minimum_x))
-
-    def get_relative_y(self, y: float) -> int:
-        """Converts UTM Y coordinate to relative Y coordinate in map image.
-
-        Arguments:
-            y (float): UTM Y coordinate.
-
-        Returns:
-            int: Relative Y coordinate in map image.
-        """
-        return int(
-            self.map_rotated_size * (1 - (y - self.minimum_y) / (self.maximum_y - self.minimum_y))
-        )
+        x = int((lon - self.minimum_x) / (self.maximum_x - self.minimum_x) * self.map_rotated_size)
+        y = int((lat - self.maximum_y) / (self.minimum_y - self.maximum_y) * self.map_rotated_size)
+        return x, y
 
     def np_to_polygon_points(self, np_array: np.ndarray) -> list[tuple[int, int]]:
         """Converts numpy array of polygon points to list of tuples.
@@ -623,11 +606,13 @@ class Texture(Component):
         Returns:
             np.ndarray: Numpy array of polygon points.
         """
-        xs, ys = geometry.exterior.coords.xy
-        xs = [int(self.get_relative_x(x)) for x in xs.tolist()]
-        ys = [int(self.get_relative_y(y)) for y in ys.tolist()]
-        pairs = list(zip(xs, ys))
-        return np.array(pairs, dtype=np.int32).reshape((-1, 1, 2))
+        coords = list(geometry.exterior.coords)
+        pts = np.array(
+            [self.latlon_to_pixel(coord[1], coord[0]) for coord in coords],
+            np.int32,
+        )
+        pts = pts.reshape((-1, 1, 2))
+        return pts
 
     def _to_polygon(
         self, obj: pd.core.series.Series, width: int | None
@@ -664,9 +649,20 @@ class Texture(Component):
         Returns:
             shapely.geometry.polygon.Polygon: Polygon geometry.
         """
-        polygon = geometry.buffer(width)
+        polygon = geometry.buffer(self.meters_to_degrees(width) if width else 0)
         return polygon
 
+    def meters_to_degrees(self, meters: int) -> float:
+        """Converts meters to degrees.
+
+        Arguments:
+            meters (int): Meters.
+
+        Returns:
+            float: Degrees.
+        """
+        return meters / 111320
+
     def _skip(
         self, geometry: shapely.geometry.polygon.Polygon, *args, **kwargs
     ) -> shapely.geometry.polygon.Polygon:
@@ -724,46 +720,43 @@ class Texture(Component):
         except Exception as e:  # pylint: disable=W0718
             self.logger.debug("Error fetching objects for tags: %s. Error: %s.", tags, e)
             return
-        objects_utm = ox.projection.project_gdf(objects, to_latlong=False)
-        self.logger.debug("Fetched %s elements for tags: %s.", len(objects_utm), tags)
+        self.logger.debug("Fetched %s elements for tags: %s.", len(objects), tags)
 
         method = self.linestrings_generator if yield_linestrings else self.polygons_generator
 
-        yield from method(objects_utm, width, is_fieds)
+        yield from method(objects, width, is_fieds)
 
     def linestrings_generator(
-        self, objects_utm: pd.core.frame.DataFrame, *args, **kwargs
+        self, objects: pd.core.frame.DataFrame, *args, **kwargs
     ) -> Generator[list[tuple[int, int]], None, None]:
         """Generator which yields lists of point coordinates which represent LineStrings from OSM.
 
         Arguments:
-            objects_utm (pd.core.frame.DataFrame): Dataframe with OSM objects in UTM format.
+            objects (pd.core.frame.DataFrame): Dataframe with OSM objects.
 
         Yields:
             Generator[list[tuple[int, int]], None, None]: List of point coordinates.
         """
-        for _, obj in objects_utm.iterrows():
+        for _, obj in objects.iterrows():
             geometry = obj["geometry"]
             if isinstance(geometry, shapely.geometry.linestring.LineString):
-                points = [
-                    (self.get_relative_x(x), self.get_relative_y(y)) for x, y in geometry.coords
-                ]
+                points = [self.latlon_to_pixel(x, y) for y, x in geometry.coords]
                 yield points
 
     def polygons_generator(
-        self, objects_utm: pd.core.frame.DataFrame, width: int | None, is_fieds: bool
+        self, objects: pd.core.frame.DataFrame, width: int | None, is_fieds: bool
     ) -> Generator[np.ndarray, None, None]:
         """Generator which yields numpy arrays of polygons from OSM data.
 
         Arguments:
-            objects_utm (pd.core.frame.DataFrame): Dataframe with OSM objects in UTM format.
+            objects (pd.core.frame.DataFrame): Dataframe with OSM objects.
             width (int | None): Width of the polygon in meters (only for LineString).
             is_fieds (bool): Flag to determine if the fields should be padded.
 
         Yields:
             Generator[np.ndarray, None, None]: Numpy array of polygon points.
         """
-        for _, obj in objects_utm.iterrows():
+        for _, obj in objects.iterrows():
             try:
                 polygon = self._to_polygon(obj, width)
             except Exception as e:  # pylint: disable=W0703
@@ -773,7 +766,9 @@ class Texture(Component):
                 continue
 
             if is_fieds and self.map.texture_settings.fields_padding > 0:
-                padded_polygon = polygon.buffer(-self.map.texture_settings.fields_padding)
+                padded_polygon = polygon.buffer(
+                    -self.meters_to_degrees(self.map.texture_settings.fields_padding)
+                )
 
                 if not isinstance(padded_polygon, shapely.geometry.polygon.Polygon):
                     self.logger.warning("The padding value is too high, field will not padded.")

{maps4fs-1.6.81.dist-info → maps4fs-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.6.81
+Version: 1.7.0
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License

{maps4fs-1.6.81.dist-info → maps4fs-1.7.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
-maps4fs/__init__.py,sha256=WbT36EzJ_74GN0RUUrLIYECdSdtRiZaxKl17KUt7pjA,492
+maps4fs/__init__.py,sha256=LrWSsyWaU28Dzcs7sRycywO_LvM-j34UvtafyBhvdx4,490
 maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/generator/background.py,sha256=tV4UXvtkNN-OSvv6ujp4jFWRU1xGBgEvSakVGZ1H4nc,24877
-maps4fs/generator/component.py,sha256=vn_ThQw3OTcloqYuJWC7vghAvIAnwJsybEm7qMwvsZk,21356
+maps4fs/generator/component.py,sha256=pbpGaWy5C0UzxpcJ72HPY2gMol98snDr-bvNZSX4yY0,20823
 maps4fs/generator/config.py,sha256=0QmK052B8bxyHVhg3jzCORLfOBMMmqVfhhbqXKf6OMk,4383
 maps4fs/generator/dem.py,sha256=20gx0dzX0LyO6ipvDitst-BwGfcKogFqgQf9Q2qMH5U,10933
 maps4fs/generator/game.py,sha256=Nf5r2ubV4YVAVHGzJyhbF2GnOC0qV3HlHYIZBCWciHs,7992
@@ -11,17 +11,17 @@ maps4fs/generator/i3d.py,sha256=pUyHKWKcw43xVCf3Y8iabtbQba05LYxMHi8vziGksIA,2484
 maps4fs/generator/map.py,sha256=a50KQEr1XZKjS_WKXywGwh4OC3gyjY6M8FTc0eNcxpg,10183
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
 maps4fs/generator/satellite.py,sha256=_7RcuNmR1mjxEJWMDsjnzKUIqWxnGUn50XtjB7HmSPg,3661
-maps4fs/generator/settings.py,sha256=3ASf3hW1nkGt8_3IOvKIKNUd6XAHYTAA8FquuhpSUlU,5668
-maps4fs/generator/texture.py,sha256=gIXCHU1vT3evbkaXAV9gLUrgI1wH3xJLgWAtZgFruj0,34013
+maps4fs/generator/settings.py,sha256=9vbXISQrE-aDY7ATpvZ7LVJMqjfwa3-gNl-huI8XLO0,5666
+maps4fs/generator/texture.py,sha256=tDC9lIx2qn8d09Gu6PW_Lbq7EK7s1N4l25p50v92xl8,33548
 maps4fs/generator/dtm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maps4fs/generator/dtm/dtm.py,sha256=azy-RWsc5PgenKDtgG0lrddMwWEw1hYzdng9V8zphMk,9167
+maps4fs/generator/dtm/dtm.py,sha256=nCQKQygARLxaz4HkREQQd0Yb03oKOf1Iav5_VoZsFWI,9819
 maps4fs/generator/dtm/srtm.py,sha256=2-pX6bWrJX6gr8IM7ueX6mm_PW7_UQ58MtdzDHae2OQ,9030
-maps4fs/generator/dtm/usgs.py,sha256=ZTi10RNDA3EBrsVg2ZoYrdN4uqiG1Jvk7FzdcKdgNkU,13408
+maps4fs/generator/dtm/usgs.py,sha256=hwVjoSNTNRU6hwnfwJ2d3rOdtOjadCmx2QESA2REn6s,14493
 maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/toolbox/background.py,sha256=9BXWNqs_n3HgqDiPztWylgYk_QM4YgBpe6_ZNQAWtSc,2154
 maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
-maps4fs-1.6.81.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.6.81.dist-info/METADATA,sha256=D38DfL8D4KUjRwcWH9yscOgGvpx7dOgj1W-Qazz4sxk,39161
-maps4fs-1.6.81.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-maps4fs-1.6.81.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.6.81.dist-info/RECORD,,
+maps4fs-1.7.0.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.7.0.dist-info/METADATA,sha256=MNEtaRLPbGmFgR7jJ_4ViotLPEmDEQ4MydSlOZVJdyg,39160
+maps4fs-1.7.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+maps4fs-1.7.0.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.7.0.dist-info/RECORD,,

{maps4fs-1.6.81.dist-info → maps4fs-1.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.7.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any