revrt.routing.base.CharacterizedLayer#
- class CharacterizedLayer(name, layer, option, is_length_invariant=False, agg_method=None)[source]#
Bases:
objectEncapsulate tracked routing layer metadata
- Parameters:
name (
str) – Identifier used when reporting layer-derived metrics.layer (
xarray.DataArrayordask.array.Array) – Data values sampled from the routing stack.option (
str) – Routing option this layer should characterize. When set, metrics only use matching route cells.is_length_invariant (
bool, defaultFalse) – Flag signaling cost values should ignore segment length. By default,False.agg_method (
str, optional) – Name of dask aggregation used when tracking statistics. By default,None.
Methods
compute(route, cell_size, point_lens)Compute layer metrics along a route
- compute(route, cell_size, point_lens)[source]#
Compute layer metrics along a route
- Parameters:
route (sequence) – Ordered
(row, col, option)indices describing the path.cell_size (
float) – Raster cell size in meters for distance calculations.point_lens (array-like) – Per-route-cell distances aligned with
route.
- Returns:
dict– Mapping of metric names to aggregated layer values.