Operator Reference

hom_mat2d_scaleT_hom_mat2d_scaleHomMat2dScaleHomMat2dScalehom_mat2d_scale (Operator)

hom_mat2d_scaleT_hom_mat2d_scaleHomMat2dScaleHomMat2dScalehom_mat2d_scale — Add a scaling to a homogeneous 2D transformation matrix.

Signature

hom_mat2d_scale( : : HomMat2D, Sx, Sy, Px, Py : HomMat2DScale)

Herror T_hom_mat2d_scale(const Htuple HomMat2D, const Htuple Sx, const Htuple Sy, const Htuple Px, const Htuple Py, Htuple* HomMat2DScale)

void HomMat2dScale(const HTuple& HomMat2D, const HTuple& Sx, const HTuple& Sy, const HTuple& Px, const HTuple& Py, HTuple* HomMat2DScale)

HHomMat2D HHomMat2D::HomMat2dScale(const HTuple& Sx, const HTuple& Sy, const HTuple& Px, const HTuple& Py) const

HHomMat2D HHomMat2D::HomMat2dScale(double Sx, double Sy, double Px, double Py) const

static void HOperatorSet.HomMat2dScale(HTuple homMat2D, HTuple sx, HTuple sy, HTuple px, HTuple py, out HTuple homMat2DScale)

HHomMat2D HHomMat2D.HomMat2dScale(HTuple sx, HTuple sy, HTuple px, HTuple py)

HHomMat2D HHomMat2D.HomMat2dScale(double sx, double sy, double px, double py)

def hom_mat2d_scale(hom_mat_2d: Sequence[float], sx: Union[float, int], sy: Union[float, int], px: Union[float, int], py: Union[float, int]) -> Sequence[float]

Description

hom_mat2d_scalehom_mat2d_scaleHomMat2dScaleHomMat2dScalehom_mat2d_scale adds a scaling by the scale factors SxSxSxsxsx and SySySysysy to the homogeneous 2D transformation matrix HomMat2DHomMat2DHomMat2DhomMat2Dhom_mat_2d and returns the resulting matrix in HomMat2DScaleHomMat2DScaleHomMat2DScalehomMat2DScalehom_mat_2dscale. The scaling is described by a 2×2 scaling matrix S. It is performed relative to the global (i.e., fixed) coordinate system; this corresponds to the following chain of transformation matrices:

The point (PxPxPxpxpx,PyPyPypypy) is the fixed point of the transformation, i.e., this point remains unchanged when transformed using HomMat2DScaleHomMat2DScaleHomMat2DScalehomMat2DScalehom_mat_2dscale. To obtain this behavior, first a translation is added to the input transformation matrix that moves the fixed point onto the origin of the global coordinate system. Then, the scaling is added, and finally a translation that moves the fixed point back to its original position. This corresponds to the following chain of transformations:

To perform the transformation in the local coordinate system, i.e., the one described by HomMat2DHomMat2DHomMat2DhomMat2Dhom_mat_2d, use hom_mat2d_scale_localhom_mat2d_scale_localHomMat2dScaleLocalHomMat2dScaleLocalhom_mat2d_scale_local.

Attention

It should be noted that homogeneous transformation matrices refer to a general right-handed mathematical coordinate system. If a homogeneous transformation matrix is used to transform images, regions, XLD contours, or any other data that has been extracted from images, the row coordinates of the transformation must be passed in the x coordinates, while the column coordinates must be passed in the y coordinates. Consequently, the order of passing row and column coordinates follows the usual order (RowRowRowrowrow,ColumnColumnColumncolumncolumn). This convention is essential to obtain a right-handed coordinate system for the transformation of iconic data, and consequently to ensure in particular that rotations are performed in the correct mathematical direction.

Note that homogeneous matrices are stored row-by-row as a tuple; the last row is usually not stored because it is identical for all homogeneous matrices that describe an affine transformation. For example, the homogeneous matrix is stored as the tuple [ra, rb, tc, rd, re, tf]. However, it is also possible to process full 3×3 matrices, which represent a projective 2D transformation.

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

HomMat2DHomMat2DHomMat2DhomMat2Dhom_mat_2d (input_control)  hom_mat2d HHomMat2D, HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Input transformation matrix.

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

Scale factor along the x-axis.

Default: 2

Suggested values: 0.125, 0.25, 0.5, 1, 2, 4, 8, 16

Restriction: Sx != 0

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

Scale factor along the y-axis.

Default: 2

Suggested values: 0.125, 0.25, 0.5, 1, 2, 4, 8, 16

Restriction: Sy != 0

PxPxPxpxpx (input_control)  point.x HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Fixed point of the transformation (x coordinate).

Default: 0

Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024

PyPyPypypy (input_control)  point.y HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Fixed point of the transformation (y coordinate).

Default: 0

Suggested values: 0, 16, 32, 64, 128, 256, 512, 1024

HomMat2DScaleHomMat2DScaleHomMat2DScalehomMat2DScalehom_mat_2dscale (output_control)  hom_mat2d HHomMat2D, HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Output transformation matrix.

Result

hom_mat2d_scalehom_mat2d_scaleHomMat2dScaleHomMat2dScalehom_mat2d_scale returns 2 ( H_MSG_TRUE) if both scale factors are not 0. If necessary, an exception is raised.

Possible Predecessors

hom_mat2d_identityhom_mat2d_identityHomMat2dIdentityHomMat2dIdentityhom_mat2d_identity, hom_mat2d_translatehom_mat2d_translateHomMat2dTranslateHomMat2dTranslatehom_mat2d_translate, hom_mat2d_scalehom_mat2d_scaleHomMat2dScaleHomMat2dScalehom_mat2d_scale, hom_mat2d_rotatehom_mat2d_rotateHomMat2dRotateHomMat2dRotatehom_mat2d_rotate, hom_mat2d_slanthom_mat2d_slantHomMat2dSlantHomMat2dSlanthom_mat2d_slant, hom_mat2d_reflecthom_mat2d_reflectHomMat2dReflectHomMat2dReflecthom_mat2d_reflect

Possible Successors

hom_mat2d_translatehom_mat2d_translateHomMat2dTranslateHomMat2dTranslatehom_mat2d_translate, hom_mat2d_scalehom_mat2d_scaleHomMat2dScaleHomMat2dScalehom_mat2d_scale, hom_mat2d_rotatehom_mat2d_rotateHomMat2dRotateHomMat2dRotatehom_mat2d_rotate, hom_mat2d_slanthom_mat2d_slantHomMat2dSlantHomMat2dSlanthom_mat2d_slant, hom_mat2d_reflecthom_mat2d_reflectHomMat2dReflectHomMat2dReflecthom_mat2d_reflect

See also

hom_mat2d_scale_localhom_mat2d_scale_localHomMat2dScaleLocalHomMat2dScaleLocalhom_mat2d_scale_local

Module

Foundation