interleave_channelsInterleaveChannelsInterleaveChannelsinterleave_channelsinterleave_channels🔗

Short description🔗

interleave_channelsInterleaveChannelsInterleaveChannelsinterleave_channelsinterleave_channels — Create an interleaved image from a multichannel image.

Signature🔗

interleave_channels( image MultichannelImage, out image InterleavedImage, string PixelFormat, integer RowBytes, integer Alpha )

Description🔗

The operator interleave_channelsInterleaveChannels creates an InterleavedImageinterleavedImageinterleaved_image from the input MultichannelImagemultichannelImagemultichannel_image containing three or four channels. This is useful to prepare a color image for visualization, e.g., by converting it to a .NET Bitmap.

Pixel format🔗

The format of the pixels in InterleavedImageinterleavedImageinterleaved_image is specified with PixelFormatpixelFormatpixel_format. Possible formats are 'rgb'"rgb", 'rgba'"rgba", 'argb'"argb", 'bgr'"bgr", 'bgra'"bgra", and 'abgr'"abgr" for byte images and 'rgb48'"rgb48", 'bgr48'"bgr48", 'rgba64'"rgba64", 'bgra64'"bgra64", 'argb64'"argb64" and 'abgr64'"abgr64" for uint2 images, where ‘a’ denotes the 4th (‘alpha’) channel. Be aware that, in contrast to gen_image_interleavedGenImageInterleaved, LittleEndian byte ordering is used in PixelFormatpixelFormatpixel_format.

Alpha channel🔗

The alpha channel can be defined in the following ways:

channels	domain
3	not specified/full	Value of `Alphaalphaalpha` is set for the complete image.
3	reduced	Inside the domain: alpha is set to `Alphaalphaalpha`. Outside the domain: alpha is set to zero.
4		Alpha is set to the respective value of the fourth channel, domain and `Alphaalphaalpha` are ignored.

Row alignment🔗

The number of bytes between the beginning of two rows in the output image can be set in RowBytesrowBytesrow_bytes, e.g., to fulfill specific alignment criteria. Set RowBytesrowBytesrow_bytes to 'match'"match" if no additional padding is required. RowBytesrowBytesrow_bytes must be at least the number of bytes in PixelFormatpixelFormatpixel_format times the width of MultichannelImagemultichannelImagemultichannel_image.

Execution information🔗

Execution information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Automatically parallelized on internal data level.

Parameters🔗

MultichannelImagemultichannelImagemultichannel_image (input_object) multichannel-image → object (byte)HObject (byte)HImage (byte)HObject (byte)Hobject (byte)

Input multichannel image.

InterleavedImageinterleavedImageinterleaved_image (output_object) singlechannelimage → object (byte)HObject (byte)HImage (byte)HObject (byte)Hobject * (byte)

Output interleaved image.

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

Target format for InterleavedImage.

Default: 'rgba'"rgba"
List of values: 'abgr', 'abgr64', 'argb', 'argb64', 'bgr', 'bgr48', 'bgra', 'bgra64', 'rgb', 'rgb48', 'rgba', 'rgba64'

RowBytesrowBytesrow_bytes (input_control) integer → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)Union[str, int]Htuple (char* / Hlong)

Number of bytes in a row of the output image.

Default: 'match'"match"
Suggested values: 'match'"match"

Alphaalphaalpha (input_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Alpha value for three channel input images.

Default: 255255
Suggested values: 255, 0255, 0

Example🔗

(c#)

  HTuple type, width, height\;
  HImage patras = new HImage("patras")\;
 HImage interleaved = patras.InterleaveChannels("argb", "match", 255)\;
  IntPtr ptr = interleaved.GetImagePointer1(out type, out width, out height)\;
 Image img = new Bitmap(width/4, height, width,
                         PixelFormat.Format32bppArgb, ptr)\;
 pictureBox.Image = img\;

Combinations with other operators🔗

Combinations

Module🔗

Foundation