HALCON Operator reference

HALCON Operator Reference / Image / Channel
ClassesClasses | | Operators

access_channelaccess_channelAccessChannelAccessChannelaccess_channel (Operator)

access_channelaccess_channelAccessChannelAccessChannelaccess_channel — Access a channel of a multi-channel image.

Signature

access_channel(MultiChannelImage : Image : Channel : )

Herror access_channel(const Hobject MultiChannelImage, Hobject* Image, const Hlong Channel)

Herror T_access_channel(const Hobject MultiChannelImage, Hobject* Image, const Htuple Channel)

void AccessChannel(const HObject& MultiChannelImage, HObject* Image, const HTuple& Channel)

HImage HImage::AccessChannel(const HTuple& Channel) const

HImage HImage::AccessChannel(Hlong Channel) const

static void HOperatorSet.AccessChannel(HObject multiChannelImage, out HObject image, HTuple channel)

HImage HImage.AccessChannel(HTuple channel)

HImage HImage.AccessChannel(int channel)

def access_channel(multi_channel_image: HObject, channel: MaybeSequence[int]) -> HObject

Description

The operator access_channelaccess_channelAccessChannelAccessChannelaccess_channel accesses one or more channels of the (multi-channel) input image MultiChannelImageMultiChannelImageMultiChannelImagemultiChannelImagemulti_channel_image. The result ImageImageImageimageimage contains as many channels as specified in ChannelChannelChannelchannelchannel. The definition domain of the input is adopted.

Note that the channels are numbered from 1 to n. The number of channels can be determined via the operator count_channelscount_channelsCountChannelsCountChannelscount_channels.

If an empty tuple is passed in ChannelChannelChannelchannelchannel, an object that consists only of the domain of the input is returned.

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

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

Multi-channel image.

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

Selected channels of MultiChannelImage.

ChannelChannelChannelchannelchannel (input_control)  channel(-array) → HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Indices of the channels to be accessed.

Default: 1

Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

Value range: 1 ≤ Channel Channel Channel channel channel

Example (C)

read_image(&Color,"patras");   /* read color image */
access_channel(Color,&Red,1);  /* extract red channel */
disp_image(Red,WindowHandle);

Possible Predecessors

count_channelscount_channelsCountChannelsCountChannelscount_channels

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image

Alternatives

decompose2decompose2Decompose2Decompose2decompose2, decompose3decompose3Decompose3Decompose3decompose3, decompose4decompose4Decompose4Decompose4decompose4, decompose5decompose5Decompose5Decompose5decompose5

See also

count_channelscount_channelsCountChannelsCountChannelscount_channels

Module

Foundation

ClassesClasses | | Operators