zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactor (Operator)

Name

zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactor — Zoom an image by a given factor.

Signature

zoom_image_factor(Image : ImageZoomed : ScaleWidth, ScaleHeight, Interpolation : )

Herror zoom_image_factor(const Hobject Image, Hobject* ImageZoomed, double ScaleWidth, double ScaleHeight, const char* Interpolation)

Herror T_zoom_image_factor(const Hobject Image, Hobject* ImageZoomed, const Htuple ScaleWidth, const Htuple ScaleHeight, const Htuple Interpolation)

void ZoomImageFactor(const HObject& Image, HObject* ImageZoomed, const HTuple& ScaleWidth, const HTuple& ScaleHeight, const HTuple& Interpolation)

HImage HImage::ZoomImageFactor(double ScaleWidth, double ScaleHeight, const HString& Interpolation) const

HImage HImage::ZoomImageFactor(double ScaleWidth, double ScaleHeight, const char* Interpolation) const

HImage HImage::ZoomImageFactor(double ScaleWidth, double ScaleHeight, const wchar_t* Interpolation) const   (Windows only)

static void HOperatorSet.ZoomImageFactor(HObject image, out HObject imageZoomed, HTuple scaleWidth, HTuple scaleHeight, HTuple interpolation)

HImage HImage.ZoomImageFactor(double scaleWidth, double scaleHeight, string interpolation)

Description

zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactorZoomImageFactor scales the image ImageImageImageImageimage by a factor of ScaleWidthScaleWidthScaleWidthScaleWidthscaleWidth in width and a factor ScaleHeightScaleHeightScaleHeightScaleHeightscaleHeight in height. The parameter InterpolationInterpolationInterpolationInterpolationinterpolation determines the type of interpolation used (see affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageAffineTransImage). The domain of the input image is ignored, i.e., assumed to be the full rectangle of the image.

Attention

If the system parameter 'int_zooming'"int_zooming""int_zooming""int_zooming""int_zooming" is set to 'true'"true""true""true""true", the internally used integer arithmetic may lead to errors in the following two cases: First, if zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactorZoomImageFactor is used on an uint2 or int2 image with high dynamics (i.e. images containing values close to the respective limits) in combination with scale factors smaller than 0.5, then the gray values of the output image may be erroneous. Second, if InterpolationInterpolationInterpolationInterpolationinterpolation is set to a value other than 'nearest_neighbor'"nearest_neighbor""nearest_neighbor""nearest_neighbor""nearest_neighbor", a large scale factor is applied, and a large output image is obtained, then undefined gray values at the lower and at the right image border may result. The maximum width of this border of undefined gray values can be estimated as , where S is the scale factor in one dimension and I is the size of the output image in the corresponding dimension. In both cases, it is recommended to set 'int_zooming'"int_zooming""int_zooming""int_zooming""int_zooming" to 'false'"false""false""false""false" via the operator set_systemset_systemSetSystemSetSystemSetSystem.

zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactorZoomImageFactor is not parallelized internally if ScaleWidthScaleWidthScaleWidthScaleWidthscaleWidth = 0.5 and ScaleHeightScaleHeightScaleHeightScaleHeightscaleHeight = 0.5. Further zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactorZoomImageFactor is not parallelized internally with InterpolationInterpolationInterpolationInterpolationinterpolation='nearest_neighbor'"nearest_neighbor""nearest_neighbor""nearest_neighbor""nearest_neighbor".

zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactorZoomImageFactor 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

Parameters

ImageImageImageImageimage (input_object)  (multichannel-)image(-array) objectHImageHImageHobject (byte* / int2* / uint2* / real*) *allowed for compute devices

Input image.

ImageZoomedImageZoomedImageZoomedImageZoomedimageZoomed (output_object)  (multichannel-)image(-array) objectHImageHImageHobject * (byte / int2 / uint2 / real)

Scaled image.

ScaleWidthScaleWidthScaleWidthScaleWidthscaleWidth (input_control)  extent.x HTupleHTupleHtuple (real) (double) (double) (double)

Scale factor for the width of the image.

Default value: 0.5

Suggested values: 0.25, 0.5, 1.5, 2.0

Typical range of values: 0.001 ≤ ScaleWidth ScaleWidth ScaleWidth ScaleWidth scaleWidth ≤ 10.0

Minimum increment: 0.001

Recommended increment: 0.1

ScaleHeightScaleHeightScaleHeightScaleHeightscaleHeight (input_control)  extent.y HTupleHTupleHtuple (real) (double) (double) (double)

Scale factor for the height of the image.

Default value: 0.5

Suggested values: 0.25, 0.5, 1.5, 2.0

Typical range of values: 0.001 ≤ ScaleHeight ScaleHeight ScaleHeight ScaleHeight scaleHeight ≤ 10.0

Minimum increment: 0.001

Recommended increment: 0.1

InterpolationInterpolationInterpolationInterpolationinterpolation (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Type of interpolation.

Default value: '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)
zoom_image_factor (Image, ZoomImage, 0.25, 0.25, 'constant')
dev_display (ZoomImage)

Example (C)

read_image(&Image,"monkey");
disp_image(Image,WindowHandle);
zoom_image_factor(Image,&ZooImage,0.25,0.25,"constant");
disp_image(ZooImage,WindowHandle);

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
zoom_image_factor (Image, ZoomImage, 0.25, 0.25, 'constant')
dev_display (ZoomImage)

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
zoom_image_factor (Image, ZoomImage, 0.25, 0.25, 'constant')
dev_display (ZoomImage)

Example (HDevelop)

read_image(Image,'monkey')
dev_display (Image)
zoom_image_factor (Image, ZoomImage, 0.25, 0.25, 'constant')
dev_display (ZoomImage)

Alternatives

zoom_image_sizezoom_image_sizeZoomImageSizeZoomImageSizeZoomImageSize, affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageAffineTransImage, hom_mat2d_scalehom_mat2d_scaleHomMat2dScaleHomMat2dScaleHomMat2dScale

See also

hom_mat2d_scalehom_mat2d_scaleHomMat2dScaleHomMat2dScaleHomMat2dScale, affine_trans_imageaffine_trans_imageAffineTransImageAffineTransImageAffineTransImage

Module

Foundation