Operator Reference

mirror_imagemirror_imageMirrorImageMirrorImagemirror_image (Operator)

mirror_imagemirror_imageMirrorImageMirrorImagemirror_image — Mirror an image.

Signature

mirror_image(Image : ImageMirror : Mode : )

Herror mirror_image(const Hobject Image, Hobject* ImageMirror, const char* Mode)

Herror T_mirror_image(const Hobject Image, Hobject* ImageMirror, const Htuple Mode)

void MirrorImage(const HObject& Image, HObject* ImageMirror, const HTuple& Mode)

HImage HImage::MirrorImage(const HString& Mode) const

HImage HImage::MirrorImage(const char* Mode) const

HImage HImage::MirrorImage(const wchar_t* Mode) const   ( Windows only)

static void HOperatorSet.MirrorImage(HObject image, out HObject imageMirror, HTuple mode)

HImage HImage.MirrorImage(string mode)

def mirror_image(image: HObject, mode: str) -> HObject

Description

mirror_imagemirror_imageMirrorImageMirrorImagemirror_image reflects an image ImageImageImageimageimage about one of three possible axes. If ModeModeModemodemode is set to 'row'"row""row""row""row", it is reflected about the horizontal axis, if ModeModeModemodemode is set to 'column'"column""column""column""column", about the vertical axis, and if ModeModeModemodemode is set to 'diagonal'"diagonal""diagonal""diagonal""diagonal", about the main diagonal x=y.

Attention

mirror_imagemirror_imageMirrorImageMirrorImagemirror_image can be executed on OpenCL devices if the input image does not exceed the maximum size of image objects of the selected device. However, execution might be faster on the CPU, especially for the mode 'row'"row""row""row""row".

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* / int4* / real*) *allowed for compute devices

Input image.

ImageMirrorImageMirrorImageMirrorimageMirrorimage_mirror (output_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject * (byte / int2 / uint2 / int4 / real)

Reflected image.

ModeModeModemodemode (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Axis of reflection.

Default: 'row' "row" "row" "row" "row"

List of values: 'column'"column""column""column""column", 'diagonal'"diagonal""diagonal""diagonal""diagonal", 'row'"row""row""row""row"

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
mirror_image(Image,MirrorImage,'row')
dev_display (MirrorImage)

Example (C)

read_image(&Image,"monkey");
disp_image(Image,WindowHandle);
mirror_image(Image,&MirImage,"row");
disp_image(MirImage,WindowHandle);

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
mirror_image(Image,MirrorImage,'row')
dev_display (MirrorImage)

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
mirror_image(Image,MirrorImage,'row')
dev_display (MirrorImage)

Alternatives

hom_mat2d_rotatehom_mat2d_rotateHomMat2dRotateHomMat2dRotatehom_mat2d_rotate, hom_mat2d_reflecthom_mat2d_reflectHomMat2dReflectHomMat2dReflecthom_mat2d_reflect, affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageaffine_trans_image, rotate_imagerotate_imageRotateImageRotateImagerotate_image

See also

rotate_imagerotate_imageRotateImageRotateImagerotate_image, hom_mat2d_rotatehom_mat2d_rotateHomMat2dRotateHomMat2dRotatehom_mat2d_rotate

Module

Foundation