MimWarp

See also

User Guide:

Basic geometric transforms Camera calibration propagation Physically correcting an image Propagating camera calibration information after performing a geometric operation Retrieving and analyzing results Warping

Reference:

MbufAlloc2d MbufInquire MgenWarpParameter

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Partially supported on:

Partially supported on Matrox Radient eCL (j)

Partially supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Partially supported on Matrox Solios eA/XA (l)

Partially supported on Matrox Solios ecl/xcl/ev-cl (m)

Partially supported on Matrox RadientPro-CL (Update 7) (p)

Partially supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Partially supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Partially supported on Matrox Rapixo CL Pro (Update 96) (aa)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

findimageorientation.cpp
mimwarp.cpp
mimwarp.cs
mimwarp.vb
mimwarpquadrilateral.cpp
mpwarpprocessing.cpp
multiviewannotations.cpp
polarizationimaging.cpp
variouscodereadings.cpp

Function Map

Table:	For specifying the mode of operation
+ combination:	For M_WARP_LUT

- InterpolationMode

Table:	For specifying the interpolation mode
+ combination:	For overscan

Compilation information

Synopsis

Perform a warping.

Syntax

void MimWarp(

MIL_ID SrcImageBufId,	//in
MIL_ID DstImageBufId,	//in
MIL_ID WarpParam1BufId,	//in
MIL_ID WarpParam2BufId,	//in
MIL_INT64 OperationMode,	//in
MIL_INT64 InterpolationMode	//in

)

Description

This function warps an image through either a 3x3 matrix-defined warping or LUTs. You can perform first-order polynomial warpings or perspective polynomial warpings using either a 3x3 coefficients matrix or lookup tables (LUTs). You can perform custom warpings using LUTs.

A warping associates each pixel position of the destination buffer, (x_d, y_d ), with a specific point in the source buffer, (x_s, y_s ), and then determines the pixel value of (x_d, y_d ) from its associated point and from a specified interpolation mode.

When performing a first-order polynomial warping, (x_d, y_d ) gets associated with (x_s, y_s ) through the following equations:

x _s = a₀ x _d + a₁ y _d + a₂ .

y _s = b₀ x _d + b₁ y _d + b₂ .

When performing a perspective polynomial warping, (x_d, y_d ) gets associated with (x_s, y_s ) through the following equations:

x _s = (a₀ x _d + a₁ y _d + a₂)/(c₀ x _d + c₁ y _d + c₂).

y _s = (b₀ x _d + b₁ y _d + b₂)/(c₀ x _d + c₁ y _d + c₂).

When performing a 3x3 matrix-defined warping, WarpParam1BufId specifies the required coefficients (a₀...a₂, b₀...b₂ ) or (a₀...a₂, b₀...b₂, c₀...c₂ ) and WarpParam2BufId must be set to M_NULL. The coefficients can be automatically generated using MgenWarpParameter() or can be user-supplied.

When performing a warping using LUTs, x_s is determined from (x_d, y_d ) through one LUT and y_s is determined from (x_d, y_d ) through another LUT. In this case, WarpParam1BufId specifies the LUT for x_s and WarpParam2BufId specifies the LUT for y_s . The LUTs can be user-supplied or can be automatically generated from a 3x3 coefficient matrix (for a first-order or polynomial warping) using MgenWarpParameter().

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

SrcImageBufId

Specifies the buffer on which to perform the warping. This buffer can be of any type.

This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

DstImageBufId

Specifies the buffer in which to place the results of the warping. This buffer can be of any type.

This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

Note that after performing the operation, the destination image will not be calibrated, even if the source image was calibrated.

WarpParam1BufId

Specifies the buffer containing the matrix coefficients or the LUT buffer from which x _s is determined.

When WarpParam1BufId specifies the (a₀...a₂, b₀...b₂ ) or (a₀...a₂, b₀...b₂, c₀...c₂ ) coefficients, the coefficients must be in a single-band, 32-bit floating-point buffer that has an M_ARRAY attribute and that has dimensions 3x2 or 3x3. The first row specifies the a _n coefficients, the second row specifies the b _n coefficients, and the third row specifies the c _n coefficients. If the buffer is 3x2, the third row is assumed to be (0, 0, 1).

When WarpParam1BufId specifies the LUT buffer from which x _s is determined, the buffer must be a signed 16- or 32-bit integer buffer, have the same X and Y size as the destination image buffer, and have an M_LUT attribute.

WarpParam2BufId

Specifies the LUT buffer from which y _s is determined. This buffer must be a signed 16- or 32-bit integer buffer, have the same X and Y size as the destination image buffer, and have an M_LUT attribute.

If you are not using LUTs to perform the warping, set WarpParam2BufId to M_NULL.

OperationMode

Specifies the mode of operation. This parameter must be set to one of the values below.

For specifying the mode of operation
Value	Description
M_WARP_LUT +	Performs the warping through LUTs.
M_WARP_POLYNOMIAL	Performs the warping through a 3x3 coefficient matrix. This includes a first-order polynomial warping or a perspective polynomial warping. Note that with a perspective polynomial warping matrix, MimWarp() might return an error if the calculation of (c₀x_d+ c₁y_d+ c₂) is 0 in the destination buffer, regardless of whether or not the matrix was generated using MgenWarpParameter(). (summarize) Performs the warping through a 3x3 coefficient matrix. (more details...)

Combination value for M_WARP_LUT.

You can add the following value to the above-mentioned value to specify the number of fractional bits in the coordinates of the source point.

For M_WARP_LUT
Combination value	Description
M_FIXED_POINT + n	Specifies the number of fractional bits for the source point ( x _s , y _s ). To do so, add the define M_FIXED_POINT + n to M_WARP_LUT where n >= 0. If nothing is added to M_WARP_LUT, it is assumed that there are no fractional bits in the coordinates of the source point (and therefore interpolation is not required). (summarize) Specifies the number of fractional bits for the source point ( x _s , y _s ). (more details...)

InterpolationMode

Specifies the interpolation mode. This parameter must be set to one of the values below.

For specifying the interpolation mode
Value	Description	MIL system-specific tooltip (‡)
M_DEFAULT	Same as M_NEAREST_NEIGHBOR + M_OVERSCAN_ENABLE.	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_BICUBIC +	Specifies bicubic interpolation. The new value is determined by taking a weighted average of the 16 values (4x4) that surround the source point. Note that the sum of the weights used for bicubic interpolation might be greater than one. If this occurs and the result reflects an overflow or underflow, the result is saturated according to the depth and data type of the destination buffer. (summarize) Specifies bicubic interpolation. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_BILINEAR +	Specifies bilinear interpolation. The new value is determined by taking a weighted average of the 4 values (2x2) that surround the source point. (summarize) Specifies bilinear interpolation. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_NEAREST_NEIGHBOR +	Specifies nearest neighbor interpolation. The new value is that of the pixel closest to the source point. (summarize) Specifies nearest neighbor interpolation. (more details...)	‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa

Combination values for any of the possible values of the InterpolationMode parameter.

You can add one of the following values to the above-mentioned values to specify how to determine the value of a destination pixel when its associated point falls outside the source buffer.

For overscan
Combination value	Description		MIL system-specific tooltip (‡)
M_OVERSCAN_CLEAR	Sets the destination pixel to 0, if the associated point falls outside the source buffer.		‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_OVERSCAN_DISABLE	Leaves the destination pixel as is.		‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
M_OVERSCAN_ENABLE	Uses pixels from the source buffer's ancestor buffer. If the source buffer is not a child buffer or if the point falls outside the ancestor buffer, leave the destination pixel as is. This is the default value. (summarize) Uses pixels from the source buffer's ancestor buffer. (more details...)		‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa
		MIL system specific
		Points falling outside the source image are undefined.	‡						j	k M10	l	m		p	r U27				y U75	aa
M_OVERSCAN_FAST	Specifies that MIL will automatically select the overscan that optimizes speed, according to the specified operation and the target system. The overscan could be hardware-specific thereby having a different behavior than the other supported overscan modes. Note that when using M_OVERSCAN_FAST, the destination pixels in the overscan area are undefined. The pixels can therefore contain different values from one function call to the next, even if the function's parameter values are the same. (summarize) Specifies that MIL will automatically select the overscan that optimizes speed, according to the specified operation and the target system. (more details...)		‡	a	c M10	g	h	i	j	k M10	l	m	o	p	r U27	t U28	u U36	v	y U75	aa

Compilation information

Header	Include mil.h.
Library	Use mil.lib; milim.lib.
DLL	Requires mil.dll; milim.dll.