tile_imagestile_imagesTileImagesTileImagestile_images (Operator)

Name

tile_imagestile_imagesTileImagesTileImagestile_images — Tile multiple image objects into a large image.

Signature

tile_images(Images : TiledImage : NumColumns, TileOrder : )

Description

tile_imagestile_imagesTileImagesTileImagesTileImagestile_images tiles multiple input image objects, which must contain the same number of channels, into a large image. The input image object ImagesImagesImagesImagesimagesimages contains Num images, which may be of different size. The output image TiledImageTiledImageTiledImageTiledImagetiledImagetiled_image contains as many channels as the input images. In the output image the Num input images have been tiled into NumColumnsNumColumnsNumColumnsNumColumnsnumColumnsnum_columns columns. Each tile has the same size, which is determined by the maximum width and height of all input images. If an input image is smaller than the tile size it is copied to the center of the respective tile. The parameter TileOrderTileOrderTileOrderTileOrdertileOrdertile_order determines the order in which the images are copied into the output in the cases in which this is not already determined by NumColumnsNumColumnsNumColumnsNumColumnsnumColumnsnum_columns (i.e., if NumColumnsNumColumnsNumColumnsNumColumnsnumColumnsnum_columns != 1 and NumColumnsNumColumnsNumColumnsNumColumnsnumColumnsnum_columns != Num). If TileOrderTileOrderTileOrderTileOrdertileOrdertile_order = 'horizontal'"horizontal""horizontal""horizontal""horizontal""horizontal" the images are copied in the horizontal direction, i.e., the second image of ImagesImagesImagesImagesimagesimages will be to the right of the first image. If TileOrderTileOrderTileOrderTileOrdertileOrdertile_order = 'vertical'"vertical""vertical""vertical""vertical""vertical" the images are copied in the vertical direction, i.e., the second image of ImagesImagesImagesImagesimagesimages will be below the first image. The domain of TiledImageTiledImageTiledImageTiledImagetiledImagetiled_image is obtained by copying the domains of ImagesImagesImagesImagesimagesimages to the corresponding locations in the output image. If Num is not a multiple of NumColumnsNumColumnsNumColumnsNumColumnsnumColumnsnum_columns the output image will have undefined gray values in the lower right corner of the image. The output domain will reflect this.

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

ImagesImagesImagesImagesimagesimages (input_object) (multichannel-)image-array → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real)

Input images.

TiledImageTiledImageTiledImageTiledImagetiledImagetiled_image (output_object) (multichannel-)image → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real)

Tiled output image.

NumColumnsNumColumnsNumColumnsNumColumnsnumColumnsnum_columns (input_control) integer → (integer)

Number of columns to use for the output image.

Default value: 1

Suggested values: 1, 2, 3, 4, 5, 6, 7

Restriction: NumColumns >= 1

TileOrderTileOrderTileOrderTileOrdertileOrdertile_order (input_control) string → (string)

Order of the input images in the output image.

Default value: 'vertical' "vertical" "vertical" "vertical" "vertical" "vertical"

List of values: 'horizontal'"horizontal""horizontal""horizontal""horizontal""horizontal", 'vertical'"vertical""vertical""vertical""vertical""vertical"

Example (HDevelop)

* Grab 5 (multi-channel) images and stack them vertically.
gen_empty_obj (Images)
for I := 1 to 5 by 1
    grab_image_async (ImageGrabbed, AcqHandle, -1)
    concat_obj (Images, ImageGrabbed, Images)
endfor
tile_images (Images, TiledImage, 1, 'vertical')