Operator Reference

HALCON Operator Reference / Matrix / Arithmetic

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

ClassesClasses | | Operators

scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixModscale_matrix_mod (Operator)

scale_matrix_modT_scale_matrix_modScaleMatrixModScaleMatrixModscale_matrix_mod — Scale a matrix.

Signature

scale_matrix_mod( : : MatrixID, Factor : )

Herror T_scale_matrix_mod(const Htuple MatrixID, const Htuple Factor)

void ScaleMatrixMod(const HTuple& MatrixID, const HTuple& Factor)

void HMatrix::ScaleMatrixMod(const HTuple& Factor) const

void HMatrix::ScaleMatrixMod(double Factor) const

static void HOperatorSet.ScaleMatrixMod(HTuple matrixID, HTuple factor)

void HMatrix.ScaleMatrixMod(HTuple factor)

void HMatrix.ScaleMatrixMod(double factor)

def scale_matrix_mod(matrix_id: HHandle, factor: Union[int, float]) -> None

Description

The operator scale_matrixscale_matrixScaleMatrixScaleMatrixscale_matrix scales the Matrix by a constant factor. The matrix is defined by the matrix handle MatrixIDMatrixIDMatrixIDmatrixIDmatrix_id. 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:

FactorFactorFactorfactorfactor = 1.5

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.

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

Scale factor.

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 scale_matrix_modscale_matrix_modScaleMatrixModScaleMatrixModscale_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

scale_matrixscale_matrixScaleMatrixScaleMatrixscale_matrix

See also

mult_element_matrixmult_element_matrixMultElementMatrixMultElementMatrixmult_element_matrix, mult_element_matrix_modmult_element_matrix_modMultElementMatrixModMultElementMatrixModmult_element_matrix_mod, div_element_matrixdiv_element_matrixDivElementMatrixDivElementMatrixdiv_element_matrix, div_element_matrix_moddiv_element_matrix_modDivElementMatrixModDivElementMatrixModdiv_element_matrix_mod

Module

Foundation

---

ClassesClasses | | Operators