You are here: Start » Function Reference » Image Point Transforms » FisFilter_LogarithmImage

FisFilter_LogarithmImage

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

Computes a natural logarithm of each pixel.

Syntax

void fis::FisFilter_LogarithmImage
(
	FisFilters_ImagePointTransformsState& ioState,
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<const float&> inScale,
	float inOffset,
	bool inNormalizeZero,
	fil::Image& outImage,
	fil::Profile& diagLutProfile
)

Parameters

	Name	Type	Range	Default	Description
	ioState	FisFilters_ImagePointTransformsState&			Object used to maintain state of the function.
	inImage	const Image&			Input image
	inRoi	Optional<const Region&>		NIL	Region of interest
	inScale	Optional<const float&>		NIL	Scaling factor (default: 255)
	inOffset	float	1.0 -	1.0f	Offset factor
	inNormalizeZero	bool			Specifies whether the output range should be rescaled to start from 0
	outImage	Image&			Output image
	diagLutProfile	Profile&			Profile depicting the resulting look-up table of the logarithm transform

Requirements

In-place Processing

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

Read more about In-place Computation.

Hardware Acceleration

Errors