read_measureT_read_measureReadMeasureReadMeasureread_measure (Operator)

Name

read_measureT_read_measureReadMeasureReadMeasureread_measure — Read a measure object from a file.

Signature

read_measure( : : FileName : MeasureHandle)

Herror T_read_measure(const Htuple FileName, Htuple* MeasureHandle)

void ReadMeasure(const HTuple& FileName, HTuple* MeasureHandle)

void HMeasure::ReadMeasure(const HString& FileName)

void HMeasure::ReadMeasure(const char* FileName)

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

static void HOperatorSet.ReadMeasure(HTuple fileName, out HTuple measureHandle)

void HMeasure.ReadMeasure(string fileName)

def read_measure(file_name: str) -> HHandle

Description

read_measureread_measureReadMeasureReadMeasureReadMeasureread_measure reads a measure object, which has been written with write_measurewrite_measureWriteMeasureWriteMeasureWriteMeasurewrite_measure from the file FileNameFileNameFileNameFileNamefileNamefile_name. The default HALCON file extension for a measure object is 'msr'. The values contained in the read measure object are stored in a measure object with the handle MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle.

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

Execution Information

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: .msr

MeasureHandleMeasureHandleMeasureHandleMeasureHandlemeasureHandlemeasure_handle (output_control)  measure HMeasure, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Measure object handle.

Result

If the parameters are valid, the operator read_measureread_measureReadMeasureReadMeasureReadMeasureread_measure returns the value TRUE. If necessary, an exception is raised.

Possible Successors

measure_posmeasure_posMeasurePosMeasurePosMeasurePosmeasure_pos, measure_pairsmeasure_pairsMeasurePairsMeasurePairsMeasurePairsmeasure_pairs

See also

write_measurewrite_measureWriteMeasureWriteMeasureWriteMeasurewrite_measure

Module

1D Metrology