maps4fs 0.9.95__py3-none-any.whl → 0.9.97__py3-none-any.whl

maps4fs/generator/background.py

@@ -27,7 +27,7 @@ FULL_SIMPLIFY_FACTOR = 20
 class Background(Component):
     """Component for creating 3D obj files based on DEM data around the map.
 
-    Args:
+    Arguments:
         coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
         map_height (int): The height of the map in pixels.
         map_width (int): The width of the map in pixels.

maps4fs/generator/component.py

@@ -20,7 +20,7 @@ if TYPE_CHECKING:
 class Component:
     """Base class for all map generation components.
 
-    Args:
+    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_height (int): The height of the map in pixels.
@@ -123,7 +123,7 @@ class Component:
         """Updates the generation info with the provided data.
         If the generation info file does not exist, it will be created.
 
-        Args:
+        Arguments:
             data (dict[Any, Any]): The data to update the generation info with.
         """
         if os.path.isfile(self.generation_info_path):
@@ -158,7 +158,7 @@ class Component:
         width of the map.
         If coordinates and distance are not provided, the instance variables are used.
 
-        Args:
+        Arguments:
             coordinates (tuple[float, float], optional): The latitude and longitude of the center of
                 the map. Defaults to None.
             height_distance (int, optional): The distance from the center of the map to the edge of
@@ -219,7 +219,7 @@ class Component:
         """Converts the bounding box to EPSG:3857.
         If the bounding box is not provided, the instance variable is used.
 
-        Args:
+        Arguments:
             bbox (tuple[float, float, float, float], optional): The bounding box to convert.
             add_margin (bool, optional): Whether to add a margin to the bounding box.
 
@@ -247,7 +247,7 @@ class Component:
         """Converts the bounding box to EPSG:3857 string.
         If the bounding box is not provided, the instance variable is used.
 
-        Args:
+        Arguments:
             bbox (tuple[float, float, float, float], optional): The bounding box to convert.
             add_margin (bool, optional): Whether to add a margin to the bounding box.
 
@@ -265,7 +265,7 @@ class Component:
         bounding box coordinates in EPSG:3857.
         For filenames, the class name is used as a prefix.
 
-        Args:
+        Arguments:
             qgis_layers (list[tuple[str, float, float, float, float]]): The list of layers to
                 create scripts for.
         """

maps4fs/generator/config.py

@@ -12,7 +12,7 @@ from maps4fs.generator.component import Component
 class Config(Component):
     """Component for map settings and configuration.
 
-    Args:
+    Arguments:
         coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
         map_height (int): The height of the map in pixels.
         map_width (int): The width of the map in pixels.

maps4fs/generator/dem.py

@@ -23,7 +23,7 @@ DEFAULT_PLATEAU = 0
 class DEM(Component):
     """Component for processing Digital Elevation Model data.
 
-    Args:
+    Arguments:
         coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
         map_height (int): The height of the map in pixels.
         map_width (int): The width of the map in pixels.
@@ -231,7 +231,7 @@ class DEM(Component):
     def make_copy(self, dem_name: str) -> None:
         """Copies DEM data to additional DEM file.
 
-        Args:
+        Arguments:
             dem_name (str): Name of the additional DEM file.
         """
         dem_directory = os.path.dirname(self._dem_path)
@@ -244,7 +244,7 @@ class DEM(Component):
     def _tile_info(self, lat: float, lon: float) -> tuple[str, str]:
         """Returns latitude band and tile name for SRTM tile from coordinates.
 
-        Args:
+        Arguments:
             lat (float): Latitude.
             lon (float): Longitude.
 
@@ -392,7 +392,7 @@ class DEM(Component):
         """Calculate scaling factor for DEM data normalization.
         NOTE: Needs reconsideration for the implementation.
 
-        Args:
+        Arguments:
             maximum_deviation (int): Maximum deviation in DEM data.
 
         Returns:
@@ -404,7 +404,7 @@ class DEM(Component):
 
     def _normalize_dem(self, data: np.ndarray) -> np.ndarray:
         """Normalize DEM data to 16-bit unsigned integer using max height from settings.
-        Args:
+        Arguments:
             data (np.ndarray): DEM data from SRTM file after cropping.
         Returns:
             np.ndarray: Normalized DEM data.

maps4fs/generator/game.py

@@ -9,6 +9,7 @@ import os
 from maps4fs.generator.background import Background
 from maps4fs.generator.config import Config
 from maps4fs.generator.dem import DEM
+from maps4fs.generator.grle import GRLE
 from maps4fs.generator.i3d import I3d
 from maps4fs.generator.texture import Texture
 
@@ -35,8 +36,9 @@ class Game:
     _additional_dem_name: str | None = None
     _map_template_path: str | None = None
     _texture_schema: str | None = None
+    _grle_schema: str | None = None
 
-    components = [Config, Texture, DEM, I3d, Background]
+    components = [Config, Texture, GRLE, DEM, I3d, Background]
 
     def __init__(self, map_template_path: str | None = None):
         if map_template_path:
@@ -94,6 +96,19 @@ class Game:
             raise ValueError("Texture layers schema path not set.")
         return self._texture_schema
 
+    @property
+    def grle_schema(self) -> str:
+        """Returns the path to the GRLE layers schema file.
+
+        Raises:
+            ValueError: If the GRLE layers schema path is not set.
+
+        Returns:
+            str: The path to the GRLE layers schema file."""
+        if not self._grle_schema:
+            raise ValueError("GRLE layers schema path not set.")
+        return self._grle_schema
+
     def dem_file_path(self, map_directory: str) -> str:
         """Returns the path to the DEM file.
 
@@ -171,6 +186,7 @@ class FS25(Game):
     _additional_dem_name = "unprocessedHeightMap.png"
     _map_template_path = os.path.join(working_directory, "data", "fs25-map-template.zip")
     _texture_schema = os.path.join(working_directory, "data", "fs25-texture-schema.json")
+    _grle_schema = os.path.join(working_directory, "data", "fs25-grle-schema.json")
 
     def dem_file_path(self, map_directory: str) -> str:
         """Returns the path to the DEM file.

maps4fs/generator/grle.py

@@ -0,0 +1,84 @@
+"""This module contains the GRLE class for generating InfoLayer PNG files based on GRLE schema."""
+
+import json
+import os
+
+import cv2
+import numpy as np
+
+from maps4fs.generator.component import Component
+
+
+# pylint: disable=W0223
+class GRLE(Component):
+    """Component for to generate InfoLayer PNG files based on GRLE schema.
+
+    Arguments:
+        coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
+        map_height (int): The height of the map in pixels.
+        map_width (int): The width of the map in pixels.
+        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.
+    """
+
+    _grle_schema: dict[str, float | int | str] | None = None
+
+    def preprocess(self) -> None:
+        """Gets the path to the map I3D file from the game instance and saves it to the instance
+        attribute. If the game does not support I3D files, the attribute is set to None."""
+        try:
+            grle_schema_path = self.game.grle_schema
+        except ValueError:
+            self.logger.info("GRLE schema processing is not implemented for this game.")
+            return
+
+        try:
+            with open(grle_schema_path, "r", encoding="utf-8") as file:
+                self._grle_schema = json.load(file)
+            self.logger.debug("GRLE schema loaded from: %s.", grle_schema_path)
+        except (json.JSONDecodeError, FileNotFoundError) as error:
+            self.logger.error("Error loading GRLE schema from %s: %s.", grle_schema_path, error)
+            self._grle_schema = None
+
+    def process(self) -> None:
+        """Generates InfoLayer PNG files based on the GRLE schema."""
+        if not self._grle_schema:
+            self.logger.info("GRLE schema is not obtained, skipping the processing.")
+            return
+
+        for info_layer in self._grle_schema:
+            if isinstance(info_layer, dict):
+                file_path = os.path.join(
+                    self.game.weights_dir_path(self.map_directory), info_layer["name"]
+                )
+
+                height = int(self.map_height * info_layer["height_multiplier"])
+                width = int(self.map_width * info_layer["width_multiplier"])
+                data_type = info_layer["data_type"]
+
+                self.logger.debug(
+                    "Creating InfoLayer PNG file %s with dimensions %sx%s, %s channels, "
+                    "and data type %s.",
+                    file_path,
+                    height,
+                    width,
+                    data_type,
+                )
+
+                # Create the InfoLayer PNG file with zeros.
+                info_layer_data = np.zeros((height, width), dtype=data_type)
+                print(info_layer_data.shape)
+                cv2.imwrite(file_path, info_layer_data)  # pylint: disable=no-member
+                self.logger.info("InfoLayer PNG file %s created.", file_path)
+            else:
+                self.logger.warning("Invalid InfoLayer schema: %s.", info_layer)
+
+    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/i3d.py

@@ -16,7 +16,7 @@ DEFAULT_MAX_LOD_OCCLUDER_DISTANCE = 10000
 class I3d(Component):
     """Component for map i3d file settings and configuration.
 
-    Args:
+    Arguments:
         coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
         map_height (int): The height of the map in pixels.
         map_width (int): The width of the map in pixels.

maps4fs/generator/map.py

@@ -15,7 +15,7 @@ from maps4fs.logger import Logger
 class Map:
     """Class used to generate map using all components.
 
-    Args:
+    Arguments:
         game (Type[Game]): Game for which the map is generated.
         coordinates (tuple[float, float]): Coordinates of the center of the map.
         height (int): Height of the map in pixels.
@@ -119,7 +119,7 @@ class Map:
     def pack(self, archive_path: str, remove_source: bool = True) -> str:
         """Pack map directory to zip archive.
 
-        Args:
+        Arguments:
             archive_path (str): Path to the archive.
             remove_source (bool, optional): Remove source directory after packing.
 

maps4fs/generator/qgis.py

@@ -115,7 +115,7 @@ for layer in layers:
 def _get_template(layers: list[tuple[str, float, float, float, float]], template: str) -> str:
     """Returns a template for creating layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
         template (str): The template for creating layers in QGIS.
@@ -136,7 +136,7 @@ def _get_template(layers: list[tuple[str, float, float, float, float]], template
 def get_bbox_template(layers: list[tuple[str, float, float, float, float]]) -> str:
     """Returns a template for creating bounding box layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
 
@@ -149,7 +149,7 @@ def get_bbox_template(layers: list[tuple[str, float, float, float, float]]) -> s
 def get_point_template(layers: list[tuple[str, float, float, float, float]]) -> str:
     """Returns a template for creating point layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
 
@@ -162,7 +162,7 @@ def get_point_template(layers: list[tuple[str, float, float, float, float]]) ->
 def get_rasterize_template(layers: list[tuple[str, float, float, float, float]]) -> str:
     """Returns a template for rasterizing bounding box layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
 
@@ -177,7 +177,7 @@ def save_scripts(
 ) -> None:
     """Saves QGIS scripts for creating bounding box, point, and raster layers.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
         save_dir (str): The directory to save the scripts.

maps4fs/generator/texture.py

@@ -36,7 +36,7 @@ class Texture(Component):
         """Class which represents a layer with textures and tags.
         It's using to obtain data from OSM using tags and make changes into corresponding textures.
 
-        Args:
+        Arguments:
             name (str): Name of the layer.
             tags (dict[str, str | list[str]]): Dictionary of tags to search for.
             width (int | None): Width of the polygon in meters (only for LineString).
@@ -89,7 +89,7 @@ class Texture(Component):
         def from_json(cls, data: dict[str, str | list[str] | bool]) -> Texture.Layer:
             """Creates a new instance of the class from dictionary.
 
-            Args:
+            Arguments:
                 data (dict[str, str | list[str] | bool]): Dictionary with layer data.
 
             Returns:
@@ -236,7 +236,7 @@ class Texture(Component):
         """Generates weight files for textures. Each file is a numpy array of zeros and
             dtype uint8 (0-255).
 
-        Args:
+        Arguments:
             layer (Layer): Layer with textures and tags.
         """
         size = (self.map_height, self.map_width)
@@ -266,7 +266,7 @@ class Texture(Component):
     def layers(self, layers: list[Layer]) -> None:
         """Sets list of layers with textures and tags.
 
-        Args:
+        Arguments:
             layers (list[Layer]): List of layers.
         """
         self._layers = layers
@@ -395,7 +395,7 @@ class Texture(Component):
         """Draws base layer and saves it into the png file.
         Base layer is the last layer to be drawn, it fills the remaining area of the map.
 
-        Args:
+        Arguments:
             cumulative_image (np.ndarray): Cumulative image with all layers.
         """
         base_layer = self.get_base_layer()
@@ -409,7 +409,7 @@ class Texture(Component):
     def get_relative_x(self, x: float) -> int:
         """Converts UTM X coordinate to relative X coordinate in map image.
 
-        Args:
+        Arguments:
             x (float): UTM X coordinate.
 
         Returns:
@@ -420,7 +420,7 @@ class Texture(Component):
     def get_relative_y(self, y: float) -> int:
         """Converts UTM Y coordinate to relative Y coordinate in map image.
 
-        Args:
+        Arguments:
             y (float): UTM Y coordinate.
 
         Returns:
@@ -432,9 +432,9 @@ class Texture(Component):
     def _to_np(self, geometry: shapely.geometry.polygon.Polygon, *args) -> np.ndarray:
         """Converts Polygon geometry to numpy array of polygon points.
 
-        Args:
+        Arguments:
             geometry (shapely.geometry.polygon.Polygon): Polygon geometry.
-            *args: Additional arguments:
+            *Arguments: Additional arguments:
                 - width (int | None): Width of the polygon in meters.
 
         Returns:
@@ -449,7 +449,7 @@ class Texture(Component):
     def _to_polygon(self, obj: pd.core.series.Series, width: int | None) -> np.ndarray | None:
         """Converts OSM object to numpy array of polygon points.
 
-        Args:
+        Arguments:
             obj (pd.core.series.Series): OSM object.
             width (int | None): Width of the polygon in meters.
 
@@ -471,7 +471,7 @@ class Texture(Component):
     ) -> np.ndarray:
         """Converts LineString or Point geometry to numpy array of polygon points.
 
-        Args:
+        Arguments:
             geometry (shapely.geometry.linestring.LineString | shapely.geometry.point.Point):
                 LineString or Point geometry.
             width (int | None): Width of the polygon in meters.
@@ -487,7 +487,7 @@ class Texture(Component):
     ) -> Optional[Callable[[BaseGeometry, Optional[int]], np.ndarray]]:
         """Returns a converter function for a given geometry type.
 
-        Args:
+        Arguments:
             geom_type (str): Geometry type.
 
         Returns:
@@ -501,7 +501,7 @@ class Texture(Component):
     ) -> Generator[np.ndarray, None, None]:
         """Generator which yields numpy arrays of polygons from OSM data.
 
-        Args:
+        Arguments:
             tags (dict[str, str | list[str]]): Dictionary of tags to search for.
             width (int | None): Width of the polygon in meters (only for LineString).
 

maps4fs/toolbox/dem.py

@@ -11,7 +11,7 @@ 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:
+    Arguments:
         file_path (str): The path to the GeoTIFF file.
 
     Raises:
@@ -43,7 +43,7 @@ def get_geo_tiff_bbox(
 ) -> tuple[float, float, float, float]:
     """Return the bounding box of a GeoTIFF file in the destination CRS.
 
-    Args:
+    Arguments:
         src (DatasetReader): The DatasetReader object for the GeoTIFF file.
         dst_crs (str, optional): The destination CRS. Defaults to "EPSG:4326".
 
@@ -65,7 +65,7 @@ def get_geo_tiff_bbox(
 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:
+    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).

{maps4fs-0.9.95.dist-info → maps4fs-0.9.97.dist-info}/METADATA

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

maps4fs-0.9.97.dist-info/RECORD

@@ -0,0 +1,22 @@
+maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
+maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
+maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/generator/background.py,sha256=h6zyqMc51eOD8_Jbe8eP9DJFy27-XItzIOVEThQKFdk,14011
+maps4fs/generator/component.py,sha256=ibfl2V_niXqWaFO05aaV25JbPBaupUpKBOLxKQq0Fv4,10714
+maps4fs/generator/config.py,sha256=qomeSaHNgSYvRyPbGkyDjgAxU1jUMND8wESuy9uXcV4,4280
+maps4fs/generator/dem.py,sha256=aU0syr7pu81hd6oVn1rjQoDsDAYJro-58i1STTUz3jw,17167
+maps4fs/generator/game.py,sha256=hvVsU4l43kHYM9oZ6WBFhDiI8U3gJxzSeavAvXyh0DI,7395
+maps4fs/generator/grle.py,sha256=TM9I1ge1_hfepdLq485TbHozm2OBr6HWNrkmixAigI0,3436
+maps4fs/generator/i3d.py,sha256=CSdVDQJOybeu6DQhxTxImEOSsbbXSNqAN8sunNuicM0,3602
+maps4fs/generator/map.py,sha256=1EJfq5928xbV7v9vBBuoC3VpD5gC1SMDBTQ7geH6yaA,4678
+maps4fs/generator/path_steps.py,sha256=yeN6hmOD8O2LMozUf4HcQMIy8WJ5sHF5pGQT_s2FfOw,3147
+maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
+maps4fs/generator/texture.py,sha256=9qBlL3udozp5ATg9N48naRjTQPWe_eOPgs28hG4U13g,22381
+maps4fs/generator/tile.py,sha256=6zUpDidPcPRTGzQvYSNw-0Pj-if2WiakU2qb-40vyOk,2151
+maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
+maps4fs-0.9.97.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-0.9.97.dist-info/METADATA,sha256=s4WH0mc0o_KT-TTA4PdgsYLTMEwr8LnlrvXqxVdWUZo,25194
+maps4fs-0.9.97.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-0.9.97.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.9.97.dist-info/RECORD,,

maps4fs-0.9.95.dist-info/RECORD

@@ -1,21 +0,0 @@
-maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
-maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
-maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/background.py,sha256=XtrTtLEYL5yINFPib-RsYSisNlqBZx9brDCyn4bBj5E,14006
-maps4fs/generator/component.py,sha256=ZEDjChPnvqAsgnBu2f2YBOlwGOlfax4VaAYBcJerLIQ,10684
-maps4fs/generator/config.py,sha256=ZO5BWDU-S3p0-ndKDSFa8Oin3YcYy0iH8B4lqEA_07Q,4275
-maps4fs/generator/dem.py,sha256=2hqkNfJpMJ3rNUK5Mi1OoWzMaaDfycwr7Okb19PyF4M,17142
-maps4fs/generator/game.py,sha256=94HjPNOyy6XSSOnBp-uxrkBglKyC-X3ULIrrucfdlKw,6825
-maps4fs/generator/i3d.py,sha256=UuQiQRusPQ2f6PvGKxJ_UZeXsx3uG15efmy8Ysnm3F8,3597
-maps4fs/generator/map.py,sha256=tJqe4r4Y8Z8ARUJtFc_8xAQjta8sL_lKdbI89vrljVM,4668
-maps4fs/generator/path_steps.py,sha256=yeN6hmOD8O2LMozUf4HcQMIy8WJ5sHF5pGQT_s2FfOw,3147
-maps4fs/generator/qgis.py,sha256=R5Iv3ovyLXkhAL5Oy41u3ZLNOSEbc1byLetzPootO7o,6091
-maps4fs/generator/texture.py,sha256=SBWZRXq7CdSZh2e8PMW57J56-kqwRvrl_jCPxtOkpR8,22316
-maps4fs/generator/tile.py,sha256=6zUpDidPcPRTGzQvYSNw-0Pj-if2WiakU2qb-40vyOk,2151
-maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/toolbox/dem.py,sha256=53KVZ6IKIlK642eYFSRDAC8l2HL9IEUpQNYkkTC56uU,3510
-maps4fs-0.9.95.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-0.9.95.dist-info/METADATA,sha256=PBJcYY-N-DuY-oBkbuE5k9isXXMtyyfQkInhEDSQxTI,25194
-maps4fs-0.9.95.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-0.9.95.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.9.95.dist-info/RECORD,,