maps4fs 1.8.173__py3-none-any.whl → 1.8.175__py3-none-any.whl

maps4fs/generator/component/base/component.py

@@ -73,12 +73,8 @@ class Component:
         self.preprocess()
 
     def preprocess(self) -> None:
-        """Prepares the component for processing. Must be implemented in the child class.
-
-        Raises:
-            NotImplementedError: If the method is not implemented in the child class.
-        """
-        raise NotImplementedError
+        """Prepares the component for processing. Must be implemented in the child class."""
+        return
 
     def process(self) -> None:
         """Launches the component processing. Must be implemented in the child class.

maps4fs/generator/component/base/component_image.py

@@ -1,9 +1,12 @@
 """Base class for all components that primarily used to work with images."""
 
+import os
+
 import cv2
 import numpy as np
 
 from maps4fs.generator.component.base.component import Component
+from maps4fs.generator.settings import Parameters
 
 
 class ImageComponent(Component):
@@ -88,3 +91,28 @@ class ImageComponent(Component):
 
         image[mask] = image[mask] - subtract_by
         return image
+
+    @staticmethod
+    def resize_to_preview(image_path: str, save_path: str) -> None:
+        """Resizes an image to the preview size.
+
+        Arguments:
+            image_path (str): The path to the image.
+            save_path (str): The path to save the resized image.
+        """
+        if not os.path.isfile(image_path):
+            return
+
+        image = cv2.imread(image_path)
+        if image is None:
+            return
+
+        if (
+            image.shape[0] > Parameters.PREVIEW_MAXIMUM_SIZE
+            or image.shape[1] > Parameters.PREVIEW_MAXIMUM_SIZE
+        ):
+            image = cv2.resize(
+                image, (Parameters.PREVIEW_MAXIMUM_SIZE, Parameters.PREVIEW_MAXIMUM_SIZE)
+            )
+
+        cv2.imwrite(save_path, image)

maps4fs/generator/component/satellite.py

@@ -0,0 +1,135 @@
+"""This module contains the Satellite class for the maps4fs package to download satellite images
+for the map."""
+
+import os
+import shutil
+from typing import NamedTuple
+
+from pygmdl import save_image
+
+from maps4fs.generator.component.base.component_image import ImageComponent
+from maps4fs.generator.settings import Parameters
+
+
+class SatelliteImage(NamedTuple):
+    """Named tuple for the satellite image download task.
+
+    Attributes:
+        lat (float): The latitude of the center of the map.
+        lon (float): The longitude of the center of the map.
+        size (int): The size of the map in pixels.
+        output_path (str): The path where to save the image.
+        rotation (int): The rotation angle of the map.
+        zoom (int): The zoom level of the map.
+        copy_from (str | None): If saving should be skipped and the image should be copied from
+            another file.
+    """
+
+    lat: float
+    lon: float
+    size: int
+    output_path: str
+    rotation: int
+    zoom: int
+    copy_from: str | None = None
+
+
+class Satellite(ImageComponent):
+    """Component for to download satellite images for the map.
+
+    Arguments:
+        game (Game): The game instance for which the map is generated.
+        coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
+        map_size (int): The size of the map in pixels.
+        map_rotated_size (int): The size of the map in pixels after rotation.
+        rotation (int): The rotation angle of the map.
+        map_directory (str): The directory where the map files are stored.
+        logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
+            info, warning. If not provided, default logging will be used.
+    """
+
+    def process(self) -> None:
+        """Downloads the satellite images for the map."""
+        self.image_paths = []
+        if not self.map.satellite_settings.download_images:
+            self.logger.debug("Satellite images download is disabled.")
+            return
+
+        margin = self.map.satellite_settings.satellite_margin
+        overview_size = (self.map_size + margin) * 2
+        overwiew_path = os.path.join(self.satellite_directory, "satellite_overview.png")
+
+        background_size = self.map_size + (Parameters.BACKGROUND_DISTANCE + margin) * 2
+        background_path = os.path.join(self.satellite_directory, "satellite_background.png")
+
+        sizes = [overview_size, background_size]
+        self.image_paths = [overwiew_path, background_path]
+
+        tasks = self.get_tasks(sizes, self.image_paths)
+
+        for task in tasks:
+            try:
+                if task.copy_from and os.path.isfile(task.copy_from):
+                    shutil.copy(task.copy_from, task.output_path)
+                    continue
+
+                save_image(
+                    task.lat,
+                    task.lon,
+                    task.size,
+                    output_path=task.output_path,
+                    rotation=task.rotation,
+                    zoom=task.zoom,
+                    from_center=True,
+                    logger=self.logger,
+                )
+
+            except Exception as e:
+                self.logger.error(f"Failed to download satellite image: {e}")
+                continue
+
+    def get_tasks(self, sizes: list[int], save_paths: list[str]) -> list[SatelliteImage]:
+        """Prepares the tasks for downloading the satellite images.
+
+        Arguments:
+            sizes (list[int]): The sizes of the images to download.
+            save_paths (list[str]): The paths where to save the images.
+
+        Returns:
+            list[SatelliteImage]: The list of tasks for downloading the satellite images.
+        """
+        tasks: list[SatelliteImage] = []
+
+        for size, save_path in zip(sizes, save_paths):
+            # Check if in tasks there's already a task with the same size.
+            existing_task = next((t for t in tasks if t.size == size), None)
+            copy_from = existing_task.output_path if existing_task else None
+
+            lat, lon = self.coordinates
+            tasks.append(
+                SatelliteImage(
+                    lat=lat,
+                    lon=lon,
+                    size=size,
+                    output_path=save_path,
+                    rotation=self.rotation,
+                    zoom=self.map.satellite_settings.zoom_level,
+                    copy_from=copy_from,
+                )
+            )
+
+        return tasks
+
+    def previews(self) -> list[str]:
+        """Returns the paths to the preview images.
+
+        Returns:
+            list[str]: List of paths to the preview images.
+        """
+        previews = []
+        for image_path in self.image_paths:
+            preview_path = os.path.join(self.previews_directory, os.path.basename(image_path))
+            self.resize_to_preview(image_path, preview_path)
+            previews.append(preview_path)
+
+        return previews

maps4fs/generator/game.py

@@ -10,7 +10,7 @@ from maps4fs.generator.component.background import Background
 from maps4fs.generator.component.config import Config
 from maps4fs.generator.component.grle import GRLE
 from maps4fs.generator.component.i3d import I3d
-from maps4fs.generator.satellite import Satellite
+from maps4fs.generator.component.satellite import Satellite
 from maps4fs.generator.texture import Texture
 
 working_directory = os.getcwd()

{maps4fs-1.8.173.dist-info → maps4fs-1.8.175.dist-info}/METADATA

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

{maps4fs-1.8.173.dist-info → maps4fs-1.8.175.dist-info}/RECORD

@@ -2,10 +2,9 @@ maps4fs/__init__.py,sha256=iq4GcHoQ-by-BK6CzDOfVcdDww6osyi9Wv6pKXub68U,1307
 maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/generator/dem.py,sha256=oLN02bWNax73HzFsseRBOV47Azl_1L7qdrzuxHh4i_c,11886
-maps4fs/generator/game.py,sha256=YwtdzqwcBJm1FHtc1ehDd3WbfTTW_gBvxK-pzfU48zs,11015
+maps4fs/generator/game.py,sha256=FFAyckuTW6Ix5aRACXOj2eiA72xd3OMCcOARrMhS164,11025
 maps4fs/generator/map.py,sha256=c5GMhr5iTRdXvTXoBKyVYa2V1tocR3ZCc7D_hpU21k8,11523
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
-maps4fs/generator/satellite.py,sha256=t33EfaxWTCjcKYnqoppSlFdQQSekiBe7UFmLgTVhFQI,3650
 maps4fs/generator/settings.py,sha256=cFlN-gK8QcySqyPtcGm-2fLnxQnlmC3Y9kQufJxwI3Y,6270
 maps4fs/generator/texture.py,sha256=_IfqIuxH4934VJXKtdABHa6ToPWk3T0xknvlu-rZ5Uc,36570
 maps4fs/generator/component/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
@@ -13,9 +12,10 @@ maps4fs/generator/component/background.py,sha256=cBBp-ULrJzuNG9wfE_MaxzAn_mR24ne
 maps4fs/generator/component/config.py,sha256=RitKgFDZPzjA1fi8GcEi1na75qqaueUvpcITHjBvCXc,3674
 maps4fs/generator/component/grle.py,sha256=aKMjVJNuKHJJ2gsXaH00bz10kWaIbbZXU_JbP-ZAGw4,18990
 maps4fs/generator/component/i3d.py,sha256=3x38yL-kSJ8ylBwICBb6wPYzRSky4gVj8XCk2jzYSeo,19861
+maps4fs/generator/component/satellite.py,sha256=oZBHjP_QY0ik1-Vk7JqMS__zIG8ffw2voeozB7-HUQc,4946
 maps4fs/generator/component/base/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/component/base/component.py,sha256=U3XJae0GUvHN08psv2j24Y4PBAAytSkSK3AmD-VjjXE,21404
-maps4fs/generator/component/base/component_image.py,sha256=vuiiJqsrKZgYsnK8Qa5yL2Pejqa6nJSTtXNAcBPL29c,3099
+maps4fs/generator/component/base/component.py,sha256=apGuQ7TcwqL0neJZiciNLGO22wZwYyqoDZM7aI1RHw8,21273
+maps4fs/generator/component/base/component_image.py,sha256=fFgY6k2CbLIg3HS7KeiHi9iFQPJXCAxmBueYh2ExlFU,3918
 maps4fs/generator/component/base/component_mesh.py,sha256=jtsEQZkqiCkycYpueq1M1eqgxdShL_bHaJT6Upu8PLI,8412
 maps4fs/generator/component/base/component_xml.py,sha256=6OO1dKoceO1ACk7-k1oGtnkfNud8ZN3u3ZNjdNMpTqw,3967
 maps4fs/generator/dtm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -42,8 +42,8 @@ maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,4
 maps4fs/toolbox/background.py,sha256=RclEqxEWLbMxuEkkegQP8jybzugwQ1_R3rdfDe0s21U,2104
 maps4fs/toolbox/custom_osm.py,sha256=X6ZlPqiOhNjkmdD_qVroIfdOl9Rb90cDwVSLDVYgx80,1892
 maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
-maps4fs-1.8.173.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.8.173.dist-info/METADATA,sha256=juPm5cwfn3XLlaUemJjP43yHQbW-9NYEljrHscMlGN4,42937
-maps4fs-1.8.173.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-maps4fs-1.8.173.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.8.173.dist-info/RECORD,,
+maps4fs-1.8.175.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.8.175.dist-info/METADATA,sha256=sJC26EV7F8zHVh9EUwiFRvKN9BlrJuLYk5-QwfySD5c,42937
+maps4fs-1.8.175.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+maps4fs-1.8.175.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.8.175.dist-info/RECORD,,

maps4fs/generator/satellite.py

@@ -1,91 +0,0 @@
-"""This module contains the Satellite class for the maps4fs package to download satellite images
-for the map."""
-
-import os
-
-import cv2
-from pygmdl import save_image  # type: ignore
-
-from maps4fs.generator.component.base.component import Component
-from maps4fs.generator.settings import Parameters
-from maps4fs.generator.texture import PREVIEW_MAXIMUM_SIZE
-
-
-# pylint: disable=W0223
-class Satellite(Component):
-    """Component for to download satellite images for the map.
-
-    Arguments:
-        game (Game): The game instance for which the map is generated.
-        coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
-        map_size (int): The size of the map in pixels.
-        map_rotated_size (int): The size of the map in pixels after rotation.
-        rotation (int): The rotation angle of the map.
-        map_directory (str): The directory where the map files are stored.
-        logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
-            info, warning. If not provided, default logging will be used.
-    """
-
-    def preprocess(self) -> None:
-        """This component does not require any preprocessing."""
-        return
-
-    def process(self) -> None:
-        """Downloads the satellite images for the map."""
-        self.image_paths = []  # pylint: disable=W0201
-        if not self.map.satellite_settings.download_images:
-            self.logger.debug("Satellite images download is disabled.")
-            return
-
-        margin = self.map.satellite_settings.satellite_margin
-        overview_size = (self.map_size + margin) * 2
-        overwiew_path = os.path.join(self.satellite_directory, "satellite_overview.png")
-
-        background_size = self.map_size + (Parameters.BACKGROUND_DISTANCE + margin) * 2
-        background_path = os.path.join(self.satellite_directory, "satellite_background.png")
-
-        sizes = [overview_size, background_size]
-        self.image_paths = [overwiew_path, background_path]  # pylint: disable=W0201
-
-        for size, path in zip(sizes, self.image_paths):
-            try:
-                lat, lon = self.coordinates
-                zoom = self.map.satellite_settings.zoom_level
-                save_image(
-                    lat,
-                    lon,
-                    size,
-                    output_path=path,
-                    rotation=self.rotation,
-                    zoom=zoom,
-                    from_center=True,
-                    logger=self.logger,
-                )
-            except Exception as e:  # pylint: disable=W0718
-                self.logger.error(f"Failed to download satellite image: {e}")
-                continue
-
-    def previews(self) -> list[str]:
-        """Returns the paths to the preview images.
-
-        Returns:
-            list[str]: List of paths to the preview images.
-        """
-        previews = []
-        for image_path in self.image_paths:
-            if not os.path.isfile(image_path):
-                self.logger.warning(f"File {image_path} does not exist.")
-                continue
-            image = cv2.imread(image_path)
-            if image is None:
-                self.logger.warning(f"Failed to read image from {image_path}")
-                continue
-
-            if image.shape[0] > PREVIEW_MAXIMUM_SIZE or image.shape[1] > PREVIEW_MAXIMUM_SIZE:
-                image = cv2.resize(image, (PREVIEW_MAXIMUM_SIZE, PREVIEW_MAXIMUM_SIZE))
-
-            preview_path = os.path.join(self.previews_directory, os.path.basename(image_path))
-            cv2.imwrite(preview_path, image)
-            previews.append(preview_path)
-
-        return previews