revrt.routing.cli.build_costs.build_final_routing_layers#
- build_final_routing_layers(lcp_config_fp, output_dir, polarity=None, voltage=None)[source]#
Build out the final routing layers based on an LCP config file
Given an LCP config file, build out the final routing layers used by
reVRt. The routing layers include the aggregated cost layer and the final routing layer that is used for computing routes. The layers that are created and added to the file are determined based on the input config file. The config file can specify three types of actions: building custom layers, building dry cost layers, and merging friction and barriers. At least one of these actions must be specified in the config file. See the documentation for more details on each type of action.- Parameters:
lcp_config_fp (path-like) – Path to LCP config file for which the routing layer should be created.
output_dir (path-like) – Path to directory where to store the outputs.
polarity (
str, optional) – Polarity to use when building the routing layer. This input is required if any cost or friction layers that have apply_polarity_mult set to True - they will have the appropriate multiplier applied based on this polarity. By default,None.voltage (
str, optional) – Voltage to use when building the routing layer. This input is required if any cost or friction layers that have apply_row_mult or apply_polarity_mult set to True - they will have the appropriate multiplier applied based on this voltage. By default,None.
- Returns:
list– List of paths to the GeoTIFF files that were created.