revrt.models.cost_layers.LayerConfig#

class LayerConfig(*, layer_name: str, description: str | None = None, include_in_file: bool | None = True, values_are_costs_per_mile: bool | None = False, build: dict[str, LayerBuildConfig])[source]#

Bases: BaseModel

Config for friction, barrier, and costs processing

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_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`model_extra`	Get extra fields set during validation.
`model_fields`
`model_fields_set`	Returns the set of fields that have been explicitly set on this model instance.
`layer_name`	Name of layer in H5 file
`description`	Optional description to store in attrs for layer
`include_in_file`	Flag to specify whether layer should be stored in the file
`values_are_costs_per_mile`	Option to specify that the values given represent $/mile
`build`	Mapping of layer components used to build this layer

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property model_extra: dict[str, Any] | None#

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to “allow”.

property model_fields_set: set[str]#

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

include_in_file: bool | None#: Flag to specify whether layer should be stored in the file

values_are_costs_per_mile: bool | None#

Option to specify that the values given represent $/mile

If True, the values will be converted to $/cell_size, which is what is ultimately used for routing.

Mapping of layer components used to build this layer

Keys are GeoTIFF or vector filepaths. Values are the LayerBuildConfig to use for that file.