get_image_typeget_image_typeGetImageTypeGetImageTypeget_image_type (Operator)

Name

get_image_typeget_image_typeGetImageTypeGetImageTypeget_image_type — Return the type of an image.

Signature

get_image_type(Image : : : Type)

Herror get_image_type(const Hobject Image, char* Type)

Herror T_get_image_type(const Hobject Image, Htuple* Type)

void GetImageType(const HObject& Image, HTuple* Type)

HTuple HImage::GetImageType() const

static void HOperatorSet.GetImageType(HObject image, out HTuple type)

HTuple HImage.GetImageType()

def get_image_type(image: HObject) -> Sequence[str]

def get_image_type_s(image: HObject) -> str

Description

The operator get_image_typeget_image_typeGetImageTypeGetImageTypeGetImageTypeget_image_type returns the image type (TypeTypeTypeTypetypetype = 'byte', 'int2', 'uint2', etc.).

Attention

For multi-channel input images the type of the first channel is returned.

Execution Information

Parameters

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

Input image.

TypeTypeTypeTypetypetype (output_control)  string(-array) HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Type of image.

List of values: 'byte'"byte""byte""byte""byte""byte", 'complex'"complex""complex""complex""complex""complex", 'cyclic'"cyclic""cyclic""cyclic""cyclic""cyclic", 'direction'"direction""direction""direction""direction""direction", 'int1'"int1""int1""int1""int1""int1", 'int2'"int2""int2""int2""int2""int2", 'int4'"int4""int4""int4""int4""int4", 'int8'"int8""int8""int8""int8""int8", 'real'"real""real""real""real""real", 'uint2'"uint2""uint2""uint2""uint2""uint2", 'vector_field_absolute'"vector_field_absolute""vector_field_absolute""vector_field_absolute""vector_field_absolute""vector_field_absolute", 'vector_field_relative'"vector_field_relative""vector_field_relative""vector_field_relative""vector_field_relative""vector_field_relative"

Result

The operator get_image_typeget_image_typeGetImageTypeGetImageTypeGetImageTypeget_image_type 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>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>). If necessary an exception is raised.

Possible Predecessors

read_imageread_imageReadImageReadImageReadImageread_image

Alternatives

get_image_pointer1get_image_pointer1GetImagePointer1GetImagePointer1GetImagePointer1get_image_pointer1

See also

get_image_sizeget_image_sizeGetImageSizeGetImageSizeGetImageSizeget_image_size

Module

Foundation