fimama

 1from importlib.resources import path as resource_path
 2from pathlib import Path
 3
 4import matplotlib
 5import matplotlib.pyplot as plt
 6from matplotlib.colors import LinearSegmentedColormap
 7import numpy as np
 8import yaml
 9
10from fimama.configuration import MapConfiguration
11from fimama.perlin import perlin_map
12from fimama.voronoi import voronoi_map
13
14matplotlib.use('qtagg')
15
16
17def plot_map(
18    heightmap: np.ndarray, colormap: LinearSegmentedColormap,
19):
20    """
21    Plot a heightmap as a field of Voronoi cells.
22
23    Parameters
24    ----------
25    heightmap : np.ndarray
26        Heightmap to plot
27    colormap : LinearSegmentedColormap
28        Colormap to use in the plotting.
29
30    Returns
31    -------
32    tuple[matplotlib.figure.Figure, matplotlib.Axes.axes]
33        The containing Figure and the Axes the map was plotted on.
34    """
35    fig, (ax1) = plt.subplots(nrows=1, ncols=1, layout="constrained")
36    ax1.set_aspect('equal', 'box')
37    # ax2.set_aspect('equal', 'box')
38
39    voronoi_map(fig=fig, axes=ax1, heightmap=heightmap, colormap=colormap)
40
41    # Colored elevation map
42    # ax2.imshow(X=terrain, cmap=colormap)
43    # plt.tight_layout()
44    plt.show()
45    return fig, ax1
46
47
48def build_map(
49    config_path: Path | None = None
50) -> tuple[np.ndarray, LinearSegmentedColormap]:
51    """
52    Build a map based on settings in the configuration file.
53
54    Parameters
55    ----------
56    config_path : Path | None, optional
57        Path to the configuration file. If this is None the default parameters
58        from the fimama package will be loaded, by default None.
59
60    Returns
61    -------
62    tuple[np.ndarray, LinearSegmentedColormap]
63        The heightmap and the colormap.
64    """
65    anchor = 'fimama.resources'
66
67    # read the config
68    with resource_path(anchor, "default.yaml") as config_path:
69        with open(config_path, 'r', encoding='utf-8') as config_file:
70            raw_config = yaml.safe_load(config_file)
71            config = MapConfiguration(**raw_config)
72
73    heightmap = perlin_map(
74        width=config.width,
75        height=config.height,
76        params=config.perlin_parameters)
77    heightmap = heightmap.T
78    # terrain = np.arange(width*height).reshape((width,height))
79
80    # Read the colormap
81    with resource_path(anchor, f"{config.colormap_name}.gpf") as colormap_path:
82        tmp = []
83        for row in np.loadtxt(colormap_path):
84            tmp.append([row[0], row[1:4]])
85        colormap = LinearSegmentedColormap.from_list(
86            config.colormap_name, tmp)
87
88    return heightmap, colormap
89
90
91def main() -> None:
92    heightmap, colormap = build_map()
93    fig, ax1 = plot_map(heightmap=heightmap, colormap=colormap)