Operator Reference
read_shape_model_3d (Operator)
read_shape_model_3d
— Read a 3D shape model from a file.
Signature
read_shape_model_3d( : : FileName : ShapeModel3DID)
Description
The operator read_shape_model_3d
reads a 3D shape model, which
has been written with write_shape_model_3d
, from the file
FileName
. The default HALCON file extension for the 3D
shape model is 'sm3'.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.
Parameters
FileName
(input_control) filename.read →
(string)
File name.
File extension:
.sm3
ShapeModel3DID
(output_control) shape_model_3d →
(handle)
Handle of the 3D shape model.
Result
If the file name is valid, the operator read_shape_model_3d
returns the value 2 (
H_MSG_TRUE)
. If necessary an exception is raised.
Possible Successors
find_shape_model_3d
,
get_shape_model_3d_params
See also
create_shape_model_3d
,
clear_shape_model_3d
Module
3D Metrology