Operator Reference

read_metrology_modelT_read_metrology_modelReadMetrologyModelReadMetrologyModelread_metrology_model (Operator)

read_metrology_modelT_read_metrology_modelReadMetrologyModelReadMetrologyModelread_metrology_model — Read a metrology model from a file.

Signature

read_metrology_model( : : FileName : MetrologyHandle)

Herror T_read_metrology_model(const Htuple FileName, Htuple* MetrologyHandle)

void ReadMetrologyModel(const HTuple& FileName, HTuple* MetrologyHandle)

void HMetrologyModel::HMetrologyModel(const HString& FileName)

void HMetrologyModel::HMetrologyModel(const char* FileName)

void HMetrologyModel::HMetrologyModel(const wchar_t* FileName)   ( Windows only)

void HMetrologyModel::ReadMetrologyModel(const HString& FileName)

void HMetrologyModel::ReadMetrologyModel(const char* FileName)

void HMetrologyModel::ReadMetrologyModel(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ReadMetrologyModel(HTuple fileName, out HTuple metrologyHandle)

public HMetrologyModel(string fileName)

void HMetrologyModel.ReadMetrologyModel(string fileName)

def read_metrology_model(file_name: str) -> HHandle

Description

read_metrology_modelread_metrology_modelReadMetrologyModelReadMetrologyModelread_metrology_model reads a metrology model, which has been written to file with write_metrology_modelwrite_metrology_modelWriteMetrologyModelWriteMetrologyModelwrite_metrology_model, from the file FileNameFileNameFileNamefileNamefile_name. The default HALCON file extension for a metrology model is 'mtr'. The values contained in the read metrology model are stored in a metrology model with the handle MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. Access to the parameters of the metrology model is possible, e.g., with the operator get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_param or get_metrology_object_fuzzy_paramget_metrology_object_fuzzy_paramGetMetrologyObjectFuzzyParamGetMetrologyObjectFuzzyParamget_metrology_object_fuzzy_param.

For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.

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

FileNameFileNameFileNamefileNamefile_name (input_control)  filename.read HTuplestrHTupleHtuple (string) (string) (HString) (char*)

File name.

File extension: .mtr

MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (output_control)  metrology_model HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the metrology model.

Result

If the parameters are valid, the operator read_metrology_modelread_metrology_modelReadMetrologyModelReadMetrologyModelread_metrology_model returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Successors

get_metrology_object_indicesget_metrology_object_indicesGetMetrologyObjectIndicesGetMetrologyObjectIndicesget_metrology_object_indices, apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model

See also

write_metrology_modelwrite_metrology_modelWriteMetrologyModelWriteMetrologyModelwrite_metrology_model

Module

2D Metrology