Skip to content

write_metrology_modelWriteMetrologyModelWriteMetrologyModelwrite_metrology_modelT_write_metrology_model🔗

Short description🔗

write_metrology_modelWriteMetrologyModelWriteMetrologyModelwrite_metrology_modelT_write_metrology_model — Write a metrology model to a file.

Signature🔗

write_metrology_model( metrology_model MetrologyHandle, filename.write FileName )void WriteMetrologyModel( const HTuple& MetrologyHandle, const HTuple& FileName )static void HOperatorSet.WriteMetrologyModel( HTuple metrologyHandle, HTuple fileName )def write_metrology_model( metrology_handle: HHandle, file_name: str ) -> None

Herror T_write_metrology_model( 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)

void HMetrologyModel.WriteMetrologyModel( string fileName )

Description🔗

write_metrology_modelWriteMetrologyModel writes a metrology model to the file FileNamefileNamefile_name. The metrology model is defined by the handle MetrologyHandlemetrologyHandlemetrology_handle. The metrology model can be read with read_metrology_modelReadMetrologyModel. 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_modelApplyMetrologyModel are saved.

Execution information🔗

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🔗

MetrologyHandlemetrologyHandlemetrology_handle (input_control) metrology_model → (handle)HTuple (HHandle)HMetrologyModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the metrology model.

FileNamefileNamefile_name (input_control) filename.write → (string)HTuple (HString)HTuple (string)strHtuple (char*)

File name.

File extension: .mtr

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

apply_metrology_modelApplyMetrologyModel

Possible successors

clear_metrology_modelClearMetrologyModel

See also

read_metrology_modelReadMetrologyModel

Module🔗

2D Metrology