Skip to content

Elevation & Terrain

Class Key params Returns Data source Description
AlosDSM (none) raster GEE JAXA/ALOS/AW3D30/V3_2 Digital surface model elevation (terrain + objects).
NasaDEM (none) raster GEE NASA/NASADEM_HGT/001 Ground elevation (SRTM-derived), Gaussian-smoothed.
FabDEM (none) raster GEE projects/sat-io/open-datasets/FABDEM Bare-earth DEM with forests/buildings removed.
Slope min_threshold=None raster derived from NasaDEM via ee.Terrain.slope Terrain slope in degrees, optionally binarized at a threshold.
HighSlope slope_threshold=10 raster derived from NasaDEM via xrspatial.slope Mask of terrain exceeding a slope threshold.

API

city_metrix.layers.alos_dsm.AlosDSM

AlosDSM(**kwargs)

Bases: Layer

OUTPUT_FILE_FORMAT class-attribute instance-attribute

OUTPUT_FILE_FORMAT = GTIFF_FILE_EXTENSION

MAJOR_NAMING_ATTS class-attribute instance-attribute

MAJOR_NAMING_ATTS = None

MINOR_NAMING_ATTS class-attribute instance-attribute

MINOR_NAMING_ATTS = None

get_data

get_data(bbox: GeoExtent, spatial_resolution: int = DEFAULT_SPATIAL_RESOLUTION, resampling_method: str = DEFAULT_RESAMPLING_METHOD)

city_metrix.layers.nasa_dem.NasaDEM

NasaDEM(**kwargs)

Bases: Layer

OUTPUT_FILE_FORMAT class-attribute instance-attribute

OUTPUT_FILE_FORMAT = GTIFF_FILE_EXTENSION

MAJOR_NAMING_ATTS class-attribute instance-attribute

MAJOR_NAMING_ATTS = None

MINOR_NAMING_ATTS class-attribute instance-attribute

MINOR_NAMING_ATTS = None

get_data

get_data(bbox: GeoExtent, spatial_resolution: int = DEFAULT_SPATIAL_RESOLUTION, resampling_method: str = DEFAULT_RESAMPLING_METHOD)

city_metrix.layers.fab_dem.FabDEM

FabDEM(**kwargs)

Bases: Layer

OUTPUT_FILE_FORMAT class-attribute instance-attribute

OUTPUT_FILE_FORMAT = GTIFF_FILE_EXTENSION

MAJOR_NAMING_ATTS class-attribute instance-attribute

MAJOR_NAMING_ATTS = None

MINOR_NAMING_ATTS class-attribute instance-attribute

MINOR_NAMING_ATTS = None

PROCESSING_TILE_SIDE_M class-attribute instance-attribute

PROCESSING_TILE_SIDE_M = 5000

get_data

get_data(bbox: GeoExtent, spatial_resolution: int = DEFAULT_SPATIAL_RESOLUTION, resampling_method: str = DEFAULT_RESAMPLING_METHOD)

city_metrix.layers.slope.Slope

Slope(min_threshold=None, **kwargs)

Bases: Layer

OUTPUT_FILE_FORMAT class-attribute instance-attribute

OUTPUT_FILE_FORMAT = GTIFF_FILE_EXTENSION

MAJOR_NAMING_ATTS class-attribute instance-attribute

MAJOR_NAMING_ATTS = None

MINOR_NAMING_ATTS class-attribute instance-attribute

MINOR_NAMING_ATTS = ['min_threshold']

Slope from NASADEM, a reanalysis of year-2000 SRTM data Unit is degrees

min_threshold instance-attribute

min_threshold = min_threshold

get_data

get_data(bbox: GeoExtent, spatial_resolution: int = DEFAULT_SPATIAL_RESOLUTION, resampling_method=None, force_data_refresh=False)

city_metrix.layers.high_slope.HighSlope

HighSlope(slope_threshold: int = 10, **kwargs)

Bases: Layer

OUTPUT_FILE_FORMAT class-attribute instance-attribute

OUTPUT_FILE_FORMAT = GTIFF_FILE_EXTENSION

MAJOR_NAMING_ATTS class-attribute instance-attribute

MAJOR_NAMING_ATTS = ['slope_threshold']

MINOR_NAMING_ATTS class-attribute instance-attribute

MINOR_NAMING_ATTS = None

Attributes: slope_threshold

slope_threshold instance-attribute

slope_threshold = slope_threshold

get_data

get_data(bbox: GeoExtent, spatial_resolution: int = DEFAULT_SPATIAL_RESOLUTION, resampling_method: str = DEFAULT_RESAMPLING_METHOD)