Operator Reference

get_image_sizeget_image_sizeGetImageSizeGetImageSizeget_image_size (Operator)

get_image_sizeget_image_sizeGetImageSizeGetImageSizeget_image_size — Return the size of an image.

Signature

get_image_size(Image : : : Width, Height)

Herror get_image_size(const Hobject Image, Hlong* Width, Hlong* Height)

Herror T_get_image_size(const Hobject Image, Htuple* Width, Htuple* Height)

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

void HImage::GetImageSize(HTuple* Width, HTuple* Height) const

void HImage::GetImageSize(Hlong* Width, Hlong* Height) const

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

void HImage.GetImageSize(out HTuple width, out HTuple height)

void HImage.GetImageSize(out int width, out int height)

def get_image_size(image: HObject) -> Tuple[Sequence[int], Sequence[int]]

def get_image_size_s(image: HObject) -> Tuple[int, int]

Description

The operator get_image_sizeget_image_sizeGetImageSizeGetImageSizeget_image_size returns the image size (width and height) of the input image.

Execution Information

  • Supports objects on compute devices.
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

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

Input image.

WidthWidthWidthwidthwidth (output_control)  extent.x(-array) HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Width of image.

HeightHeightHeightheightheight (output_control)  extent.y(-array) HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Height of image.

Result

The operator get_image_sizeget_image_sizeGetImageSizeGetImageSizeget_image_size returns the value 2 ( H_MSG_TRUE) . The behavior in case of empty input (no input images available) is set via the operator set_system('no_object_result',<Result>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>). If necessary an exception is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageread_image

Alternatives

get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1get_image_pointer1

See also

get_image_typeget_image_typeGetImageTypeGetImageTypeget_image_type

Module

Foundation