Operator Reference

write_measureT_write_measureWriteMeasureWriteMeasurewrite_measure (Operator)

write_measureT_write_measureWriteMeasureWriteMeasurewrite_measure — Write a measure object to a file.

Signature

write_measure( : : MeasureHandle, FileName : )

Herror T_write_measure(const Htuple MeasureHandle, const Htuple FileName)

void WriteMeasure(const HTuple& MeasureHandle, const HTuple& FileName)

void HMeasure::WriteMeasure(const HString& FileName) const

void HMeasure::WriteMeasure(const char* FileName) const

void HMeasure::WriteMeasure(const wchar_t* FileName) const   ( Windows only)

static void HOperatorSet.WriteMeasure(HTuple measureHandle, HTuple fileName)

void HMeasure.WriteMeasure(string fileName)

def write_measure(measure_handle: HHandle, file_name: str) -> None

Description

write_measurewrite_measureWriteMeasureWriteMeasurewrite_measure writes a measure object that has been created by, e.g., gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2 to the file FileNameFileNameFileNamefileNamefile_name. The measure object is defined by the handle MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle. The measure object can be read with read_measureread_measureReadMeasureReadMeasureread_measure. The default HALCON file extension for a measure object is 'msr'.

For an explanation of the concept of 1D measuring see the introduction of chapter 1D Measuring.

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

MeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle (input_control)  measure HMeasure, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Measure object handle.

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

File name.

File extension: .msr

Result

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

Possible Predecessors

gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2, gen_measure_arcgen_measure_arcGenMeasureArcGenMeasureArcgen_measure_arc

See also

read_measureread_measureReadMeasureReadMeasureread_measure

Module

1D Metrology