Operator Reference

change_formatchange_formatChangeFormatChangeFormatchange_format (Operator)

change_formatchange_formatChangeFormatChangeFormatchange_format — Change image size.

Signature

change_format(Image : ImagePart : Width, Height : )

Herror change_format(const Hobject Image, Hobject* ImagePart, const Hlong Width, const Hlong Height)

Herror T_change_format(const Hobject Image, Hobject* ImagePart, const Htuple Width, const Htuple Height)

void ChangeFormat(const HObject& Image, HObject* ImagePart, const HTuple& Width, const HTuple& Height)

HImage HImage::ChangeFormat(Hlong Width, Hlong Height) const

static void HOperatorSet.ChangeFormat(HObject image, out HObject imagePart, HTuple width, HTuple height)

HImage HImage.ChangeFormat(int width, int height)

def change_format(image: HObject, width: int, height: int) -> HObject

Description

The operator change_formatchange_formatChangeFormatChangeFormatchange_format increases or decreases the size of the input images to the indicated height or width, respectively. If the image is reduced, parts are cut off at the “right” or “lower” edge of the image, respectively. If the image is enlarged, the additional areas are set to 0. The definition domain of the new image is equal to the domain of the input image, clipped to the size of the new image. No zooming is carried out.

Execution Information

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

Parameters

ImageImageImageimageimage (input_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Input image.

ImagePartImagePartImagePartimagePartimage_part (output_object)  (multichannel-)image(-array) objectHImageHObjectHObjectHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Image with new format.

WidthWidthWidthwidthwidth (input_control)  extent.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of new image.

Default: 512

Suggested values: 32, 64, 128, 256, 512, 768, 1024

HeightHeightHeightheightheight (input_control)  extent.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of new image.

Default: 512

Suggested values: 32, 64, 128, 256, 512, 525, 1024

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image

Alternatives

crop_partcrop_partCropPartCropPartcrop_part

See also

zoom_image_sizezoom_image_sizeZoomImageSizeZoomImageSizezoom_image_size, zoom_image_factorzoom_image_factorZoomImageFactorZoomImageFactorzoom_image_factor

Module

Foundation