Module: mls.convert. This page documents 8 public functions with exact tool IDs, complete parameters, Parameters fields, and examples.
Back to the Script Tool API Reference
Functions
convert_convert_to_ascii
Convert point cloud to ASCII format
- Exact tool ID:
Convert_Convert_to_ASCII
- Recommended call:
mls.convert.convert_convert_to_ascii(...)
- Alias:
Convert_Convert_to_ASCII
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
ASCII conversion parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
parse |
string |
No |
'xyzticRGB' |
Which attributes need to be exported (e.g., xyzticRGB) |
OutColorType |
integer |
No |
0 |
Output color type |
m_outIntensityType |
integer |
No |
0 |
Output intensity type |
ASCIIType |
integer |
No |
0 |
ASCII type |
separator |
string |
No |
',' |
Separator character |
isAllExtendAttribute |
integer |
No |
0 |
Export all extend attributes |
extendAttribute |
string |
No |
'' |
Extend attribute names |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_ascii_parameters()
params.parse = 'xyzticRGB'
result = mls.convert.convert_convert_to_ascii(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)
convert_convert_to_las
Convert point cloud to LAS format
- Exact tool ID:
Convert_Convert_to_Las
- Recommended call:
mls.convert.convert_convert_to_las(...)
- Alias:
Convert_Convert_to_Las
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
LAS conversion parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
parse |
string |
No |
'xyzticRGB' |
Which attributes need to be exported (e.g., xyzticRGB) |
OutColorType |
integer |
No |
0 |
Output color type |
OutIntensityType |
integer |
No |
0 |
Output intensity type |
m_FromUnitType |
integer |
No |
0 |
From unit type |
m_ToUnitType |
integer |
No |
0 |
To unit type |
lasVersion |
integer |
No |
0 |
LAS version: 0=1.2, 1=1.3, 2=1.4 |
isAllExtendAttribute |
integer |
No |
0 |
Export all extend attributes |
extendAttribute |
string |
No |
'' |
Extend attribute names |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_las_parameters()
params.parse = 'xyzticRGB'
result = mls.convert.convert_convert_to_las(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)
convert_convert_to_copc
Convert point cloud to COPC format
- Exact tool ID:
Convert_Convert_to_COPC
- Recommended call:
mls.convert.convert_convert_to_copc(...)
- Alias:
Convert_Convert_to_COPC
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
COPC conversion parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
parse |
string |
No |
'xyzticRGB' |
Which attributes need to be exported (e.g., xyzticRGB) |
OutColorType |
integer |
No |
0 |
Output color type |
OutIntensityType |
integer |
No |
0 |
Output intensity type |
m_FromUnitType |
integer |
No |
0 |
From unit type |
m_ToUnitType |
integer |
No |
0 |
To unit type |
lasVersion |
integer |
No |
0 |
LAS version: 0=1.2, 1=1.3, 2=1.4 |
isAllExtendAttribute |
integer |
No |
0 |
Export all extend attributes |
extendAttribute |
string |
No |
'' |
Extend attribute names |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_copc_parameters()
params.parse = 'xyzticRGB'
result = mls.convert.convert_convert_to_copc(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)
convert_convert_to_pcd
Convert point cloud to PCD format
- Exact tool ID:
Convert_Convert_to_PCD
- Recommended call:
mls.convert.convert_convert_to_pcd(...)
- Alias:
Convert_Convert_to_PCD
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
PCD conversion parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
parse |
string |
No |
'xyzticRGB' |
Which attributes need to be exported (e.g., xyzticRGB) |
isAllExtendAttribute |
integer |
No |
0 |
Export all extend attributes |
extendAttribute |
string |
No |
'' |
Extend attribute names |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_pcd_parameters()
params.parse = 'xyzticRGB'
result = mls.convert.convert_convert_to_pcd(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)
convert_convert_to_structede57
Convert point cloud to structured E57 format
- Exact tool ID:
Convert_Convert_To_StructedE57
- Recommended call:
mls.convert.convert_convert_to_structede57(...)
- Alias:
Convert_Convert_To_StructedE57
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
Convert to structured E57 parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
panoPath |
string |
No |
— |
Panorama imglist path. |
imgSpan |
number |
No |
10.0 |
Image sampling interval |
minDistance |
number |
No |
1.0 |
Minimum point distance |
maxDistance |
number |
No |
100.0 |
Maximum point distance, max 200m |
imgWidth |
integer |
No |
2048 |
Image width |
imgHeight |
integer |
No |
1024 |
Image height |
mergeOutput |
boolean |
No |
True |
Merge output into single file |
savePano |
boolean |
No |
True |
Save panoramic image |
outputPath |
string |
No |
— |
Output path. When mergeOutput is true, specifies the output directory; when false, specifies the full output file path |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_structede57_parameters()
params.panoPath = 'D:/data/input.LiData'
result = mls.convert.convert_convert_to_structede57(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)
convert_convert_to_unstructed_e57
Convert point cloud to Unstructured E57 format
- Exact tool ID:
Convert_Convert_to_Unstructed_E57
- Recommended call:
mls.convert.convert_convert_to_unstructed_e57(...)
- Alias:
Convert_Convert_to_Unstructed_E57
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
E57 conversion parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
parse |
string |
No |
'xyzicRGB' |
Which attributes need to be exported (e.g., xyzicRGB) |
OutColorType |
integer |
No |
0 |
Output color type |
m_outIntensityType |
integer |
No |
0 |
Output intensity type |
imgPath |
string |
No |
'' |
Image path |
isAllExtendAttribute |
integer |
No |
1 |
Export all extend attributes |
imageSpan |
integer |
No |
10 |
Image span |
extendAttribute |
string |
No |
'' |
Extend attribute names |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_unstructed_e57_parameters()
params.parse = 'xyzicRGB'
result = mls.convert.convert_convert_to_unstructed_e57(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)
convert_convert_to_ply
Convert point cloud to PLY format
- Exact tool ID:
Convert_Convert_to_PLY
- Recommended call:
mls.convert.convert_convert_to_ply(...)
- Alias:
Convert_Convert_to_PLY
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
PLY conversion parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
parse |
string |
No |
'xyzticRGB' |
Which attributes need to be exported (e.g., xyzticRGB) |
isAllExtendAttribute |
integer |
No |
0 |
Export all extend attributes |
OutColorType |
integer |
No |
0 |
Output color type |
m_outIntensityType |
integer |
No |
0 |
Output intensity type |
extendAttribute |
string |
No |
'' |
Extend attribute names |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_ply_parameters()
params.parse = 'xyzticRGB'
result = mls.convert.convert_convert_to_ply(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)
convert_convert_to_tiff
Convert point cloud to TIFF format
- Exact tool ID:
Convert_Convert_to_TIFF
- Recommended call:
mls.convert.convert_convert_to_tiff(...)
- Alias:
Convert_Convert_to_TIFF
- Required parameters:
input_paths, Parameters
Parameters
| Parameter |
Type |
Required |
Default |
Description |
input_paths |
array |
Yes |
— |
Input point cloud file paths |
output_path |
string |
No |
'' |
Output folder. If the user does not specify, set this parameter to "" |
Parameters |
object |
Yes |
— |
TIFF conversion parameters |
Parameters fields
| Field |
Type |
Required |
Default |
Description |
RasterStyle |
integer |
No |
0 |
Raster style |
cellValueType |
integer |
No |
0 |
Cell value type |
cellRGBValueType |
integer |
No |
0 |
Cell RGB value type |
isMergeOne |
integer |
No |
1 |
Merge into one raster |
XSize |
number |
No |
2 |
X cell size |
YSize |
number |
No |
2 |
Y cell size |
enableColorBar |
integer |
No |
0 |
Enable color bar |
colorBarIndex |
integer |
No |
0 |
Color bar index |
fixHoles |
integer |
No |
1 |
Fix holes |
Example
from gvscript import mls
params = mls.convert.convert_convert_to_tiff_parameters()
params.RasterStyle = 0
result = mls.convert.convert_convert_to_tiff(
Parameters=params,
input_paths=['D:/data/input.LiData'],
output_path='',
)
print(result.ok, result.output, result.message)