revrt.routing.cli.point_to_point.PointToPointRouteDefinitionConverter#

class PointToPointRouteDefinitionConverter(cost_fpath, route_points, out_fp, cost_layers, friction_layers=None, transmission_config=None)[source]#

Bases: RouteToDefinitionConverter

Convert route points DataFrame to route definition for Rust

Parameters:

  • cost_fpath (path-like) – Path to layered Zarr file containing cost and other required routing layers.

  • route_points (pandas.DataFrame) – DataFrame defining the points to be routed. This DataFrame should contain route definitions to be transformed and passed down to the Rust routing algorithm.

  • out_fp (path-like) – Path to output file where computed routes will be saved. This file will be checked for existing routes to avoid recomputation.

  • cost_layers (list) – List of dictionaries defining the layers that are summed to determine total costs raster used for routing. Each layer is pre-processed before summation according to the user input. See the description of revrt.routing.cli.point_to_point.compute_lcp_routes() for more details.

  • friction_layers (list) – Layers to be multiplied onto the aggregated cost layer to influence routing but NOT be reported in final cost (i.e. friction, barriers, etc.). See the description of revrt.routing.cli.point_to_point.compute_lcp_routes() for more details.

  • transmission_config (path-like or dict, optional) – Dictionary of transmission cost configuration values, or path to JSON/JSON5 file containing this dictionary. See the description of revrt.routing.cli.point_to_point.compute_lcp_routes() for more details.

Methods

Attributes

cost_metadata

Metadata from cost file (CRS, transform, shape)

existing_routes

Already computed routes in the output file

num_routes

Number of routes to be computed
property cost_metadata#

Metadata from cost file (CRS, transform, shape)

Type:

dict

property existing_routes#

Already computed routes in the output file

Type:

set

property num_routes#

Number of routes to be computed

Type:

int