HALCON 20.11.0.0 / HALCON Operator Reference / Matrix / Arithmetic
ClassesClasses | | Operators

pow_matrix_modT_pow_matrix_modPowMatrixModPowMatrixModpow_matrix_mod (Operator)

Name

pow_matrix_modT_pow_matrix_modPowMatrixModPowMatrixModpow_matrix_mod — Compute the power functions of a matrix.

Signature

pow_matrix_mod( : : MatrixID, MatrixType, Power : )

Herror T_pow_matrix_mod(const Htuple MatrixID, const Htuple MatrixType, const Htuple Power)

void PowMatrixMod(const HTuple& MatrixID, const HTuple& MatrixType, const HTuple& Power)

void HMatrix::PowMatrixMod(const HString& MatrixType, const HTuple& Power) const

void HMatrix::PowMatrixMod(const HString& MatrixType, double Power) const

void HMatrix::PowMatrixMod(const char* MatrixType, double Power) const

void HMatrix::PowMatrixMod(const wchar_t* MatrixType, double Power) const   (Windows only)

static void HOperatorSet.PowMatrixMod(HTuple matrixID, HTuple matrixType, HTuple power)

void HMatrix.PowMatrixMod(string matrixType, HTuple power)

void HMatrix.PowMatrixMod(string matrixType, double power)

def pow_matrix_mod(matrix_id: HHandle, matrix_type: str, power: Union[int, float]) -> None

Description

The operator pow_matrix_modpow_matrix_modPowMatrixModPowMatrixModPowMatrixModpow_matrix_mod computes the power of the input MatrixMatrixMatrixMatrixmatrixmatrix by a constant value. The input MatrixMatrixMatrixMatrixmatrixmatrix is given by the matrix handle MatrixIDMatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The power value is given by the parameter PowerPowerPowerPowerpowerpower. The input matrix is overwritten with the result. Access to the elements of the matrix is possible e.g. with the operator get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix.

The type of the MatrixMatrixMatrixMatrixmatrixmatrix can be selected via MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type. The following values are supported: 'general'"general""general""general""general""general" for general, 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric" for symmetric, 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite" for symmetric positive definite, 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular" for upper triangular, 'permuted_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular" for permuted upper triangular, 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular" for lower triangular, and 'permuted_lower_triangular'"permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular" for permuted lower triangular matrices. The formula for the calculation of the result is:

Example:

Attention

For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite", or 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular" the upper triangular part of the input MatrixMatrixMatrixMatrixmatrixmatrix must contain the relevant information of the matrix. The strictly lower triangular part of the matrix is not referenced. For MatrixTypeMatrixTypeMatrixTypeMatrixTypematrixTypematrix_type = 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular" the lower triangular part of the input MatrixMatrixMatrixMatrixmatrixmatrix must contain the relevant information of the matrix. The strictly upper triangular part of the matrix is not referenced. If the referenced part of the input MatrixMatrixMatrixMatrixmatrixmatrix is not of the specified type, an exception is raised.

pow_matrix_modpow_matrix_modPowMatrixModPowMatrixModPowMatrixModpow_matrix_mod modifies the content of an already existing matrix.

Execution Information

This operator modifies the state of the following input parameter:

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

Parameters

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

Matrix handle of the input matrix.

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

The type of the input matrix.

Default value: 'general' "general" "general" "general" "general" "general"

List of values: 'general'"general""general""general""general""general", 'lower_triangular'"lower_triangular""lower_triangular""lower_triangular""lower_triangular""lower_triangular", 'permuted_lower_triangular'"permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular""permuted_lower_triangular", 'permuted_upper_triangular'"permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular""permuted_upper_triangular", 'positive_definite'"positive_definite""positive_definite""positive_definite""positive_definite""positive_definite", 'symmetric'"symmetric""symmetric""symmetric""symmetric""symmetric", 'upper_triangular'"upper_triangular""upper_triangular""upper_triangular""upper_triangular""upper_triangular"

PowerPowerPowerPowerpowerpower (input_control)  number → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

The power.

Default value: 2.0

Suggested values: 0.1, 0.2, 0.3, 0.5, 0.7, 1.0, 1.5, 2.0, 3.0, 5.0, 10.0

Result

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

Possible Predecessors

create_matrixcreate_matrixCreateMatrixCreateMatrixCreateMatrixcreate_matrix

Possible Successors

get_full_matrixget_full_matrixGetFullMatrixGetFullMatrixGetFullMatrixget_full_matrix, get_value_matrixget_value_matrixGetValueMatrixGetValueMatrixGetValueMatrixget_value_matrix

Alternatives

pow_matrixpow_matrixPowMatrixPowMatrixPowMatrixpow_matrix, eigenvalues_symmetric_matrixeigenvalues_symmetric_matrixEigenvaluesSymmetricMatrixEigenvaluesSymmetricMatrixEigenvaluesSymmetricMatrixeigenvalues_symmetric_matrix, eigenvalues_general_matrixeigenvalues_general_matrixEigenvaluesGeneralMatrixEigenvaluesGeneralMatrixEigenvaluesGeneralMatrixeigenvalues_general_matrix

See also

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixSqrtMatrixsqrt_matrix, sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModSqrtMatrixModsqrt_matrix_mod

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 20.11.0.0 Copyright © 1996-2020 MVTec Software GmbH