reVeal.grid.CharacterizeGrid#

class CharacterizeGrid(config)[source]#

Bases: RunnableGrid

Subclass of RunnableGrid for running characterizations.

Initialize grid from configuration.

Parameters:

config ([dict, CharacterizeConfig]) – Input configuration as either a dictionary or a CharacterizationConfig instance. If a dictionary, validation will be performed to ensure inputs are valid.

Methods

run()

Run grid characterization based on the input configuration.

CONFIG_CLASS#

alias of CharacterizeConfig

run()[source]#

Run grid characterization based on the input configuration.

Returns:

gpd.GeoDataFrame – A GeoDataFrame with the characterized grid.