MimRearrange

See also

User Guide:

Rearranging areas in your grabbed image

Reference:

MbufInquire MimAlloc MimControl MimInquire MimPut MimStatCalculate

Availability

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)

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 Radient eCL (j)

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

Fully supported on Matrox Solios eA/XA (l)

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

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

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

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

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)

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

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

* 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

None.

MimRank

Function Map

- RearrangeContextImId

- SrcImageBufId

- DstImageBufId

- ControlFlag

Table:

For specifying the operation to perform

Compilation information

Synopsis

Copies specified areas of a source buffer to the specified areas of a destination buffer.

Syntax

void MimRearrange(

MIL_ID RearrangeContextImId,	//in
MIL_ID SrcImageBufId,	//in
MIL_ID DstImageBufId,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function copies specified areas of a source buffer to specified areas of a destination buffer. The rest of the source image buffer is ignored and not copied.

Before using this function, you must configure the specified image processing context with which operation to perform, using MimControl() with M_MODE. This specifies whether to copy rectangular areas or rows of the source buffer. In addition, you must specify the offsets and sizes of the source and destination areas, using MimPut() with M_XY_SOURCE, M_XY_DESTINATION, and M_XY_SIZE. Note that each array in the rearrangement image processing context must have the same number of elements. The source and destination image buffers need not be of the same size, but must be equal to or larger than the largest supplied source and destination coordinates.

Once the rearrangement image processing context is configured, preprocess the context by calling MimRearrange() with M_PREPROCESS. If the preprocess operation is not done explicitly (using M_PREPROCESS), it will be done when MimRearrange() is first called. When preprocessing explicitly, the source and destination image buffers can be set to M_NULL. If, however, the source or destination image buffer is provided, it will be used in the preprocess operation, to better optimize future calls.

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

RearrangeContextImId

Specifies the identifier of the rearrangement image processing context that indicates how to perform the operation and the locations to copy. This context should be previously allocated using MimAlloc() with M_REARRANGE_CONTEXT.

SrcImageBufId

Specifies the identifier of the source image buffer.

If preprocessing the rearrangement image processing context (using M_PREPROCESS), set this parameter to the identifier of a typical source image buffer. Otherwise, to exclude this buffer from preprocessing, set this parameter to M_NULL.

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 identifier of the destination image buffer.

If preprocessing the rearrangement image processing context (using M_PREPROCESS), set this parameter to the identifier of a typical destination image buffer. Otherwise, to exclude this buffer from preprocessing, set this parameter to M_NULL.

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.

ControlFlag

Specifies the operation to perform. This parameter must be set to one of the following values.

For specifying the operation to perform
Value	Description
M_DEFAULT	Performs the rearrangement operation.
M_PREPROCESS	Preprocesses the specified image processing context. Note that, if not called explicitly, this operation will be performed automatically upon the first call to MimRearrange(). If the identifier of the source and/or destination image buffer is not set to M_NULL, information about the source and/or destination image buffer will be used in the preprocessing operation. (summarize) Preprocesses the specified image processing context. (more details...)

Compilation information

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