Operator Reference

write_metrology_modelT_write_metrology_modelWriteMetrologyModelWriteMetrologyModelwrite_metrology_model (Operator)

write_metrology_modelT_write_metrology_modelWriteMetrologyModelWriteMetrologyModelwrite_metrology_model — Write a metrology model to a file.

Signature

write_metrology_model( : : MetrologyHandle, FileName : )

Herror T_write_metrology_model(const Htuple MetrologyHandle, const Htuple FileName)

void WriteMetrologyModel(const HTuple& MetrologyHandle, const HTuple& FileName)

void HMetrologyModel::WriteMetrologyModel(const HString& FileName) const

void HMetrologyModel::WriteMetrologyModel(const char* FileName) const

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

static void HOperatorSet.WriteMetrologyModel(HTuple metrologyHandle, HTuple fileName)

void HMetrologyModel.WriteMetrologyModel(string fileName)

def write_metrology_model(metrology_handle: HHandle, file_name: str) -> None

Description

write_metrology_modelwrite_metrology_modelWriteMetrologyModelWriteMetrologyModelwrite_metrology_model writes a metrology model to the file FileNameFileNameFileNamefileNamefile_name. The metrology model is defined by the handle MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. The metrology model can be read with read_metrology_modelread_metrology_modelReadMetrologyModelReadMetrologyModelread_metrology_model. The default HALCON file extension for a metrology model is 'mtr'.

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

Attention

Note that only the input values are saved, i.e., no measure regions and no results obtained by the operator apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model are saved.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

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

Handle of the metrology model.

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

File name.

File extension: .mtr

Result

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

Possible Predecessors

apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model

Possible Successors

clear_metrology_modelclear_metrology_modelClearMetrologyModelClearMetrologyModelclear_metrology_model

See also

read_metrology_modelread_metrology_modelReadMetrologyModelReadMetrologyModelread_metrology_model

Module

2D Metrology