HALCON Reference Manual 10.0.2

sub_matrix_modsub_matrix_modsub_matrix_modSubMatrixModSubMatrixMod (Operator)

Name

sub_matrix_modsub_matrix_modsub_matrix_modSubMatrixModSubMatrixMod — Subtract two matrices.

Signature

sub_matrix_mod( : : MatrixAID, MatrixBID : )

The operator sub_matrix_modsub_matrix_modsub_matrix_modSubMatrixModSubMatrixMod computes the difference of the input matrices MatrixAMatrixAMatrixAMatrixAmatrixA and MatrixBMatrixBMatrixBMatrixBmatrixB given by the matrix handles MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID and MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID. Both matrices must have identical dimensions. The input matrix MatrixAMatrixAMatrixAMatrixAmatrixA is overwritten with the result. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixget_full_matrixGetFullMatrixGetFullMatrix. The formula for the calculation of the result is:

  MatrixAMatrixAMatrixAMatrixAmatrixA = MatrixAMatrixAMatrixAMatrixAmatrixA - MatrixBMatrixBMatrixBMatrixBmatrixB.

Example:


            /   3.0   1.0  -2.0  \                /   2.0   8.0  -3.0  \
  MatrixA = |  -5.0   7.0   2.0  |      MatrixB = |  -4.0  -1.0   5.0  |
            \  -9.0  -4.0   1.0  /                \   2.0  -4.0   7.0  /

                 /   1.0  -7.0   1.0  \
  ->   MatrixA = |  -1.0   8.0  -3.0  |
                 \ -11.0   0.0  -6.0  /

Attention

sub_matrix_modsub_matrix_modsub_matrix_modSubMatrixModSubMatrixMod modifies the content of an already existing matrix.

Parallelization

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

MatrixAIDMatrixAIDMatrixAIDMatrixAIDmatrixAID (input_control) matrix → (integer)

Matrix handle of the input matrix A.

MatrixBIDMatrixBIDMatrixBIDMatrixBIDmatrixBID (input_control) matrix → (integer)

Matrix handle of the input matrix B.

Result

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