Skip to content

get_channel_infoGetChannelInfoGetChannelInfoget_channel_infoget_channel_info🔗

Short description🔗

get_channel_infoGetChannelInfoGetChannelInfoget_channel_infoget_channel_info — Information about the components of an image object.

Signature🔗

get_channel_info( object Object, string Request, channel Channel, out string Information )void GetChannelInfo( const HObject& Object, const HTuple& Request, const HTuple& Channel, HTuple* Information )static void HOperatorSet.GetChannelInfo( HObject objectVal, HTuple request, HTuple channel, out HTuple information )def get_channel_info( object: HObject, request: str, channel: MaybeSequence[int] ) -> Sequence[str]

def get_channel_info_s( object: HObject, request: str, channel: MaybeSequence[int] ) -> strHerror 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 )

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)

HTuple HObject.GetChannelInfo( string request, HTuple channel )

string HObject.GetChannelInfo( string request, int channel )

Description🔗

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

  • 'creator'"creator" Output of the names of the procedures which initially created the image components (not the object).

  • 'type'"type" 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 Channelchannelchannel the numbers of the components about which information is required are stated. After carrying out get_channel_infoGetChannelInfo, Informationinformationinformation contains a tuple of strings (one string per entry in Channelchannelchannel) 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🔗

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🔗

ObjectobjectValobject (input_object) object → objectHObjectHObjectHObjectHobject

Image object to be examined.

Requestrequestrequest (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Required information about object components.

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

Channelchannelchannel (input_control) channel(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

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

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

Informationinformationinformation (output_control) string(-array) → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Requested information.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

read_imageReadImage

See also

count_relationCountRelation

Module🔗

Foundation