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

ShrinkImageNTimes

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Shrinks an image by a natural factor along each axis.

Syntax

void fil::ShrinkImageNTimes
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Box&> inRoi,
	int inNX,
	const ftl::Optional<int>& inNY,
	fil::Image& outImage
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inRoi	Optional<const Box&>		NIL	Range of pixels to be processed
inNX	int	1 -	2
inNY	const Optional<int>&	1 -	NIL
outImage	Image&			Output image

Description

The operation shrinks the inImage reducing its dimensions by a natural factor.

Examples

ShrinkImageNTimes performed on the sample image with inNX = 2, inNY = 2.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

This operation is optimized for SSE2 technology for pixels of types: UINT8, SINT8, UINT16, SINT16, SINT32, REAL.

This operation is optimized for AVX2 technology for pixels of types: UINT8, SINT8, UINT16, SINT16, SINT32, REAL.

This operation is optimized for NEON technology for pixels of types: UINT8, SINT8, UINT16, SINT16, SINT32, REAL.

Errors

List of possible exceptions:

Error type	Description
DomainError	ROI is out of inImage range in ShrinkImageNTimes.