Operator Reference

HALCON Operator Reference / Matrix / Features

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

ClassesClasses | | Operators

sum_matrixT_sum_matrixSumMatrixSumMatrixsum_matrix (Operator)

sum_matrixT_sum_matrixSumMatrixSumMatrixsum_matrix — Returns the elementwise sum of a matrix.

Signature

sum_matrix( : : MatrixID, SumType : MatrixSumID)

Herror T_sum_matrix(const Htuple MatrixID, const Htuple SumType, Htuple* MatrixSumID)

void SumMatrix(const HTuple& MatrixID, const HTuple& SumType, HTuple* MatrixSumID)

HMatrix HMatrix::SumMatrix(const HString& SumType) const

HMatrix HMatrix::SumMatrix(const char* SumType) const

HMatrix HMatrix::SumMatrix(const wchar_t* SumType) const   ( Windows only)

static void HOperatorSet.SumMatrix(HTuple matrixID, HTuple sumType, out HTuple matrixSumID)

HMatrix HMatrix.SumMatrix(string sumType)

def sum_matrix(matrix_id: HHandle, sum_type: str) -> HHandle

Description

The operator sum_matrixsum_matrixSumMatrixSumMatrixsum_matrix returns the sum of the elements of the Matrix defined by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. A new matrix MatrixSum is generated with the result and the matrix handle MatrixSumIDMatrixSumIDMatrixSumIDmatrixSumIDmatrix_sum_id of this matrix is returned. Access to the elements of the matrix is possible e.g., with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixget_full_matrix.

The type of sum determination of the matrix can be selected via the parameter SumTypeSumTypeSumTypesumTypesum_type:

'columns'"columns""columns""columns""columns":

The sum is returned for each column of the Matrix separately. The resulting matrix MatrixSum has one row and the identical number of columns as the input matrix.

Example:

SumTypeSumTypeSumTypesumTypesum_type = 'columns'"columns""columns""columns""columns"

'rows'"rows""rows""rows""rows":

The sum is returned for each row of the Matrix separately. The resulting matrix MatrixSum has the identical number of rows as the input matrix and one column.

Example:

SumTypeSumTypeSumTypesumTypesum_type = 'rows'"rows""rows""rows""rows"

'full'"full""full""full""full":

The sum is returned using all elements of the Matrix. The resulting matrix MatrixSum has one row and one column.

Example:

SumTypeSumTypeSumTypesumTypesum_type = 'full'"full""full""full""full"

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

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

Matrix handle of the input matrix.

SumTypeSumTypeSumTypesumTypesum_type (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Type of summation.

Default: 'columns' "columns" "columns" "columns" "columns"

List of values: 'columns'"columns""columns""columns""columns", 'full'"full""full""full""full", 'rows'"rows""rows""rows""rows"

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

Matrix handle with the sum of the input matrix.

Result

If the parameters are valid, the operator sum_matrixsum_matrixSumMatrixSumMatrixsum_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

norm_matrixnorm_matrixNormMatrixNormMatrixnorm_matrix

Module

Foundation

---

ClassesClasses | | Operators