gvscript Basics
gvscript is the Python interface for calling LiDAR360MLS functions and runs only inside LiDAR360MLS. Import mls, then call tools by business module:
from gvscript import mls
result = mls.system.get_software_version()
print(result.result)
gvscript example
Two calling styles
Use module wrappers such as mls.project.get_project_info() for normal scripts. They provide documentation, parameter validation, and completion. For a known exact tool ID or dynamic dispatch, use:
import gvscript
result = gvscript.run_tool("get_software_version", {})
print(result.tool_id, result.result)
tool_id must be a non-empty string, and params must be a dictionary or None. Prefer module wrappers for fixed business workflows.
Discover APIs
- Type
mls.to browse modules. - Type a concrete module and trailing period, such as
mls.project., to browse functions. - Hover over a function for documentation and parameters.
- For a tool with
Parameters, call*_parameters()and typeparams.to discover fields.
Module index
| Module | Main purpose |
|---|---|
mls.classify |
Point-cloud classification |
mls.convert |
Data and format conversion |
mls.facility |
Facility extraction |
mls.gpkg |
GeoPackage data management |
mls.io |
Load and remove data |
mls.layer |
Layer management |
mls.map_element |
Map elements |
mls.pavement |
Pavement analysis |
mls.point_cloud |
Point-cloud processing |
mls.project |
Projects and loaded data |
mls.road_terrain |
Road terrain |
mls.roadanalysis |
Road analysis |
mls.system |
Application and system information |
mls.table |
Attribute tables |
mls.ui |
Interface layout and components |
mls.urban_forest |
Urban forestry |
mls.vector |
Vector data |
mls.vector_conversion |
Vector conversion |
mls.viewer |
View control |
This guide provides module-level discovery only. The parameter reference for the 127 public tools is maintained as a separate API documentation task. Availability depends on the installed build, plug-ins, license, and application state.
API reference appendix
For parameters, Parameters fields, and examples for all 127 public tools in 19 modules, see the Script Tool API Reference.