Skip to content

get_image_sizeGetImageSizeGetImageSizeget_image_sizeget_image_size🔗

Short description🔗

get_image_sizeGetImageSizeGetImageSizeget_image_sizeget_image_size — Return the size of an image.

Signature🔗

get_image_size( image Image, out extent.x Width, out extent.y Height )void GetImageSize( const HObject& Image, HTuple* Width, HTuple* Height )static void HOperatorSet.GetImageSize( HObject image, out HTuple width, out HTuple height )def get_image_size( image: HObject ) -> Tuple[Sequence[int], Sequence[int]]

def get_image_size_s( image: HObject ) -> Tuple[int, int]Herror get_image_size( const Hobject Image, Hlong* Width, Hlong* Height )

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

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

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

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

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

Description🔗

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

Execution information🔗

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🔗

Imageimageimage (input_object) (multichannel-)image(-array) → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HImage (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)Hobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Input image.

Widthwidthwidth (output_control) extent.x(-array) → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Width of image.

Heightheightheight (output_control) extent.y(-array) → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Height of image.

Result🔗

The operator get_image_sizeGetImageSize 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>). If necessary an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

read_imageReadImage

Alternatives

get_image_pointer1GetImagePointer1

See also

get_image_typeGetImageType

Module🔗

Foundation