Operator Reference

append_channelappend_channelAppendChannelAppendChannelappend_channel (Operator)

append_channelappend_channelAppendChannelAppendChannelappend_channel — Append additional matrices (channels) to the image.

Signature

append_channel(MultiChannelImage, Image : ImageExtended : : )

Herror append_channel(const Hobject MultiChannelImage, const Hobject Image, Hobject* ImageExtended)

Herror T_append_channel(const Hobject MultiChannelImage, const Hobject Image, Hobject* ImageExtended)

void AppendChannel(const HObject& MultiChannelImage, const HObject& Image, HObject* ImageExtended)

HImage HImage::AppendChannel(const HImage& Image) const

static void HOperatorSet.AppendChannel(HObject multiChannelImage, HObject image, out HObject imageExtended)

HImage HImage.AppendChannel(HImage image)

def append_channel(multi_channel_image: HObject, image: HObject) -> HObject

Description

The operator append_channelappend_channelAppendChannelAppendChannelappend_channel appends the matrices of the image ImageImageImageimageimage to the matrices of MultiChannelImageMultiChannelImageMultiChannelImagemultiChannelImagemulti_channel_image. The result is an image containing as many matrices (channels) as MultiChannelImageMultiChannelImageMultiChannelImagemultiChannelImagemulti_channel_image and ImageImageImageimageimage combined. The definition domain of the output image is calculated as the intersection of the definition domains of both input images. MultiChannelImageMultiChannelImageMultiChannelImagemultiChannelImagemulti_channel_image may be a region only that is then interpreted as the definition domain of an image without channels. No new storage is allocated for the multi-channel image. Instead, the created multi-channel image contains references to the existing input images.

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 objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Multi-channel image.

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

Image to be appended.

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

Image appended by ImageImageImageimageimage.

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image

Alternatives

compose2compose2Compose2Compose2compose2, compose3compose3Compose3Compose3compose3, compose4compose4Compose4Compose4compose4, compose5compose5Compose5Compose5compose5

Module

Foundation