You are here: Start » Function Reference » All Functions » Image Point Transforms » FisFilter_PowerImage

FisFilter_PowerImage

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code. CreatePowerLut and ApplyPixelLut should be used instead.

Header:	FIL.h
Namespace:	fis
Module:	FoundationLite

Exponentiates each pixel to the given power.

Syntax

void fis::FisFilter_PowerImage
(
	FisFilters_ImagePointTransformsState& ioState,
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	float inValue,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
ioState	FisFilters_ImagePointTransformsState&		Object used to maintain state of the function.
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of pixels to be processed
inValue	float	2.0f	The exponent
outImage	Image&		Output image

In-place Processing

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

Remarks

When diagnostic mode is used, this filter will check correctness of input data and throw an exception if possibility of NaN value in output image occur. When working in optimized mode, this check is omitted.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type	Description
DomainError	Region exceeds an input image in PowerImage.