windkit.vector_map.read_vector_map

windkit.vector_map.read_vector_map(filename, crs=None, map_type=None, background_lc_id=None)[source]

Read a vector_map from a file.

Parameters:

  • filename (str or pathlib.Path) – File path

  • crs (int, dict, str or pyproj.crs.CRS) – Value to initialize pyproj.crs.CRS Default reads from file.

  • map_type (str) – One of “elevation” or “roughness” to specify the type of map to create. Defaults to None.

  • background_lc_id (int, optional.) – This option is used for polygon based landcover files. It sets the landcover id for all areas not covered by a polygon. The default is None, but if your area includes such areas, you should set it to an ID that is part of your landcover table.

Returns:

  • gdf (geopandas.GeoDataFrame) – Vectormap as a geodataframe.

  • lc (LandCoverTable) – LandCoverTable optional.