reVX.config.transmission_layer_creation.MergeFrictionBarriers

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

Bases: BaseModel

Combine friction and barriers and save to H5. Multiple all barrier values by a factor. 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

`model_computed_fields`
`model_fields`
`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.
`attrs`	Additional H5 dataset attributes for the combined output layer.

friction_layer: str

Name of friction layer.

Must be a layer that has just been created or already exists in the tiff directory with the same name and ‘.tif’ extension.

barrier_layer: str

Name of barrier layer.

Must be a layer that has just been created or already exists in the tiff directory with the same name and ‘.tif’ extension.

output_layer_name: str | None

Name of combined output layer.

By default, BARRIER_H5_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.

attrs: Dict | None: Additional H5 dataset attributes for the combined output layer.