Tools

Overview

Tools provide access to additional functionalities of the SDK.

Class: Tools

A class that enables access to additional SDK tools.

Examples

Python

    up42.tools.read_vector_file(
    filename="/Users/max.mustermann/Desktop/aoi.geojson",
    as_dataframe=True,
)

up42.tools.get_example_aoi(
    location="Washington",
    as_dataframe=True,
)

up42.tools.settings(log=True)

Functions

read_vector_file

Uploads a geometry from a vector file. Returns Union[Dict, geopandas.GeoDataFrame].

Parameter	Description
`filename`	str The file path to the vector file containing the geometry. The default value is `aoi.geojson`.
`as_dataframe`	bool Determines how to return the information: `True`: return DataFrame. `False`: return JSON. The default value is `False`.

get_example_aoi

Retrieves an example AOI. Returns Union[Dict, geopandas.GeoDataFrame].

Parameter	Description
`location`	str A defined location. The allowed values are as follows: `Berlin` `Washington` The default value is `Berlin`.
`as_dataframe`	bool Determines how to return the information: `True`: Returns DataFrame. `False`: Returns JSON. The default value is `False`.

settings

Enables logging.

Parameter	Description
`log`	bool Determines logging enabling: `True`: Enables logging. `False`: Disables logging. The default value is `True`.