read_variation_modelT_read_variation_modelReadVariationModelReadVariationModelread_variation_model (Operator)
Name
read_variation_modelT_read_variation_modelReadVariationModelReadVariationModelread_variation_model — Read a variation model from a file.
Signature
def read_variation_model(file_name: str) -> HHandle
Description
The operator read_variation_modelread_variation_modelReadVariationModelReadVariationModelReadVariationModelread_variation_model reads a variation model,
which has been written with write_variation_modelwrite_variation_modelWriteVariationModelWriteVariationModelWriteVariationModelwrite_variation_model, from the
file FileNameFileNameFileNameFileNamefileNamefile_name.
The default HALCON file extension for a variation model is 'vam'.
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
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
File name.
File extension:
.vam
ModelIDModelIDModelIDModelIDmodelIDmodel_id (output_control) variation_model → HVariationModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
ID of the variation model.
Result
If the file name is valid, the operator read_variation_modelread_variation_modelReadVariationModelReadVariationModelReadVariationModelread_variation_model
returns 2 (
H_MSG_TRUE)
. If necessary an exception is raised.
Possible Successors
compare_variation_modelcompare_variation_modelCompareVariationModelCompareVariationModelCompareVariationModelcompare_variation_model,
compare_ext_variation_modelcompare_ext_variation_modelCompareExtVariationModelCompareExtVariationModelCompareExtVariationModelcompare_ext_variation_model
See also
write_variation_modelwrite_variation_modelWriteVariationModelWriteVariationModelWriteVariationModelwrite_variation_model
Module
Matching