Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Combinators » LerpImages_ByImage

LerpImages_ByImage


Header: FIL.h
Namespace: fil
Module: FoundationLite

Interpolates two images linearly pixel by pixel according to another image values.

Syntax

C++
C#
 
void fil::LerpImages_ByImage
(
	const fil::Image& inImage1,
	const fil::Image& inImage2,
	ftl::Optional<const fil::Region&> inRoi,
	const fil::Image& inLambdaImage,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage1 const Image& First input image
Input value inImage2 const Image& Second input image
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value inLambdaImage const Image& Values of interpolation between the input images where 0.0 value is equal to inImage1 and 1.0 to inImage2
Output value outImage Image& Output image

Requirements

For input inLambdaImage only pixel formats are supported: 1⨯real.

Read more about pixel formats in Image documentation.

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage1 and outImage, inImage2 and outImage

Read more about In-place Computation.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type Description
DomainError Image formats are not the same in LerpImages_ByImage.
DomainError Image sizes are not equal in LerpImages_ByImage.
DomainError Region exceeds an input image in LerpImages_ByImage.
DomainError Not supported inLambdaImage pixel format in LerpImages_ByImage. Supported formats: 1xReal.