Road Analysis API
Module: mls.roadanalysis. This page documents 2 public functions with exact tool IDs, complete parameters, Parameters fields, and examples.
Back to the Script Tool API Reference
Functions
road_analysis_height_clearance— Calculate the height between power lines and ground points at equal intervals, and calculate the minimum and maximum height.road_analysis_height_clearance_report— Export the report of height clearance analysis.
road_analysis_height_clearance
Calculate the height between power lines and ground points at equal intervals, and calculate the minimum and maximum height.
- Exact tool ID:
Road_Analysis_Height_Clearance - Recommended call:
mls.roadanalysis.road_analysis_height_clearance(...) - Alias:
Road_Analysis_Height_Clearance - Required parameters:
inputLayerName
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input_paths |
array |
No | — |
REQUIRED when user provides 2+ files. Put ALL file paths here. output_path will be used as output directory |
inputLayerName |
string |
Yes | — |
The name of power line vector layer |
searchRadius |
number |
No | — |
Plane search radius centered on the current power line node |
aboveHeight |
number |
No | — |
Upward search radius centered on the current power line node |
belowHeight |
number |
No | — |
Downward search radius centered on the current power line node |
step |
number |
No | — |
Analysis step length along the power line |
targetType |
integer |
No | — |
0: lowest depth, 1:highest depth, 2:lowest point coordinates, 3:highest point coordinates, 4:average depth, 5:median depth |
Example
from gvscript import mls
result = mls.roadanalysis.road_analysis_height_clearance(
input_paths=['D:/data/input.LiData'],
inputLayerName='example_name',
searchRadius=1,
aboveHeight=1,
belowHeight=1,
step=1,
targetType=1,
)
print(result.ok, result.output, result.message)
road_analysis_height_clearance_report
Export the report of height clearance analysis.
- Exact tool ID:
Road_Analysis_Height_Clearance_Report - Recommended call:
mls.roadanalysis.road_analysis_height_clearance_report(...) - Alias:
Road_Analysis_Height_Clearance_Report - Required parameters:
path
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input_paths |
array |
No | — |
REQUIRED when user provides 2+ files. Put ALL file paths here. output_path will be used as output directory |
path |
string |
Yes | — |
The path of report file |
Example
from gvscript import mls
result = mls.roadanalysis.road_analysis_height_clearance_report(
input_paths=['D:/data/input.LiData'],
path='D:/data/input.LiData',
)
print(result.ok, result.output, result.message)