maps4fs 0.6.9__py3-none-any.whl → 0.7.1__py3-none-any.whl

maps4fs/generator/component.py

@@ -53,3 +53,11 @@ class Component:
             NotImplementedError: If the method is not implemented in the child class.
         """
         raise NotImplementedError
+
+    def previews(self) -> list[str]:
+        """Returns a list of paths to the preview images. Must be implemented in the child class.
+
+        Raises:
+            NotImplementedError: If the method is not implemented in the child class.
+        """
+        raise NotImplementedError

maps4fs/generator/config.py

@@ -42,3 +42,12 @@ class Config(Component):
             self.logger.debug("Map size set to %sx%s in Map XML file.", width, height)
         tree.write(self._map_xml_path)
         self.logger.debug("Map XML file saved to: %s.", self._map_xml_path)
+
+    def previews(self) -> list[str]:
+        """Returns a list of paths to the preview images (empty list).
+        The component does not generate any preview images so it returns an empty list.
+
+        Returns:
+            list[str]: An empty list.
+        """
+        return []

maps4fs/generator/dem.py

@@ -29,9 +29,6 @@ class DEM(Component):
     """
 
     def preprocess(self) -> None:
-        self._blur_seed: int = self.kwargs.get("blur_seed") or 5
-        self._max_height: int = self.kwargs.get("max_height") or 200
-
         self._dem_path = self.game.dem_file_path(self.map_directory)
         self.temp_dir = "temp"
         self.hgt_dir = os.path.join(self.temp_dir, "hgt")
@@ -87,19 +84,17 @@ class DEM(Component):
             f"Min: {data.min()}, max: {data.max()}."
         )
 
-        normalized_data = self._normalize_dem(data)
-
         resampled_data = cv2.resize(
-            normalized_data, dem_output_resolution, interpolation=cv2.INTER_LINEAR
-        )
+            data, dem_output_resolution, interpolation=cv2.INTER_LINEAR
+        ).astype("uint16")
+
         self.logger.debug(
             f"DEM data was resampled. Shape: {resampled_data.shape}, "
             f"dtype: {resampled_data.dtype}. "
             f"Min: {resampled_data.min()}, max: {resampled_data.max()}."
         )
 
-        blurred_data = cv2.GaussianBlur(resampled_data, (self._blur_seed, self._blur_seed), 0)
-        cv2.imwrite(self._dem_path, blurred_data)
+        cv2.imwrite(self._dem_path, resampled_data)
         self.logger.debug("DEM data was saved to %s.", self._dem_path)
 
     def _tile_info(self, lat: float, lon: float) -> tuple[str, str]:
@@ -182,26 +177,42 @@ class DEM(Component):
         cv2.imwrite(self._dem_path, dem_data)  # pylint: disable=no-member
         self.logger.warning("DEM data filled with zeros and saved to %s.", self._dem_path)
 
-    def _normalize_dem(self, data: np.ndarray) -> np.ndarray:
-        """Normalize DEM data to 16-bit unsigned integer using max height from settings.
+    def grayscale_preview(self) -> str:
+        """Converts DEM image to grayscale RGB image and saves it to the map directory.
+        Returns path to the preview image.
 
-        Args:
-            data (np.ndarray): DEM data from SRTM file after cropping.
+        Returns:
+            str: Path to the preview image.
+        """
+        rgb_dem_path = self._dem_path.replace(".png", "_grayscale.png")
+        dem_data = cv2.imread(self._dem_path, cv2.IMREAD_GRAYSCALE)
+        dem_data_rgb = cv2.cvtColor(dem_data, cv2.COLOR_GRAY2RGB)
+        cv2.imwrite(rgb_dem_path, dem_data_rgb)
+        return rgb_dem_path
+
+    def colored_preview(self) -> str:
+        """Converts DEM image to colored RGB image and saves it to the map directory.
+        Returns path to the preview image.
 
         Returns:
-            np.ndarray: Normalized DEM data.
+            list[str]: List with a single path to the DEM file
         """
-        max_dev = data.max() - data.min()
-        scaling_factor = max_dev / self._max_height if max_dev < self._max_height else 1
-        adjusted_max_height = int(65535 * scaling_factor)
-        self.logger.debug(
-            f"Maximum deviation: {max_dev}. Scaling factor: {scaling_factor}. "
-            f"Adjusted max height: {adjusted_max_height}."
-        )
-        normalized_data = (
-            (data - data.min()) / (data.max() - data.min()) * adjusted_max_height
-        ).astype("uint16")
-        self.logger.debug(
-            f"DEM data was normalized to {normalized_data.min()} - {normalized_data.max()}."
-        )
-        return normalized_data
+
+        colored_dem_path = self._dem_path.replace(".png", "_colored.png")
+        dem_data = cv2.imread(self._dem_path, cv2.IMREAD_GRAYSCALE)
+
+        # Normalize the DEM data to the range [0, 255]
+        # dem_data_normalized = cv2.normalize(dem_data, None, 0, 255, cv2.NORM_MINMAX)
+
+        dem_data_colored = cv2.applyColorMap(dem_data, cv2.COLORMAP_JET)
+
+        cv2.imwrite(colored_dem_path, dem_data_colored)
+        return colored_dem_path
+
+    def previews(self) -> list[str]:
+        """Get list of preview images.
+
+        Returns:
+            list[str]: List of preview images.
+        """
+        return [self.grayscale_preview(), self.colored_preview()]

maps4fs/generator/map.py

@@ -6,11 +6,12 @@ from typing import Any
 
 from tqdm import tqdm
 
+from maps4fs.generator.component import Component
 from maps4fs.generator.game import Game
 from maps4fs.logger import Logger
 
 
-# pylint: disable=R0913
+# pylint: disable=R0913, R0902
 class Map:
     """Class used to generate map using all components.
 
@@ -19,8 +20,6 @@ class Map:
         coordinates (tuple[float, float]): Coordinates of the center of the map.
         distance (int): Distance from the center of the map.
         map_directory (str): Path to the directory where map files will be stored.
-        blur_seed (int): Seed used for blur effect.
-        max_height (int): Maximum height of the map.
         logger (Any): Logger instance
     """
 
@@ -30,11 +29,10 @@ class Map:
         coordinates: tuple[float, float],
         distance: int,
         map_directory: str,
-        blur_seed: int,
-        max_height: int,
         logger: Any = None,
     ):
         self.game = game
+        self.components: list[Component] = []
         self.coordinates = coordinates
         self.distance = distance
         self.map_directory = map_directory
@@ -53,15 +51,6 @@ class Map:
         except Exception as e:
             raise RuntimeError(f"Can not unpack map template due to error: {e}") from e
 
-        # Blur seed should be positive and odd.
-        if blur_seed <= 0:
-            raise ValueError("Blur seed should be positive.")
-        if blur_seed % 2 == 0:
-            blur_seed += 1
-
-        self.blur_seed = blur_seed
-        self.max_height = max_height
-
     def generate(self) -> None:
         """Launch map generation using all components."""
         with tqdm(total=len(self.game.components), desc="Generating map...") as pbar:
@@ -72,8 +61,6 @@ class Map:
                     self.distance,
                     self.map_directory,
                     self.logger,
-                    blur_seed=self.blur_seed,
-                    max_height=self.max_height,
                 )
                 try:
                     component.process()
@@ -84,7 +71,8 @@ class Map:
                         e,
                     )
                     raise e
-                setattr(self, game_component.__name__.lower(), component)
+                # setattr(self, game_component.__name__.lower(), component)
+                self.components.append(component)
 
                 pbar.update(1)
 
@@ -94,7 +82,13 @@ class Map:
         Returns:
             list[str]: List of preview images.
         """
-        return self.texture.previews()  # type: ignore # pylint: disable=no-member
+        # texture_previews = self.texture.previews()  # type: ignore # pylint: disable=no-member
+        # dem_previews = self.dem.previews()  # type: ignore # pylint: disable=no-member
+        # return texture_previews + dem_previews
+        previews = []
+        for component in self.components:
+            previews.extend(component.previews())
+        return previews
 
     def pack(self, archive_name: str) -> str:
         """Pack map directory to zip archive.

{maps4fs-0.6.9.dist-info → maps4fs-0.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.6.9
+Version: 0.7.1
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -16,7 +16,6 @@ License-File: LICENSE.md
 Requires-Dist: opencv-python
 Requires-Dist: osmnx<2.0.0
 Requires-Dist: rasterio
-Requires-Dist: python-dotenv
 Requires-Dist: tqdm
 
 <div align="center" markdown>
@@ -80,6 +79,20 @@ So, if you're new to map making, here's a quick overview of the process:
 3. Open the map template in the Giants Editor.
 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
 
+### Previews
+
+The generator also creates a multiple previews of the map. Here's the list of them:
+1. General preview - merging all the layers into one image with different colors.
+2. Grayscale DEM preview - a grayscale image of the height map (as it is).
+3. Colored DEM preview - a colored image of the height map (from blue to red). The blue color represents the lowest point, and the red color represents the highest point.
+
+![16 km map](https://github.com/user-attachments/assets/82543bcc-1289-479e-bd13-85a8890f0485)<br>
+*Preview of a 16 km map with a 500-meter mountain in the middle of it.*<br>
+
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -145,8 +158,6 @@ map = mfs.Map(
   (52.5200, 13.4050),  # Latitude and longitude of the map center.
   distance=1024,  # The DISTANCE from the center to the edge of the map in meters. The map will be 2048x2048 meters.
   map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-  blur_seed=5,  # The seed for the blur algorithm. The default value is 5, which means 5 meters.
-  max_height=400  # The maximum height of the map.
 )
 ```
 
@@ -157,11 +168,6 @@ map.generate()
 
 The map will be saved in the `map_directory` directory.
 
-## Settings
-Advanced settings are available in the tool's UI under the **Advanced Settings** tab. Here's the list of them:
-- `max_height` - the maximum height of the map. The default value is 400. Select smaller values for plain-like maps and bigger values for mountainous maps. You may need to experiment with this value to get the desired result.
-- `blur_seed` - the seed for the blur algorithm. The default value is 5, which means 5 meters. The bigger the value, the smoother the map will be. The smaller the value, the more detailed the map will be. Keep in mind that for some regions, where terrain is bumpy, disabling the blur algorithm may lead to a very rough map. So, I recommend leaving this value as it is.
-
 ## Features
 - Allows to enter a location by lat and lon (e.g. from Google Maps).
 - Allows to select a size of the map (2x2, 4x4, 8x8 km, 16x16 km).

maps4fs-0.7.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
+maps4fs/logger.py,sha256=CneeHxQywjNUJXqQrUUSeiDxu95FfrfyK_Si1v0gMZ8,1477
+maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/generator/component.py,sha256=Xq5yVFMqG1d1iHTtn2mn5RN-UntsutXIvV5eQYBuFLw,2046
+maps4fs/generator/config.py,sha256=wlGacB69fdcvggfEDvCpx5gzPRKq_4Sh6xuX-z-kwwE,2043
+maps4fs/generator/dem.py,sha256=SdYSz_rS10oIL6t3OGuFhH1A6RhL8BF_sXUdxxWpL4Q,8754
+maps4fs/generator/game.py,sha256=IyXjNEC5epJmDdqjsrl4wKL85T1F23km73pUkBiuDWU,4468
+maps4fs/generator/map.py,sha256=nGU6i45lON1oxYEGRRRzRbFhWE_8bJtgZzIwubY89MQ,3640
+maps4fs/generator/texture.py,sha256=f5dPD5q17CTg8aY6G3i33vFk9ckbpndVb1W3hbT1wL4,15318
+maps4fs-0.7.1.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
+maps4fs-0.7.1.dist-info/METADATA,sha256=zsoFq2z1kSshdDqbwzeD7bXWwz1fX4t0C3dbiLBguwA,10418
+maps4fs-0.7.1.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+maps4fs-0.7.1.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.7.1.dist-info/RECORD,,

maps4fs-0.6.9.dist-info/RECORD

@@ -1,14 +0,0 @@
-maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
-maps4fs/logger.py,sha256=CneeHxQywjNUJXqQrUUSeiDxu95FfrfyK_Si1v0gMZ8,1477
-maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/component.py,sha256=UmR6Gbs-uDld7897q_9hOOzqBXaIYD8svmw_a3IgC5g,1761
-maps4fs/generator/config.py,sha256=3X9E6luYh0dBlYcGvE4Exzp-ShAMCFjGB_8SK3qPBtM,1760
-maps4fs/generator/dem.py,sha256=_1d_TPMOGBgl2-R_CRMbKumzxCbQyb-hcpqsElhYbQ4,8546
-maps4fs/generator/game.py,sha256=IyXjNEC5epJmDdqjsrl4wKL85T1F23km73pUkBiuDWU,4468
-maps4fs/generator/map.py,sha256=Y7ERUB6ivxJilDAjE9UD0-vl0SKtzj6J2f8QPXM6i48,3712
-maps4fs/generator/texture.py,sha256=f5dPD5q17CTg8aY6G3i33vFk9ckbpndVb1W3hbT1wL4,15318
-maps4fs-0.6.9.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
-maps4fs-0.6.9.dist-info/METADATA,sha256=xmzb7SNRXB0z6_nSFRhBny1XdV84cPWyjWSWz264COQ,10652
-maps4fs-0.6.9.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-maps4fs-0.6.9.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.6.9.dist-info/RECORD,,