Back to Aurora Vision Library Lite website

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

ShrinkImageNTimes


Header: AVL.h
Namespace: avl

Shrinks an image by a natural factor along each axis.

Syntax

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

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inRoi Optional<const Box&> NIL Range of pixels to be processed
Input value inNX int 1 - 2
Input value inNY const Optional<int>& 1 - NIL
Output value 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.

See Also

  • ResizeImage – Enlarges or shrinks an image to new dimensions.