onstove.DataProcessor.get_distance_rasters#

DataProcessor.get_distance_rasters(datasets: str | dict = 'all', save_layers: bool = False)[source]#

Calls the .distance_raster method of all the layers entered.

The function calculates the distance either as proximity or as traveltime see RasterLayer.get_distance_raster or VectorLayer.get_distance_raster

Parameters:

datasets: str or dict, default “all”

Defines the datasets to be normalized. Can be entered as either a string or a dictionary.

Example#

datasets={'category_1': ['layer_1', 'layer_2'],
          'category_2': [...]}

save_layer: bool, default False

Determines whether to save the distance raster to disc or not.