Skip to content

genet.utils.elevation

get_elevation_data(img, lat, lon) #

Source code in src/genet/utils/elevation.py 
17
18
19
20
21
22
def get_elevation_data(img, lat, lon):
    output = img.sel(x=lon, y=lat, method="nearest")
    mt = output.values
    elevation_meters = mt.item()

    return elevation_meters

get_elevation_image(elevation_tif) #

Source code in src/genet/utils/elevation.py 
 9
10
11
12
13
14
def get_elevation_image(elevation_tif):
    xarr_file = rioxarray.open_rasterio(elevation_tif)
    if str(xarr_file.rio.crs) != "EPSG:4326":
        xarr_file = xarr_file.rio.write_crs(4326, inplace=True)

    return xarr_file[0, :, :]

validation_report_for_node_elevation(elev_dict, low_limit=-50, mont_blanc_height=4809) #

Generates a validation report for the node elevation dictionary.

PARAMETER DESCRIPTION
elev_dict

contains node_id as key and elevation in meters as value.

TYPE: dict

low_limit

values below this get flagged as possibly wrong. Defaults to -50 (below sea level).

TYPE: int DEFAULT: -50

mont_blanc_height

values above this get flagged as possibly wrong. Defaults to 4809 (the height of Mont Blanc).

TYPE: int DEFAULT: 4809

RETURNS DESCRIPTION
dict

Contains summary statistics, and extreme values lists.

TYPE: dict

Source code in src/genet/utils/elevation.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def validation_report_for_node_elevation(
    elev_dict: dict, low_limit: int = -50, mont_blanc_height: int = 4809
) -> dict:
    """Generates a validation report for the node elevation dictionary.

    Args:
        elev_dict (dict): contains node_id as key and elevation in meters as value.
        low_limit (int, optional): values below this get flagged as possibly wrong. Defaults to -50 (below sea level).
        mont_blanc_height (int, optional): values above this get flagged as possibly wrong. Defaults to 4809 (the height of Mont Blanc).

    Returns:
        dict: Contains summary statistics, and extreme values lists.
    """

    elevation_list = []
    for node_id in elev_dict.keys():
        elevation_list.append(elev_dict[node_id]["z"])

    min_value = np.min(elevation_list)
    max_value = np.max(elevation_list)
    mean = np.mean(elevation_list)
    median = np.median(elevation_list)

    too_high = {}
    too_low = {}

    for node_id in elev_dict.keys():
        node_elev = elev_dict[node_id]["z"]
        if node_elev < low_limit:
            too_low[node_id] = node_elev
        elif node_elev > mont_blanc_height:
            too_high[node_id] = node_elev

    report = {
        "summary": {
            "total_nodes": len(elevation_list),
            "min_value": int(min_value),
            "max_value": int(max_value),
            "mean": int(mean),
            "median": int(median),
            "extremely_high_values_count": len(too_high),
            "extremely_low_values_count": len(too_low),
        },
        "values": {"extremely_high_values_dict": too_high, "extremely_low_values_dict": too_low},
    }

    return report

write_slope_xml(link_slope_dictionary, output_dir) #

Generates a link_slopes XML file.

PARAMETER DESCRIPTION
link_slope_dictionary

dictionary of link slopes in format {link_id: {'slope': slope_value}}

TYPE: dict

output_dir

directory where the XML file will be written to.

TYPE: str

Source code in src/genet/utils/elevation.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def write_slope_xml(link_slope_dictionary: dict, output_dir: str):
    """Generates a link_slopes XML file.

    Args:
        link_slope_dictionary (dict): dictionary of link slopes in format `{link_id: {'slope': slope_value}}`
        output_dir (str): directory where the XML file will be written to.
    """
    fname = os.path.join(output_dir, "link_slopes.xml")
    logging.info(f"Writing {fname}")

    with open(fname, "wb") as f, etree.xmlfile(f, encoding="UTF-8") as xf:
        xf.write_declaration(
            doctype='<!DOCTYPE objectAttributes SYSTEM "http://matsim.org/files/dtd/objectattributes_v1.dtd">'
        )
        with xf.element("objectAttributes"):
            for link_id, slope_dict in link_slope_dictionary.items():
                with xf.element("object", {"id": link_id}):
                    attrib = {"name": "slope", "class": "java.lang.Double"}
                    rec = etree.Element("attribute", attrib)
                    rec.text = str(slope_dict["slope"])
                    xf.write(rec)