revrt.models.cost_layers.LayerBuildConfig#
- class LayerBuildConfig(*, extent: Literal['all', 'wet', 'wet+', 'landfall', 'dry+', 'dry'] = 'all', global_value: float | None = None, map: dict[float, float] | None = None, bins: list[RangeConfig] | None = None, pass_through: bool | None = False, rasterize: Rasterize | None = None, forced_inclusion: bool = False, na_fill: float | int | None = 0)[source]#
Bases:
BaseModelFriction and barrier layers config model
The inputs global_value, map, bins, rasterize, and forced_inclusion are exclusive, but exactly one must be specified.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Methods
Attributes
Extent to apply map or range to
Global value to use for entire layer extent
Values in raster (keys) and values to use layer
Ranges of raster values
Pass cost data through without extra processing
Rasterize a vector and save as layer
Force inclusion
Value to fill NA cells with after processing
- extent: Literal['all', 'wet', 'wet+', 'landfall', 'dry+', 'dry']#
Extent to apply map or range to
Must be one of the following:
‘all’: Full extent, including offshore, onshore, and landfall
‘wet’: offshore extent only
‘wet+’: offshore extent + landfall extent
‘landfall’: landfall extent (area between wet and dry extents)
‘dry+’: onshore extent + landfall extent
‘dry’: onshore extent only
By default, ‘all’.
- bins: list[RangeConfig] | None#
Ranges of raster values
This input can be one or more ranges of raster values to apply to barrier/friction. The value of overlapping ranges are added together.