Operator Reference

HALCON Operator Reference / Matrix / File

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

read_matrixT_read_matrixReadMatrixReadMatrixread_matrix (Operator)

read_matrixT_read_matrixReadMatrixReadMatrixread_matrix — Read a matrix from a file.

Signature

read_matrix( : : FileName : MatrixID)

Herror T_read_matrix(const Htuple FileName, Htuple* MatrixID)

void ReadMatrix(const HTuple& FileName, HTuple* MatrixID)

void HMatrix::HMatrix(const HString& FileName)

void HMatrix::HMatrix(const char* FileName)

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

void HMatrix::ReadMatrix(const HString& FileName)

void HMatrix::ReadMatrix(const char* FileName)

void HMatrix::ReadMatrix(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ReadMatrix(HTuple fileName, out HTuple matrixID)

public HMatrix(string fileName)

void HMatrix.ReadMatrix(string fileName)

def read_matrix(file_name: str) -> HHandle

Description

The operator read_matrixread_matrixReadMatrixReadMatrixread_matrix reads a matrix, which has been written to the file with write_matrixwrite_matrixWriteMatrixWriteMatrixwrite_matrix, from the file FileNameFileNameFileNamefileNamefile_name. The default HALCON file extension for the matrix is 'mtx'. The format of the file can be binary or ascii. Each row of the file contains one row of a matrix with a number of columns. The columns are separated with white spaces or tabs. Each row must have the same number of columns. Empty lines are ignored.

The reading results are stored in the matrix Matrix. The operator returns the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id of this matrix. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix.

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

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (output_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle.

Result

If the file name is valid, the operator read_matrixread_matrixReadMatrixReadMatrixread_matrix returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix

Module

Foundation

---

ClassesClasses | | Operators