You are here: Start » Function Reference » Image Spatial Transforms Maps » ConvertMatrixMapsToSpatialMap
ConvertMatrixMapsToSpatialMap
Joins two matrices of coordinates to produce a SpatialMap for use in RemapImage.
Header: | AVL.h |
---|
Syntax
void avl::ConvertMatrixMapsToSpatialMap ( const avl::ImageFormat& inImageFormat, const avl::Matrix& inMatrixX, const avl::Matrix& inMatrixY, avl::InterpolationMethod::Type inInterpolationMethod, bool inRoundingOpenCV, avl::SpatialMap& outSpatialMap, atl::Optional<avl::Region&> outOutputRegion = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inImageFormat | const ImageFormat& | Information about dimensions, depth and pixel type of the image | ||
inMatrixX | const Matrix& | Map of real X coordinates | ||
inMatrixY | const Matrix& | Map of real Y coordinates | ||
inInterpolationMethod | InterpolationMethod::Type | Bilinear | ||
inRoundingOpenCV | bool | Use same interpolation convention as cvRemap | ||
outSpatialMap | SpatialMap& | Output spatial map | ||
outOutputRegion | Optional<Region&> | NIL | Pixels set by the spatial map application |
Remarks
The two source matrices contain real-valued coordinates - if inMatrixX[a, b] = x and inMatrixY[a, b] = y, then the RemapImage filter applied with this map will generate the outImage[a, b] pixel based on pixels around (x, y) in inImage.
One example of application of this filter is the conversion of matrix maps generated with the OpenCV filter OpenCV InitUndistortRectifyMap function.
The inRoundingOpenCV parameter should be set to true if the matrices passed to this filter were obtained from an OpenCV function, like OpenCV InitUndistortRectifyMap function. This ensures that the results of RemapImage will be identical to OpenCV Remap function used with the same interpolation.
Errors
Error type | Description |
---|---|
DomainError | Input matrices must have equal sizes in ConvertMatrixMapsToSpatialMap. |
DomainError | Format of an empty image on input in ConvertMatrixMapsToSpatialMap. |
See Also
- ConvertSpatialMapToMatrixMaps – Splits a spatial map into two matrices of source coordinates.
- RemapImage – Applies a precomputed image transform, defined by a spatial map object.