Tools in SDK

Use additional functionalities of the SDK.


Overview

Tools provide access to additional functionalities of the SDK.

View repository

Class: Tools

A class that enables access to additional SDK tools.

Methods

read_vector_file

Reads a vector file and returns a geometry file projected to EPSG:4326. Returns Union[Dict, geopandas.GeoDataFrame].

ParameterDescription
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: Returns DataFrame.
  • False: Returns JSON.

The default value is False.

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

get_example_aoi

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

ParameterDescription
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.

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

settings

Enables logging.

ParameterDescription
log

bool

Determines logging enabling:

  • True: Enables logging.
  • False: Disables logging.

The default value is True.

Python
up42.tools.settings(log=True)

Last updated: