| MIL 10 Reference
| Customize Help
| Save Settings

MimPut


See also
Availability
Available in MIL-Lite with restrictions (see remarks)
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MimProject
MimRank
Synopsis
Puts arrays of values into an image processing context.
Syntax
void MimPut(
MIL_ID ContextImId, //in
MIL_INT64 PutType, //in
MIL_INT ArraySize, //in
const void *Param1Ptr, //in
const void *Param2Ptr, //in
MIL_INT64 ControlFlag //in
)
Description

This function puts arrays of values into a specified image processing context.

The number of arrays and the nature of the values depend on the image processing context used and on the specified type of information to set. After setting the array(s), their values can be inquired using MimGet().

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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
ContextImId

Specifies the identifier of the image processing context. The image processing context must have been previously allocated with MimAlloc().

See the Parameter associations section for possible values that can be specified.

PutType

Specifies the type of information in the array(s).

See the Parameter associations section for possible values that can be specified.

ArraySize INQ

Specifies the number of values in the array(s).

Param1Ptr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type char
  • array of type MIL_DOUBLE
  • array of type MIL_FLOAT
  • array of type MIL_INT
  • array of type MIL_INT16
  • array of type MIL_INT32
  • array of type MIL_INT64

Specifies the address of the first array of values.

See the Parameter associations section for possible values that can be specified.

Param2Ptr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type char
  • array of type MIL_DOUBLE
  • array of type MIL_FLOAT
  • array of type MIL_INT
  • array of type MIL_INT16
  • array of type MIL_INT32
  • array of type MIL_INT64

Specifies the address of the second array of values.

Note that the second array must have the same number of elements as the first array.

See the Parameter associations section for possible values that can be specified.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the ContextImId, PutType, Param1Ptr, and Param2Ptr parameters.

The following ContextImId, PutType, Param1Ptr, and Param2Ptr parameter settings can be specified to put values into an image processing context.

Unless otherwise specified, the following values require that you pass the Param1Ptr parameter and the Param2Ptr parameter the address of an array of type MIL_INT with a size equal to one element per dead pixel or rearrangement area.

function map For setting array(s) of values into an image processing context
CollapseContextImId Description
PutType
Param1Ptr
Param2Ptr
Collapse Dead pixel correction image processing
context ID +

Specifies a dead pixel correction image processing context, allocated using MimAlloc() with M_DEAD_PIXEL_CONTEXT, and used in MimDeadPixelCorrection() operations.

(summarize)
Collapse M_XY_DEAD_PIXELS +

Specifies the X- and Y-coordinates of the dead pixels in the source image, relative to the pixel coordinate system.

Note that you should only use this setting if you have not specified an image that identifies the dead pixels, using MimControl() with M_DEAD_PIXELS.

(summarize)
Collapse Param1Ptr

Specifies an array with the X-coordinates of the dead pixels, in pixels.
Collapse Param2Ptr

Specifies an array with the Y-coordinates of the dead pixels, in pixels.
Collapse Rearrangement image processing context ID +

Specifies a rearrangement image processing context, allocated using MimAlloc() with M_REARRANGE_CONTEXT, and used in MimRearrange() operations.

(summarize)
Collapse M_XY_DESTINATION +

Specifies the X- and Y-offsets of the areas in the destination image buffer into which to copy the source areas, relative to the pixel coordinate system.

(summarize)
Collapse Param1Ptr

Specifies an array with the X-offsets of the destination areas, in pixels.

When in line mode (MimControl() with M_MODE set to M_LINES), all values in this array must be set to 0, because MimRearrange() can only copy entire rows in M_LINES mode. For example, when dealing with 3 areas, the X-offset array must contain the following: [0, 0, 0].

(summarize)
Collapse Param2Ptr

Specifies an array with the Y-offsets of the destination areas, in pixels.
Collapse M_XY_SIZE +

Specifies the width and height of the areas to copy, relative to the pixel coordinate system.

Note that this settings is only available when in rectangle mode (MimControl() with M_MODE set to M_RECTS).

(summarize)
Collapse Param1Ptr

Specifies an array with the width of the areas, in pixels.
Collapse Param2Ptr

Specifies an array with the height of the areas, in pixels.
Collapse M_XY_SOURCE +

Specifies the X- and Y-offsets of the areas to copy from the source image buffer into the destination image buffer, relative to the pixel coordinate system.

(summarize)
Collapse Param1Ptr

Specifies an array with the X-offsets of the source areas, in pixels.

When in line mode (MimControl() with M_MODE set to M_LINES), all values in this array must be set to 0, because MimRearrange() can only copy entire rows in M_LINES mode. For example, when dealing with 3 areas, the X-offset array must contain the following: [0, 0, 0].

(summarize)
Collapse Param2Ptr

Specifies an array with the Y-offsets of the source areas, in pixels.
Combination constants for the values listed in For setting array(s) of values into an image processing context.

You can add one of the following values to the above-mentioned values to cast the specified array to the required data type.

function map For specifying the data type of Param1Ptr and Param2Ptr
CollapseContextImId Description
PutType
Param1Ptr
Param2Ptr
Collapse M_TYPE_CHAR

Specifies that the array is a char.

(summarize)
Collapse Param1Ptr and Param2Ptr
Data type info

Data type: array of type char
Array size: One element per dead pixel or rearrangement area.
Collapse M_TYPE_MIL_DOUBLE

Specifies that the array is a MIL_DOUBLE.

(summarize)
Collapse Param1Ptr and Param2Ptr
Data type info

Data type: array of type MIL_DOUBLE
Array size: One element per dead pixel or rearrangement area.
Collapse M_TYPE_MIL_FLOAT

Specifies that the array is a MIL_FLOAT.

(summarize)
Collapse Param1Ptr and Param2Ptr
Data type info

Data type: array of type MIL_FLOAT
Array size: One element per dead pixel or rearrangement area.
Collapse M_TYPE_MIL_INT

Specifies that the array is a MIL_INT.

(summarize)
Collapse Param1Ptr and Param2Ptr
Data type info

Data type: array of type MIL_INT
Array size: One element per dead pixel or rearrangement area.
Collapse M_TYPE_MIL_INT16

Casts the requested results to a MIL_INT16.

(summarize)
Collapse Param1Ptr and Param2Ptr
Data type info

Data type: array of type MIL_INT16
Array size: One element per dead pixel or rearrangement area.
Collapse M_TYPE_MIL_INT32

Specifies that the array is a MIL_INT32.

(summarize)
Collapse Param1Ptr and Param2Ptr
Data type info

Data type: array of type MIL_INT32
Array size: One element per dead pixel or rearrangement area.
Collapse M_TYPE_MIL_INT64

Specifies that the array is a MIL_INT64.

(summarize)
Collapse Param1Ptr and Param2Ptr
Data type info

Data type: array of type MIL_INT64
Array size: One element per dead pixel or rearrangement area.
Remark
  • [MIL-Lite]
    Note that some of the values listed above are not available in MIL-Lite. See the value's corresponding operation function for MIL-Lite availability.
Compilation information
Header Include mil.h.
Library Use mil.lib; milim.lib.
DLL Requires mil.dll; milim.dll.
DEAD PIXEL CONTEXT XY DEAD PIXELS REARRANGE CONTEXT XY DESTINATION XY SIZE XY SOURCE TYPE CHAR TYPE MIL DOUBLE TYPE MIL FLOAT TYPE MIL INT TYPE MIL INT16 TYPE MIL INT32 TYPE MIL INT64