maps4fs 0.7.0__tar.gz → 0.7.1__tar.gz

{maps4fs-0.7.0 → maps4fs-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.7.0
+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>
@@ -87,16 +86,12 @@ The generator also creates a multiple previews of the map. Here's the list of th
 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.
 
-So the colored DEM preview can be very handy when you're trying to find the best value for the `max_height` parameter. Learn more about it in the [Settings](#settings) section.
+![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>
 
-![Previews](https://github.com/user-attachments/assets/69609169-834b-4269-ac6a-9a5c56b629dc)<br>
-In the second row of the image you can see the following images:<br>
-1. DEM preview with `max_height=200`.
-2. Colored DEM preview with `max_height=200`.
-3. Colored DEM preview with `max_height=50`.
-
-As you can see there's a huge difference between images 2 and 3. The third (with lower `max_height`) will have a higher terrain contrast, and the second one will have lower differences between the terrain heights.<br>
-There's no like "in real world" option, because FS system of coordinates does not work in meters or something like that when talking about DEM. So you need to experiment with the `max_height` parameter to get the desired result. To clarify: in the example above the difference on the platue is about 80 meters, so `max_height=50` made this like super mountainous terrain, and `max_height=200` made it like a plain.
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
 
 ## How-To-Run
 
@@ -163,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.
 )
 ```
 
@@ -175,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.0 → maps4fs-0.7.1}/README.md

@@ -66,16 +66,12 @@ The generator also creates a multiple previews of the map. Here's the list of th
 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.
 
-So the colored DEM preview can be very handy when you're trying to find the best value for the `max_height` parameter. Learn more about it in the [Settings](#settings) section.
+![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>
 
-![Previews](https://github.com/user-attachments/assets/69609169-834b-4269-ac6a-9a5c56b629dc)<br>
-In the second row of the image you can see the following images:<br>
-1. DEM preview with `max_height=200`.
-2. Colored DEM preview with `max_height=200`.
-3. Colored DEM preview with `max_height=50`.
-
-As you can see there's a huge difference between images 2 and 3. The third (with lower `max_height`) will have a higher terrain contrast, and the second one will have lower differences between the terrain heights.<br>
-There's no like "in real world" option, because FS system of coordinates does not work in meters or something like that when talking about DEM. So you need to experiment with the `max_height` parameter to get the desired result. To clarify: in the example above the difference on the platue is about 80 meters, so `max_height=50` made this like super mountainous terrain, and `max_height=200` made it like a plain.
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
 
 ## How-To-Run
 
@@ -142,8 +138,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.
 )
 ```
 
@@ -154,11 +148,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.0 → maps4fs-0.7.1}/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,30 +177,6 @@ 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.
-
-        Args:
-            data (np.ndarray): DEM data from SRTM file after cropping.
-
-        Returns:
-            np.ndarray: Normalized DEM data.
-        """
-        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
-
     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.

{maps4fs-0.7.0 → maps4fs-0.7.1}/maps4fs/generator/map.py

@@ -20,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
     """
 
@@ -31,8 +29,6 @@ class Map:
         coordinates: tuple[float, float],
         distance: int,
         map_directory: str,
-        blur_seed: int,
-        max_height: int,
         logger: Any = None,
     ):
         self.game = game
@@ -55,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:
@@ -74,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()

{maps4fs-0.7.0 → maps4fs-0.7.1}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.7.0
+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>
@@ -87,16 +86,12 @@ The generator also creates a multiple previews of the map. Here's the list of th
 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.
 
-So the colored DEM preview can be very handy when you're trying to find the best value for the `max_height` parameter. Learn more about it in the [Settings](#settings) section.
+![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>
 
-![Previews](https://github.com/user-attachments/assets/69609169-834b-4269-ac6a-9a5c56b629dc)<br>
-In the second row of the image you can see the following images:<br>
-1. DEM preview with `max_height=200`.
-2. Colored DEM preview with `max_height=200`.
-3. Colored DEM preview with `max_height=50`.
-
-As you can see there's a huge difference between images 2 and 3. The third (with lower `max_height`) will have a higher terrain contrast, and the second one will have lower differences between the terrain heights.<br>
-There's no like "in real world" option, because FS system of coordinates does not work in meters or something like that when talking about DEM. So you need to experiment with the `max_height` parameter to get the desired result. To clarify: in the example above the difference on the platue is about 80 meters, so `max_height=50` made this like super mountainous terrain, and `max_height=200` made it like a plain.
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
 
 ## How-To-Run
 
@@ -163,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.
 )
 ```
 
@@ -175,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.0 → maps4fs-0.7.1}/maps4fs.egg-info/requires.txt

@@ -1,5 +1,4 @@
 opencv-python
 osmnx<2.0.0
 rasterio
-python_dotenv
 tqdm

{maps4fs-0.7.0 → maps4fs-0.7.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "0.7.0"
+version = "0.7.1"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "MIT License"}
@@ -20,7 +20,6 @@ dependencies = [
     "opencv-python",
     "osmnx<2.0.0",
     "rasterio",
-    "python_dotenv",
     "tqdm",
 ]
 

{maps4fs-0.7.0 → maps4fs-0.7.1}/tests/test_generator.py

@@ -1,7 +1,7 @@
 import json
 import os
 import shutil
-from random import choice, randint
+from random import choice
 from time import time
 
 import cv2
@@ -9,8 +9,6 @@ import cv2
 from maps4fs import Map
 from maps4fs.generator.game import Game
 
-# from maps4fs.generator.texture import TEXTURES
-
 working_directory = os.getcwd()
 
 base_directory = os.path.join(working_directory, "tests/data")
@@ -40,24 +38,6 @@ def random_distance() -> int:
     return choice(distances_cases[:2])  # Larger maps are too slow for automated tests.
 
 
-def random_blur_seed() -> int:
-    """Return random blur seed.
-
-    Returns:
-        int: Random blur seed.
-    """
-    return randint(1, 30)
-
-
-def random_max_height() -> int:
-    """Return random max height.
-
-    Returns:
-        int: Random max height.
-    """
-    return randint(100, 3000)
-
-
 def map_directory() -> str:
     """Creates a new map directory and returns its path.
 
@@ -89,8 +69,6 @@ def test_map():
         game = Game.from_code(game_code)
         for coordinates in coordinates_cases:
             distance = random_distance()
-            blur_seed = random_blur_seed()
-            max_height = random_max_height()
             directory = map_directory()
 
             map = Map(
@@ -98,8 +76,6 @@ def test_map():
                 coordinates=coordinates,
                 distance=distance,
                 map_directory=directory,
-                blur_seed=blur_seed,
-                max_height=max_height,
             )
 
             map.generate()
@@ -142,8 +118,6 @@ def test_map_preview():
     """Test Map preview generation."""
     case = choice(coordinates_cases)
     distance = random_distance()
-    blur_seed = random_blur_seed()
-    max_height = random_max_height()
 
     game_code = choice(game_code_cases)
     game = Game.from_code(game_code)
@@ -154,8 +128,6 @@ def test_map_preview():
         coordinates=case,
         distance=distance,
         map_directory=directory,
-        blur_seed=blur_seed,
-        max_height=max_height,
     )
     map.generate()
     previews_paths = map.previews()
@@ -169,8 +141,6 @@ def test_map_pack():
     """Test Map packing into zip archive."""
     case = choice(coordinates_cases)
     distance = random_distance()
-    blur_seed = random_blur_seed()
-    max_height = random_max_height()
 
     game_code = choice(game_code_cases)
     game = Game.from_code(game_code)
@@ -181,8 +151,6 @@ def test_map_pack():
         coordinates=case,
         distance=distance,
         map_directory=directory,
-        blur_seed=blur_seed,
-        max_height=max_height,
     )
     map.generate()
     archive_name = os.path.join(base_directory, "archive")