onstove.MCA.set_supply_index#

MCA.set_supply_index(datasets: dict[str, list[str]] = 'all', buffer: bool = False)[source]#

Computes the supply_index based on the datasets provided.

It calls the get_index() method with the provided datasets, which normalizes the results including or excluding areas defined by the buffer and returns a RasterLayer with the computed data and the base_layer RasterLayer.meta information. The output RasterLayer is saved in the :attr:`supply_index`attribute.

Parameters:

datasets: dictionary of ``category``-``list of layer names`` pairs, default ‘all’

Specifies which dataset(s) to use to compute the index.

datasets example:#

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

buffer: str, default ``False``

Whether to buffer the areas outside the RasterLayer.distance_limit.