revrt.models.cost_layers.MergeFrictionBarriers#

class MergeFrictionBarriers(*, friction_layer: str, barrier_layer: str, output_layer_name: str | None = 'transmission_barrier', barrier_multiplier: float = 1000000.0)[source]#

Bases: BaseModel

Config to combine friction and barriers and save to file

All barrier values are multiplied by a factor before merging with friction. The multiplier should be large enough that all barriers have a higher value than any possible friction.

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

friction_layer

Name of friction layer

barrier_layer

Name of barrier layer

output_layer_name

Name of combined output layer

barrier_multiplier

Value to multiply barrier layer by during merge with friction

friction_layer: str#

Name of friction layer

A file with this name plus a ‘.tif’ extension must have just been created or had already existed in the tiff directory.

barrier_layer: str#

Name of barrier layer

A file with this name plus a ‘.tif’ extension must have just been created or had already existed in the tiff directory.

output_layer_name: str | None#

Name of combined output layer

By default, BARRIER_LAYER_NAME.

barrier_multiplier: float#

Value to multiply barrier layer by during merge with friction

The multiplier should be large enough that all barriers have a higher value than any possible friction.