Skip to content

zoom_image_sizeZoomImageSizeZoomImageSizezoom_image_sizezoom_image_size🔗

Short description🔗

zoom_image_sizeZoomImageSizeZoomImageSizezoom_image_sizezoom_image_size — Zoom an image to a given size.

Signature🔗

zoom_image_size( image Image, out image ImageZoom, extent.x Width, extent.y Height, string Interpolation )void ZoomImageSize( const HObject& Image, HObject* ImageZoom, const HTuple& Width, const HTuple& Height, const HTuple& Interpolation )static void HOperatorSet.ZoomImageSize( HObject image, out HObject imageZoom, HTuple width, HTuple height, HTuple interpolation )def zoom_image_size( image: HObject, width: int, height: int, interpolation: str ) -> HObject

Herror zoom_image_size( const Hobject Image, Hobject* ImageZoom, const Hlong Width, const Hlong Height, const char* Interpolation )

Herror T_zoom_image_size( const Hobject Image, Hobject* ImageZoom, const Htuple Width, const Htuple Height, const Htuple Interpolation )

HImage HImage::ZoomImageSize( Hlong Width, Hlong Height, const HString& Interpolation ) const

HImage HImage::ZoomImageSize( Hlong Width, Hlong Height, const char* Interpolation ) const

HImage HImage::ZoomImageSize( Hlong Width, Hlong Height, const wchar_t* Interpolation ) const (Windows only)

HImage HImage.ZoomImageSize( int width, int height, string interpolation )

Description🔗

zoom_image_sizeZoomImageSize scales the image Imageimageimage to the size given by Widthwidthwidth and Heightheightheight. The parameter Interpolationinterpolationinterpolation determines the type of interpolation used (see affine_trans_imageAffineTransImage). 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" is set to 'true'"true", the internally used integer arithmetic may lead to errors in the following three cases: First, if zoom_image_sizeZoomImageSize 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 (ratio of output to input image size) smaller than \(0.5\), then the gray values of the output image may be erroneous. Second, if Interpolationinterpolationinterpolation is set to a value other than '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 \(B_{max}\) of this border of undefined gray values can be estimated as \(B_{max}=0.5 \cdot S \cdot I / 2^{15}\), where \(S\) is the scale factor in one dimension and \(I\) is the size of the output image in the corresponding dimension. Third, for real images undefined gray values can occur on all image borders, if Interpolationinterpolationinterpolation is set to 'nearest_neighbor'"nearest_neighbor", and if both the input and output image is large. In all cases, it is recommended to set 'int_zooming'"int_zooming" to 'false'"false" via the operator set_systemSetSystem.

If 'nearest_neighbor'"nearest_neighbor" is set as interpolation method the results can differ slightly for different image types. This is due to the usage of image type specific optimizations of the applied interpolation algorithm.

zoom_image_sizeZoomImageSize is not parallelized internally if Widthwidthwidth and Heightheightheight correspond to half the dimensions of Imageimageimage. Further zoom_image_sizeZoomImageSize is not parallelized internally with Interpolationinterpolationinterpolation='nearest_neighbor'"nearest_neighbor".

zoom_image_sizeZoomImageSize 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🔗

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🔗

Imageimageimage (input_object) (multichannel-)image(-array) → object (byte* / int2* / uint2* / real*)HObject (byte* / int2* / uint2* / real*)HImage (byte* / int2* / uint2* / real*)HObject (byte* / int2* / uint2* / real*)Hobject (byte* / int2* / uint2* / real*) *allowed for compute devices

Input image.

ImageZoomimageZoomimage_zoom (output_object) (multichannel-)image(-array) → object (byte / int2 / uint2 / real)HObject (byte / int2 / uint2 / real)HImage (byte / int2 / uint2 / real)HObject (byte / int2 / uint2 / real)Hobject * (byte / int2 / uint2 / real)

Scaled image.

Widthwidthwidth (input_control) extent.x → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Width of the resulting image.

Default: 512512
Suggested values: 128, 256, 512128, 256, 512
Value range: 2 ≤ Width ≤ 512
Minimum increment: 1
Recommended increment: 10

Heightheightheight (input_control) extent.y → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Height of the resulting image.

Default: 512512
Suggested values: 128, 256, 512128, 256, 512
Value range: 2 ≤ Height ≤ 512
Minimum increment: 1
Recommended increment: 10

Interpolationinterpolationinterpolation (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Type of interpolation.

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

Example🔗

(HDevelop)


read_image(Image,'monkey')
dev_display (Image)
zoom_image_size(Image,ZoomImage,200,200,'constant')
dev_display (ZoomImage)
(C)
read_image(&Image,"monkey")\;
disp_image(Image,WindowHandle)\;
zoom_image_size(Image,&ZoomImage,200,200,"constant")\;
disp_image(ZoomImage,WindowHandle)\;

Combinations with other operators🔗

Combinations

Alternatives

zoom_image_factorZoomImageFactor, affine_trans_imageAffineTransImage, hom_mat2d_scaleHomMat2dScale

See also

hom_mat2d_scaleHomMat2dScale, affine_trans_imageAffineTransImage

Module🔗

Foundation