maps4fs 1.8.0__py3-none-any.whl

maps4fs/logger.py

@@ -0,0 +1,46 @@
+"""This module contains the Logger class for logging to the file and stdout."""
+
+import logging
+import os
+import sys
+from datetime import datetime
+from typing import Literal
+
+LOGGER_NAME = "maps4fs"
+log_directory = os.path.join(os.getcwd(), "logs")
+os.makedirs(log_directory, exist_ok=True)
+
+
+class Logger(logging.Logger):
+    """Handles logging to the file and stroudt with timestamps."""
+
+    def __init__(
+        self,
+        level: Literal["DEBUG", "INFO", "WARNING", "ERROR"] = "ERROR",
+        to_stdout: bool = True,
+        to_file: bool = True,
+    ):
+        super().__init__(LOGGER_NAME)
+        self.setLevel(level)
+        self.stdout_handler = logging.StreamHandler(sys.stdout)
+        self.file_handler = logging.FileHandler(
+            filename=self.log_file(), mode="a", encoding="utf-8"
+        )
+        formatter = "%(name)s | %(levelname)s | %(asctime)s | %(message)s"
+        self.fmt = formatter
+        self.stdout_handler.setFormatter(logging.Formatter(formatter))
+        self.file_handler.setFormatter(logging.Formatter(formatter))
+        if to_stdout:
+            self.addHandler(self.stdout_handler)
+        if to_file:
+            self.addHandler(self.file_handler)
+
+    def log_file(self) -> str:
+        """Returns the path to the log file.
+
+        Returns:
+            str: The path to the log file.
+        """
+        today = datetime.now().strftime("%Y-%m-%d")
+        log_file = os.path.join(log_directory, f"{today}.txt")
+        return log_file

maps4fs/toolbox/__init__.py

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

maps4fs/toolbox/background.py

@@ -0,0 +1,63 @@
+"""This module contains functions to work with the background terrain of the map."""
+
+import cv2
+import numpy as np
+import trimesh  # type: ignore
+
+
+# pylint: disable=R0801, R0914
+def plane_from_np(
+    dem_data: np.ndarray,
+    resize_factor: float,
+    simplify_factor: int,
+    save_path: str,
+) -> None:
+    """Generates a 3D obj file based on DEM data.
+
+    Arguments:
+        dem_data (np.ndarray) -- The DEM data as a numpy array.
+        resize_factor (float) -- The factor by which the DEM data will be resized. Bigger values
+            will result in a bigger mesh.
+        simplify_factor (int) -- The factor by which the mesh will be simplified. Bigger values
+            will result in a simpler mesh.
+        save_path (str) -- The path to save the obj file.
+    """
+    dem_data = cv2.resize(  # pylint: disable=no-member
+        dem_data, (0, 0), fx=resize_factor, fy=resize_factor
+    )
+
+    # Invert the height values.
+    dem_data = dem_data.max() - dem_data
+
+    rows, cols = dem_data.shape
+    x = np.linspace(0, cols - 1, cols)
+    y = np.linspace(0, rows - 1, rows)
+    x, y = np.meshgrid(x, y)
+    z = dem_data
+
+    vertices = np.column_stack([x.ravel(), y.ravel(), z.ravel()])
+    faces = []
+
+    for i in range(rows - 1):
+        for j in range(cols - 1):
+            top_left = i * cols + j
+            top_right = top_left + 1
+            bottom_left = top_left + cols
+            bottom_right = bottom_left + 1
+
+            faces.append([top_left, bottom_left, bottom_right])
+            faces.append([top_left, bottom_right, top_right])
+
+    faces = np.array(faces)  # type: ignore
+    mesh = trimesh.Trimesh(vertices=vertices, faces=faces)
+
+    # Apply rotation: 180 degrees around Y-axis and Z-axis
+    rotation_matrix_y = trimesh.transformations.rotation_matrix(np.pi, [0, 1, 0])
+    rotation_matrix_z = trimesh.transformations.rotation_matrix(np.pi, [0, 0, 1])
+    mesh.apply_transform(rotation_matrix_y)
+    mesh.apply_transform(rotation_matrix_z)
+
+    # Simplify the mesh to reduce the number of faces.
+    mesh = mesh.simplify_quadric_decimation(face_count=len(faces) // simplify_factor)
+
+    mesh.export(save_path)

maps4fs/toolbox/custom_osm.py

@@ -0,0 +1,67 @@
+"""This module contains functions to work with custom OSM files."""
+
+import json
+from xml.etree import ElementTree as ET
+
+import osmnx as ox
+from osmnx._errors import InsufficientResponseError
+
+from maps4fs.generator.game import FS25
+
+
+def check_osm_file(file_path: str) -> bool:
+    """Tries to read the OSM file using OSMnx and returns True if the file is valid,
+    False otherwise.
+
+    Arguments:
+        file_path (str): Path to the OSM file.
+
+    Returns:
+        bool: True if the file is valid, False otherwise.
+    """
+    with open(FS25().texture_schema, encoding="utf-8") as f:
+        schema = json.load(f)
+
+    tags = []
+    for element in schema:
+        element_tags = element.get("tags")
+        if element_tags:
+            tags.append(element_tags)
+
+    for tag in tags:
+        try:
+            ox.features_from_xml(file_path, tags=tag)
+        except InsufficientResponseError:
+            continue
+        except Exception:  # pylint: disable=W0718
+            return False
+    return True
+
+
+def fix_osm_file(input_file_path: str, output_file_path: str) -> tuple[bool, int]:
+    """Fixes the OSM file by removing all the <relation> nodes and all the nodes with
+    action='delete'.
+
+    Arguments:
+        input_file_path (str): Path to the input OSM file.
+        output_file_path (str): Path to the output OSM file.
+
+    Returns:
+        tuple[bool, int]: A tuple containing the result of the check_osm_file function
+            and the number of fixed errors.
+    """
+    broken_entries = ["relation", ".//*[@action='delete']"]
+
+    tree = ET.parse(input_file_path)
+    root = tree.getroot()
+
+    fixed_errors = 0
+    for entry in broken_entries:
+        for element in root.findall(entry):
+            root.remove(element)
+            fixed_errors += 1
+
+    tree.write(output_file_path)
+    result = check_osm_file(output_file_path)
+
+    return result, fixed_errors

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.
+
+    Arguments:
+        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.
+
+    Arguments:
+        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.
+
+    Arguments:
+        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-1.8.0.dist-info/LICENSE.md

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 [iwatkot](https://github.com/iwatkot)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.