maps4fs 0.9.7__py3-none-any.whl → 0.9.9__py3-none-any.whl

maps4fs/generator/dem.py

@@ -79,6 +79,22 @@ class DEM(Component):
         )
         return dem_width, dem_height
 
+    def to_ground(self, data: np.ndarray) -> np.ndarray:
+        """Receives the signed 16-bit integer array and converts it to the ground level.
+        If the min value is negative, it will become zero value and the rest of the values
+        will be shifted accordingly.
+        """
+        # For examlem, min value was -50, it will become 0 and for all values we'll +50.
+
+        if data.min() < 0:
+            self.logger.debug("Array contains negative values, will be shifted to the ground.")
+            data = data + abs(data.min())
+
+        self.logger.debug(
+            "Array was shifted to the ground. Min: %s, max: %s.", data.min(), data.max()
+        )
+        return data
+
     # pylint: disable=no-member
     def process(self) -> None:
         """Reads SRTM file, crops it to map size, normalizes and blurs it,
@@ -119,6 +135,8 @@ class DEM(Component):
             data.max(),
         )
 
+        data = self.to_ground(data)
+
         resampled_data = cv2.resize(
             data, dem_output_resolution, interpolation=cv2.INTER_LINEAR
         ).astype("uint16")

maps4fs/toolbox/__init__.py

@@ -0,0 +1 @@
+# pylint: disable=missing-module-docstring

maps4fs/toolbox/dem.py

@@ -0,0 +1,112 @@
+"""This module contains functions for working with Digital Elevation Models (DEMs)."""
+
+import os
+
+import rasterio  # type: ignore
+from pyproj import Transformer
+from rasterio.io import DatasetReader  # type: ignore
+from rasterio.windows import from_bounds  # type: ignore
+
+
+def read_geo_tiff(file_path: str) -> DatasetReader:
+    """Read a GeoTIFF file and return the DatasetReader object.
+
+    Args:
+        file_path (str): The path to the GeoTIFF file.
+
+    Raises:
+        FileNotFoundError: If the file is not found.
+        RuntimeError: If there is an error reading the file.
+
+    Returns:
+        DatasetReader: The DatasetReader object for the GeoTIFF file.
+    """
+    if not os.path.isfile(file_path):
+        raise FileNotFoundError(f"File not found: {file_path}")
+
+    try:
+        src = rasterio.open(file_path)
+    except Exception as e:
+        raise RuntimeError(f"Error reading file: {file_path}") from e
+
+    if not src.bounds or not src.crs:
+        raise RuntimeError(
+            f"Can not read bounds or CRS from file: {file_path}. "
+            f"Bounds: {src.bounds}, CRS: {src.crs}"
+        )
+
+    return src
+
+
+def get_geo_tiff_bbox(
+    src: DatasetReader, dst_crs: str | None = "EPSG:4326"
+) -> tuple[float, float, float, float]:
+    """Return the bounding box of a GeoTIFF file in the destination CRS.
+
+    Args:
+        src (DatasetReader): The DatasetReader object for the GeoTIFF file.
+        dst_crs (str, optional): The destination CRS. Defaults to "EPSG:4326".
+
+    Returns:
+        tuple[float, float, float, float]: The bounding box in the destination CRS
+            as (north, south, east, west).
+    """
+    left, bottom, right, top = src.bounds
+
+    transformer = Transformer.from_crs(src.crs, dst_crs, always_xy=True)
+
+    east, north = transformer.transform(left, top)
+    west, south = transformer.transform(right, bottom)
+
+    return north, south, east, west
+
+
+# pylint: disable=R0914
+def extract_roi(file_path: str, bbox: tuple[float, float, float, float]) -> str:
+    """Extract a region of interest (ROI) from a GeoTIFF file and save it as a new file.
+
+    Args:
+        file_path (str): The path to the GeoTIFF file.
+        bbox (tuple[float, float, float, float]): The bounding box of the region of interest
+            as (north, south, east, west).
+
+    Raises:
+        RuntimeError: If there is no data in the selected region.
+
+    Returns:
+        str: The path to the new GeoTIFF file containing the extracted ROI.
+    """
+    with rasterio.open(file_path) as src:
+        transformer = Transformer.from_crs("EPSG:4326", src.crs, always_xy=True)
+        north, south, east, west = bbox
+
+        left, bottom = transformer.transform(west, south)
+        right, top = transformer.transform(east, north)
+
+        window = from_bounds(left, bottom, right, top, src.transform)
+        data = src.read(window=window)
+
+    if not data.size > 0:
+        raise RuntimeError("No data in the selected region.")
+
+    base_name = os.path.basename(file_path).split(".")[0]
+    dir_name = os.path.dirname(file_path)
+
+    output_name = f"{base_name}_{north}_{south}_{east}_{west}.tif"
+
+    output_path = os.path.join(dir_name, output_name)
+
+    with rasterio.open(
+        output_path,
+        "w",
+        driver="GTiff",
+        height=data.shape[1],
+        width=data.shape[2],
+        count=data.shape[0],
+        dtype=data.dtype,
+        crs=src.crs,
+        transform=src.window_transform(window),
+    ) as dst:
+        dst.write(data)
+
+    return output_path

{maps4fs-0.9.7.dist-info → maps4fs-0.9.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.7
+Version: 0.9.9
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -31,7 +31,8 @@ Requires-Dist: tifffile
   <a href="#Quick-Start">Quick Start</a> •
   <a href="#Overview">Overview</a> • 
   <a href="#How-To-Run">How-To-Run</a> •
-  <a href="tutorials/FAQ.md">FAQ</a><br>
+  <a href="docs/FAQ.md">FAQ</a> •
+  <a href="#Modder-Toolbox">Modder Toolbox</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
   <a href="#Texture-schema">Texture schema</a> •
@@ -65,6 +66,7 @@ Requires-Dist: tifffile
 🚜 Supports Farming Simulator 22 and 25<br>
 🔷 Generates *.obj files for background terrain based on the real-world height map<br>
 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
+🧰 Modder Toolbox to help you with various of tasks 🆕<br>
 
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
@@ -196,6 +198,16 @@ for active_component in map.generate():
 
 The map will be saved in the `map_directory` directory.
 
+## Modder Toolbox
+The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
+
+![Modder Toolbox](https://github.com/user-attachments/assets/18f169e9-1a5b-474c-b488-6becfffadcea)
+
+### Tool categories
+Tools are divided into categories, which are listed below.
+#### Textures and DEM
+- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image.
+
 ## Supported objects
 The project is based on the [OpenStreetMap](https://www.openstreetmap.org/) data. So, refer to [this page](https://wiki.openstreetmap.org/wiki/Map_Features) to understand the list below.
 - "building": True
@@ -374,9 +386,9 @@ If you're willing to create a background terrain, you will need: Blender, the Bl
 
 If you're afraid of this task, please don't be. It's really simple and I've prepaired detailed step-by-step instructions for you, you'll find them in the separate README files. Here are the steps you need to follow:
 
-1. [Download high-resolution satellite images](tutorials/README_satellite_images.md).
-2. [Prepare the i3d files](tutorials/README_i3d.md).
-3. [Import the i3d files to Giants Editor](tutorials/README_giants_editor.md).
+1. [Download high-resolution satellite images](docs/download_satellite_images.md).
+2. [Prepare the i3d files](docs/create_background_terrain.md).
+3. [Import the i3d files to Giants Editor](docs/import_to_giants_editor.md).
 
 ## Overview image
 The overview image is an image that is used as in-game map. No matter what the size of the map, this file is always `4096x4096 pixels`, while the region of your map is `2048x2048 pixels` in center of this file. The rest of the image is just here for nice view, but you still may add satellite pictures to this region.<br>
@@ -416,7 +428,7 @@ You can also apply some advanced settings to the map generation process. Note th
 
 Here's the list of the advanced settings:
 
-- DEM multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum avaiable value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. So, by default this value is set to 3. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the [heightScale](https://www.farming-simulator.org/19/terrain-heightscale.php) parameter on the [PMC Farming Simulator](https://www.farming-simulator.org/) website.
+- DEM multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum avaiable value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the DEM file and the heightScale paramter in [docs](docs/dem.md). By default, it's set to 1.
 
 - DEM Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result as a Minecraft-like map.
 
@@ -434,5 +446,5 @@ To create a basic map, you only need the Giants Editor. But if you want to creat
 6. [AnyConv](https://anyconv.com/png-to-dds-converter/) - the online tool to convert the PNG images to the DDS format. You'll need this format for the textures, icons, overview and preview images.
 
 ## Bugs and feature requests
-➡️ Please, before creating an issue or asking some questions, check the [FAQ](tutorials/FAQ.md) section.<br>
+➡️ Please, before creating an issue or asking some questions, check the [FAQ](docs/FAQ.md) section.<br>
 If you find a bug or have an idea for a new feature, please create an issue [here](https://github.com/iwatkot/maps4fs/issues) or contact me directly on [Telegram](https://t.me/iwatkot) or on Discord: `iwatkot`.

{maps4fs-0.9.7.dist-info → maps4fs-0.9.9.dist-info}/RECORD

@@ -4,7 +4,7 @@ maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk
 maps4fs/generator/background.py,sha256=AP-Z3F-4I9achvA9xsaXAAoA6IHtmPLxb1RkUsVYdbg,14036
 maps4fs/generator/component.py,sha256=ZEDjChPnvqAsgnBu2f2YBOlwGOlfax4VaAYBcJerLIQ,10684
 maps4fs/generator/config.py,sha256=ZO5BWDU-S3p0-ndKDSFa8Oin3YcYy0iH8B4lqEA_07Q,4275
-maps4fs/generator/dem.py,sha256=XLpzjJMPZCxjrF-AhwTeEb-OQoCHEtYdK0b8z3Gb-is,15712
+maps4fs/generator/dem.py,sha256=rBqVeWiLEpY89EIpfnSENOYsNYxsJcV_Y2UuBalE104,16438
 maps4fs/generator/game.py,sha256=94HjPNOyy6XSSOnBp-uxrkBglKyC-X3ULIrrucfdlKw,6825
 maps4fs/generator/i3d.py,sha256=UuQiQRusPQ2f6PvGKxJ_UZeXsx3uG15efmy8Ysnm3F8,3597
 maps4fs/generator/map.py,sha256=v8OOLmhAkgqq64tQgEDbV6DmbgOVm3NXJBDDy0nJf60,4226
@@ -12,8 +12,10 @@ maps4fs/generator/path_steps.py,sha256=yeN6hmOD8O2LMozUf4HcQMIy8WJ5sHF5pGQT_s2Ff
 maps4fs/generator/qgis.py,sha256=R5Iv3ovyLXkhAL5Oy41u3ZLNOSEbc1byLetzPootO7o,6091
 maps4fs/generator/texture.py,sha256=CwaXZfAG4e3D3YR7yVR2MC677EHpbUWTboCS3G6jkhk,17723
 maps4fs/generator/tile.py,sha256=3vmfjQiPiiUZKPuIo5tg2rOKkgcP1NRVkMGK-Vo10-A,2138
-maps4fs-0.9.7.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
-maps4fs-0.9.7.dist-info/METADATA,sha256=dhMICyAhvj7SiKMKyK_-ewOb07j38R574o9SMezErYE,24635
-maps4fs-0.9.7.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-0.9.7.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.9.7.dist-info/RECORD,,
+maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/toolbox/dem.py,sha256=53KVZ6IKIlK642eYFSRDAC8l2HL9IEUpQNYkkTC56uU,3510
+maps4fs-0.9.9.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
+maps4fs-0.9.9.dist-info/METADATA,sha256=rWT-sSS7QfXGArOqjWMLdCxSRm0bkGd0uMZwJegayZc,25170
+maps4fs-0.9.9.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-0.9.9.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.9.9.dist-info/RECORD,,