windkit.Workspace.get_object#

Workspace.get_object(ID, map_type='elevation', crs=None)[source]#

Extracts object from .wwh file.

Deprecated since version 2.2.0: Will be removed in windkit 3.0. Call the getter for the object instead: get_elevation_map(), get_roughness_map(), get_gwc(), get_owc() or get_turbines().

Parameters:

ID (int) – ID of object to be extracted.
map_type (str, optional) – Feature type to extract from mapfile Possible values ‘elevation’, ‘roughness’. Defaults to ‘elevation’.
crs (int, dict, str or pyproj.crs.CRS) – Value to initialize pyproj.crs.CRS Default, use from file.

Return type:

gwc, bwc, vector map or xarray.Dataset of turbine positions

Raises:

ValueError – If the ID does not exist in the catalogue.
TypeError – If the object is not one of those listed above, or map_type is not “elevation” or “roughness”.

Warns:

FutureWarning – Always.