Operator Reference

HALCON Operator Reference / Matrix / Arithmetic

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

ClassesClasses | | Operators

pow_scalar_element_matrix_modT_pow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_mod (Operator)

pow_scalar_element_matrix_modT_pow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_mod — Compute the power functions of the elements of a matrix.

Signature

pow_scalar_element_matrix_mod( : : MatrixID, Power : )

Herror T_pow_scalar_element_matrix_mod(const Htuple MatrixID, const Htuple Power)

void PowScalarElementMatrixMod(const HTuple& MatrixID, const HTuple& Power)

void HMatrix::PowScalarElementMatrixMod(const HTuple& Power) const

void HMatrix::PowScalarElementMatrixMod(double Power) const

static void HOperatorSet.PowScalarElementMatrixMod(HTuple matrixID, HTuple power)

void HMatrix.PowScalarElementMatrixMod(HTuple power)

void HMatrix.PowScalarElementMatrixMod(double power)

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

Description

The operator pow_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_mod computes the power of all elements of the input Matrix by a constant value. The input Matrix is given by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. The power value is given by the parameter PowerPowerPowerpowerpower. 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_matrixGetFullMatrixGetFullMatrixget_full_matrix. The formula for the calculation of the result is:

Example:

PowerPowerPowerpowerpower = [2.0]

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.

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

The power.

Default: 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_scalar_element_matrix_modpow_scalar_element_matrix_modPowScalarElementMatrixModPowScalarElementMatrixModpow_scalar_element_matrix_mod 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

Alternatives

pow_scalar_element_matrixpow_scalar_element_matrixPowScalarElementMatrixPowScalarElementMatrixpow_scalar_element_matrix, pow_element_matrixpow_element_matrixPowElementMatrixPowElementMatrixpow_element_matrix, pow_element_matrix_modpow_element_matrix_modPowElementMatrixModPowElementMatrixModpow_element_matrix_mod

See also

sqrt_matrixsqrt_matrixSqrtMatrixSqrtMatrixsqrt_matrix, sqrt_matrix_modsqrt_matrix_modSqrtMatrixModSqrtMatrixModsqrt_matrix_mod

Module

Foundation

---

ClassesClasses | | Operators