Operator Reference

HALCON Operator Reference / Matrix / Access

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

ClassesClasses | | Operators

set_diagonal_matrixT_set_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix (Operator)

set_diagonal_matrixT_set_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix — Set the diagonal elements of a matrix.

Signature

set_diagonal_matrix( : : MatrixID, VectorID, Diagonal : )

Herror T_set_diagonal_matrix(const Htuple MatrixID, const Htuple VectorID, const Htuple Diagonal)

void SetDiagonalMatrix(const HTuple& MatrixID, const HTuple& VectorID, const HTuple& Diagonal)

void HMatrix::SetDiagonalMatrix(const HMatrix& VectorID, Hlong Diagonal) const

static void HOperatorSet.SetDiagonalMatrix(HTuple matrixID, HTuple vectorID, HTuple diagonal)

void HMatrix.SetDiagonalMatrix(HMatrix vectorID, int diagonal)

def set_diagonal_matrix(matrix_id: HHandle, vector_id: HHandle, diagonal: int) -> None

Description

The operator set_diagonal_matrixset_diagonal_matrixSetDiagonalMatrixSetDiagonalMatrixset_diagonal_matrix overwrites the diagonal elements of the Matrix with the elements of the matrix Vector. The matrices are defined by their matrix handles MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id and VectorIDVectorIDVectorIDvectorIDvector_id. The matrix Vector must have one column and one row, n columns and one row or one column and n rows. n is the number of elements to be set in the Matrix (see below). If the matrix Vector has one column and one row, i.e., the matrix has one value, each element of the diagonal of the Matrix is overwritten by this value. Otherwise, the diagonal is overwritten by the elements of the matrix Vector.

If DiagonalDiagonalDiagonaldiagonaldiagonal = 0, the main diagonal of the Matrix is overwritten. The number n = min(number of rows of Matrix, number of columns of Matrix).

Example 1:

Example 2:

If DiagonalDiagonalDiagonaldiagonaldiagonal is positive, the DiagonalDiagonalDiagonaldiagonaldiagonal-th super-diagonal of Matrix is overwritten. For the example 1 the number n = min(number of rows of Matrix, parameter DiagonalDiagonalDiagonaldiagonaldiagonal). For the example 2 the number n = min(number of rows of Matrix, number of columns of Matrix).

Example 1:

Example 2:

If DiagonalDiagonalDiagonaldiagonaldiagonal is negative, the DiagonalDiagonalDiagonaldiagonaldiagonal-th sub-diagonal of Matrix is overwritten. For the example 1 the number n = min(number of columns of Matrix, parameter DiagonalDiagonalDiagonaldiagonaldiagonal). For the example 2 the number n = min(number of rows of Matrix, number of columns of Matrix).

Example 1:

Example 2:

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 modifies the state of the following input parameter:

• MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id (input_control, state is modified)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle of the input matrix.

VectorIDVectorIDVectorIDvectorIDvector_id (input_control)  matrix → HMatrix, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Matrix handle containing the diagonal elements to be set.

DiagonalDiagonalDiagonaldiagonaldiagonal (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Position of the diagonal.

Default: 0

Suggested values: -20, -10, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 10, 20

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixget_value_matrix

See also

get_diagonal_matrixget_diagonal_matrixGetDiagonalMatrixGetDiagonalMatrixget_diagonal_matrix

Module

Foundation

---

ClassesClasses | | Operators