Back to Aurora Vision Library website

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


Header: AVL.h
Namespace: avl
Module: FoundationLite

Moves the pixels of the input image by the vectors specified with inVectorImage.


void avl::TranslatePixels
	const avl::Image& inImage,
	const avl::Image& inVectorImage,
	atl::Optional<const avl::Region&> inRoi,
	avl::InterpolationMethod::Type inImageInterpolation,
	avl::Image& outImage


Name Type Default Description
Input value
inImage const Image& Input image
Input value
inVectorImage const Image& Two-channel image specifying translation vector for each pixel
Input value
inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value
inImageInterpolation InterpolationMethod::Type
Output value
outImage Image& Output image


For input inVectorImage only pixel formats are supported: 2⨯real.

Read more about pixel formats in Image documentation.


List of possible exceptions:

Error type Description
DomainError Image size are not equal in TranslatePixels.
DomainError Incorrect vector image format in TranslatePixels.
DomainError Region exceeds an input image in TranslatePixels.
DomainError Unknown interpolation method in TranslatePixels.
DomainError Not supported inVectorImage pixel format in TranslatePixels. Supported formats: 2xReal.