You are here: Start » Function Reference » Image Spatial Transforms » JoinImages_OfSeries

JoinImages_OfSeries

Creates a single image by glueing together a series of input images in horizontal or vertical direction.

Header:	AVL.h

Syntax

void avl::JoinImages_OfSeries
(
	JoinImages_OfSeriesState& ioState,
	const avl::Image& inImage,
	avl::JoinDirection::Type inDirection,
	const int inSeriesSize,
	atl::Conditional<avl::Image>& outImage
)

void JoinImages_OfSeries
(
	ref JoinImages_OfSeriesState ioState,
	Image inImage,
	JoinDirection inDirection,
	int inSeriesSize,
	out Image? outImage
)

Parameters

Name	Type	Range	Description
ioState	JoinImages_OfSeriesState&		Object used to maintain state of the function.
inImage	const Image&		Input image
inDirection	JoinDirection::Type		Direction in which images are joined
inSeriesSize	const int	1 -	Number of images which are joined
outImage	Conditional<Image>&		Output image

Errors

Error type	Description
DomainError	Input images do not have the same pixel format in JoinImages_OfSeries.
DomainError	Input images do not have compatible dimensions in JoinImages_OfSeries.