Back to FabImage Library website

You are here: Start » Function Reference » Image » Image Spatial Transforms Maps » RemapImage


Header: FIL.h
Namespace: fil
Module: Calibration

Applies a precomputed image transform, defined by a spatial map object.

Applications: Fast (precomputed) image transformations, especially for view undistortion or object geometry correction (e.g. pos recognition of labels on cylindrical bottles).


void fil::RemapImage
	const fil::Image& inImage,
	const fil::SpatialMap& inSpatialMap,
	ftl::Optional<const fil::Region&> inMapRoi,
	fil::Image& outImage


Name Type Default Description
Input value inImage const Image& Input image
Input value inSpatialMap const SpatialMap& Definition of the transformation
Input value inMapRoi Optional<const Region&> NIL Defines which elements of the spatial map are valid
Output value outImage Image& Output image


The operation applies an arbitrary spatial transformation to an image using a SpatialMap object. The input image has to be compatible with the given map. You can check if a map is compatible with an image using TestSpatialMapApplicability.


  • Connect the inSpatialMap input with a spatial map. This can be for example the result of the CreateSphereMap function or similar.


Read more about how to handle images from camera in Camera Calibration article.

Hardware Acceleration

This operation is optimized for SSE4 technology for pixels of types: 1xUINT8, 3xUINT8.

This operation is optimized for AVX2 technology for pixels of type: 3xUINT8.

This operation is optimized for NEON technology for pixels of types: 1xUINT8, 3xUINT8.

This operation supports automatic parallelization for multicore and multiprocessor systems.


List of possible exceptions:

Error type Description
DomainError Incorrect SpatialMap on input in RemapImage.

See Also