revrt.models.routing.TrackedLayer#

class TrackedLayer(*, layer_name: str, agg_method: str, multiplier_layer: str | None = None, multiplier_scalar: float = 1)[source]#

Bases: BaseModel

Config for one route-characterization layer

Tracked layers mirror the scaling behavior used by cost layers, but do not contribute to routing cost and do not influence the routing objective. They are only sampled along the chosen route and summarized into additional output columns.

The rest of this docstring is inserted by Pydantic and can be ignored.

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

`layer_name`	Name of layer in layered file to aggregate along the route
`agg_method`	Name of the `dask.array` aggregation applied to route values
`multiplier_layer`	Optional layer of multipliers to apply before aggregation
`multiplier_scalar`	Optional scalar multiplier applied before aggregation

layer_name: str#: Name of layer in layered file to aggregate along the route

agg_method: str#

Name of the dask.array aggregation applied to route values

Examples of this input include "sum", "mean", "max", etc.

multiplier_layer: str | None#: Optional layer of multipliers to apply before aggregation

multiplier_scalar: float#: Optional scalar multiplier applied before aggregation