Back to Adaptive Vision Library website

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

TranslatePixels


Header: AVL.h
Namespace: avl
Module: FoundationLite

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

Syntax

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

Parameters

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

Requirements

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

Read more about pixel formats in Image documentation.

Errors

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.