Operator Reference

compose2compose2Compose2Compose2compose2 (Operator)

compose2compose2Compose2Compose2compose2 — Convert two images into a two-channel image.

Signature

compose2(Image1, Image2 : MultiChannelImage : : )

Herror compose2(const Hobject Image1, const Hobject Image2, Hobject* MultiChannelImage)

Herror T_compose2(const Hobject Image1, const Hobject Image2, Hobject* MultiChannelImage)

void Compose2(const HObject& Image1, const HObject& Image2, HObject* MultiChannelImage)

HImage HImage::Compose2(const HImage& Image2) const

def compose2(image_1: HObject, image_2: HObject) -> HObject

Description

The operator compose2compose2Compose2Compose2compose2 converts 2 one-channel images into a 2-channel image. The definition domain is calculated as the intersection of the definition domains of the input images. 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).
  • Automatically parallelized on tuple level.

Parameters

Image1Image1Image1image1image_1 (input_object)  singlechannelimage(-array) objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Input image 1.

Image2Image2Image2image2image_2 (input_object)  singlechannelimage(-array) objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Input image 2.

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

Multi-channel image.

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image

Alternatives

append_channelappend_channelAppendChannelAppendChannelappend_channel

See also

decompose2decompose2Decompose2Decompose2decompose2

Module

Foundation