get_channel_infoget_channel_infoGetChannelInfoGetChannelInfo (Operator)


get_channel_infoget_channel_infoGetChannelInfoGetChannelInfo — Informations about the components of an image object.


get_channel_info(Object : : Request, Channel : Information)

Herror get_channel_info(const Hobject Object, const char* Request, const Hlong Channel, char* Information)

Herror T_get_channel_info(const Hobject Object, const Htuple Request, const Htuple Channel, Htuple* Information)

void GetChannelInfo(const HObject& Object, const HTuple& Request, const HTuple& Channel, HTuple* Information)

HTuple HObject::GetChannelInfo(const HString& Request, const HTuple& Channel) const

HString HObject::GetChannelInfo(const HString& Request, Hlong Channel) const

HString HObject::GetChannelInfo(const char* Request, Hlong Channel) const

HString HObject::GetChannelInfo(const wchar_t* Request, Hlong Channel) const   (Windows only)

static void HOperatorSet.GetChannelInfo(HObject objectVal, HTuple request, HTuple channel, out HTuple information)

HTuple HObject.GetChannelInfo(string request, HTuple channel)

string HObject.GetChannelInfo(string request, int channel)


The operator get_channel_infoget_channel_infoGetChannelInfoGetChannelInfoGetChannelInfo gives information about the components of an image object. The following requests (RequestRequestRequestRequestrequest) are currently possible:


Output of the names of the procedures which initially created the image components (not the object).


Output of the type of image component ('byte', 'int1', 'int2', 'uint2' 'int4', 'real', 'direction', 'cyclic', 'complex', 'vector_field'). The component 0 is of type 'region' or 'xld'.

In the tuple ChannelChannelChannelChannelchannel the numbers of the components about which information is required are stated. After carrying out get_channel_infoget_channel_infoGetChannelInfoGetChannelInfoGetChannelInfo, InformationInformationInformationInformationinformation contains a tuple of strings (one string per entry in ChannelChannelChannelChannelchannel) with the required information.

For a short description of the iconic objects that are available in HALCON see the introduction of chapter Object.

Execution Information


ObjectObjectObjectObjectobjectVal (input_object)  object objectHObjectHObjectHobject

Image object to be examined.

RequestRequestRequestRequestrequest (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Required information about object components.

Default value: 'creator' "creator" "creator" "creator" "creator"

List of values: 'creator'"creator""creator""creator""creator", 'type'"type""type""type""type"

ChannelChannelChannelChannelchannel (input_control)  channel(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Components to be examined (0 for region/XLD).

Default value: 0

Suggested values: 0, 1, 2, 3, 4, 5, 6, 7, 8

InformationInformationInformationInformationinformation (output_control)  string(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Requested information.


If the parameters are correct the operator get_channel_infoget_channel_infoGetChannelInfoGetChannelInfoGetChannelInfo returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors


See also