Operator Reference

HALCON Operator Reference / Filters / Geometric Transformations
ClassesClasses | | Operators

rotate_imagerotate_imageRotateImageRotateImagerotate_image (Operator)

rotate_imagerotate_imageRotateImageRotateImagerotate_image — Rotate an image about its center.

Signature

rotate_image(Image : ImageRotate : Phi, Interpolation : )

Herror rotate_image(const Hobject Image, Hobject* ImageRotate, double Phi, const char* Interpolation)

Herror T_rotate_image(const Hobject Image, Hobject* ImageRotate, const Htuple Phi, const Htuple Interpolation)

void RotateImage(const HObject& Image, HObject* ImageRotate, const HTuple& Phi, const HTuple& Interpolation)

HImage HImage::RotateImage(const HTuple& Phi, const HString& Interpolation) const

HImage HImage::RotateImage(double Phi, const HString& Interpolation) const

HImage HImage::RotateImage(double Phi, const char* Interpolation) const

HImage HImage::RotateImage(double Phi, const wchar_t* Interpolation) const   ( Windows only)

static void HOperatorSet.RotateImage(HObject image, out HObject imageRotate, HTuple phi, HTuple interpolation)

HImage HImage.RotateImage(HTuple phi, string interpolation)

HImage HImage.RotateImage(double phi, string interpolation)

def rotate_image(image: HObject, phi: Union[int, float], interpolation: str) -> HObject

Description

rotate_imagerotate_imageRotateImageRotateImagerotate_image rotates the ImageImageImageimageimage counterclockwise by PhiPhiPhiphiphi degrees about its center and stores the result in the output image ImageRotateImageRotateImageRotateimageRotateimage_rotate. The output image has the same size as the input image. The only exception are rotations by 90 and 270 degrees where width and height will be exchanged. The domain of the input image is ignored, i.e., assumed to be the full rectangle of the image. The domain of the output image is the intersection of the transformed rectangle and the rectangle of the output image.

If PhiPhiPhiphiphi is a multiple of 90 degrees, this operator is much faster, especially than the general operator affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageaffine_trans_image. The effect of the parameter InterpolationInterpolationInterpolationinterpolationinterpolation is the same as in affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageaffine_trans_image. It is ignored for rotations by 90, 180, and 270 degrees. If it is necessary to rotate the domain, too, the operator projective_trans_imageprojective_trans_imageProjectiveTransImageProjectiveTransImageprojective_trans_image must be used.

Additionally, for images of type byte, int2 or uint2 the system parameter 'int_zooming'"int_zooming""int_zooming""int_zooming""int_zooming" selects between fast calculation in fixed point arithmetics ('int_zooming'"int_zooming""int_zooming""int_zooming""int_zooming" = 'true'"true""true""true""true") and highly accurate calculation in floating point arithmetics ('int_zooming'"int_zooming""int_zooming""int_zooming""int_zooming" = 'false'"false""false""false""false"). Except for rotations by 90, 180, or 270 degrees, fixed point calculation can lead to minor gray value deviations. Furthermore, the domain of resulting images can differ as well.

Attention

The domain of the input image is ignored, i.e., assumed to be the full rectangle of the image. The domain of the output image is the intersection of the transformed rectangle and the rectangle of the output image. The angle PhiPhiPhiphiphi is given in degrees, not in radians. For rotations by 90, 180, and 270 degrees rotate_imagerotate_imageRotateImageRotateImagerotate_image is not parallelized internally.

rotate_imagerotate_imageRotateImageRotateImagerotate_image can be executed on OpenCL devices if the input image does not exceed the maximum size of image objects of the selected device. Due to numerical reasons, there can be slight differences in the output compared to the execution on the CPU.

Execution Information

  • Supports OpenCL compute devices.
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Automatically parallelized on tuple level.
  • Automatically parallelized on channel level.
  • Automatically parallelized on internal data level.

Parameters

ImageImageImageimageimage (input_object)  (multichannel-)image(-array) → objectHImageHObjectHObjectHobject (byte* / int2* / uint2* / real*) *allowed for compute devices

Input image.

ImageRotateImageRotateImageRotateimageRotateimage_rotate (output_object)  (multichannel-)image(-array) → objectHImageHObjectHObjectHobject * (byte / int2 / uint2 / real)

Rotated image.

PhiPhiPhiphiphi (input_control)  angle.deg → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Rotation angle.

Default: 90

Suggested values: 90, 180, 270

Value range: 0 ≤ Phi Phi Phi phi phi ≤ 360

Minimum increment: 0.001

Recommended increment: 0.2

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

Type of interpolation.

Default: 'constant' "constant" "constant" "constant" "constant"

List of values: 'bicubic'"bicubic""bicubic""bicubic""bicubic", 'bilinear'"bilinear""bilinear""bilinear""bilinear", 'constant'"constant""constant""constant""constant", 'nearest_neighbor'"nearest_neighbor""nearest_neighbor""nearest_neighbor""nearest_neighbor", 'weighted'"weighted""weighted""weighted""weighted"

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
rotate_image(Image,RotImage,270,'constant')
dev_display (RotImage)

Example (C)

read_image(&Image,"monkey");
disp_image(Image,WindowHandle);
rotate_image(Image,&RotImage,270,'constant');
disp_image(RotImage,WindowHandle);

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
rotate_image(Image,RotImage,270,'constant')
dev_display (RotImage)

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
rotate_image(Image,RotImage,270,'constant')
dev_display (RotImage)

Alternatives

hom_mat2d_rotatehom_mat2d_rotateHomMat2dRotateHomMat2dRotatehom_mat2d_rotate, affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageaffine_trans_image

See also

mirror_imagemirror_imageMirrorImageMirrorImagemirror_image

Module

Foundation

ClassesClasses | | Operators