MimPut

See also

User Guide:

Correcting dead pixels Rearranging areas in your grabbed image

Reference:

MimAlloc MimControl MimDeadPixelCorrection MimGet MimInquire MimRearrange

Availability

Available in MIL-Lite with restrictions (see remarks)

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

deadpixelcorrection.cpp

Function Map

- ContextImId

- PutType

- ArraySize

- Param1Ptr

- Param2Ptr

- ControlFlag

Parameter Associations

Table:	For setting array(s) of values into an image processing context
+ combination:	For specifying the data type of Param1Ptr and Param2Ptr

Remarks

Compilation information

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 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

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).

When using a standard vector (std::vector) overload function in C++, you can pass M_DEFAULT to this parameter and MIL will automatically determine the size based on the number of items in the vector passed to the Param1Ptr or Param2Ptr parameter.

Param1Ptr

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ]
array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ]
array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ]
array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ]
array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ]
array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<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 MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ]
array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ]
array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ]
array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ]
array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ]
array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<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.

For setting array(s) of values into an image processing context

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

For setting array(s) of values into an image processing context
ContextImId			Description
	PutType
		Param1Ptr
		Param2Ptr
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) Specifies a dead pixel correction image processing context, allocated using MimAlloc() with M_DEAD_PIXEL_CONTEXT, and used in MimDeadPixelCorrection() operations. (more details...)
	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) Specifies the X- and Y-coordinates of the dead pixels in the source image, relative to the pixel coordinate system. (more details...)
		Param1Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the X-coordinates of the dead pixels, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the X-coordinates of the dead pixels, in pixels.
		Param2Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the Y-coordinates of the dead pixels, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the Y-coordinates of the dead pixels, in pixels.
Rearrangement image processing context ID +			Specifies a rearrangement image processing context, allocated using MimAlloc() with M_REARRANGE_CONTEXT, and used in MimRearrange() operations. (summarize) Specifies a rearrangement image processing context, allocated using MimAlloc() with M_REARRANGE_CONTEXT, and used in MimRearrange() operations. (more details...)
	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) 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. (more details...)
		Param1Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. 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) Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the X-offsets of the destination areas, in pixels. (more details...)
		Param2Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the Y-offsets of the destination areas, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the Y-offsets of the destination areas, in pixels.
	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) Specifies the width and height of the areas to copy, relative to the pixel coordinate system. (more details...)
		Param1Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the width of the areas, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the width of the areas, in pixels.
		Param2Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the height of the areas, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the height of the areas, in pixels.
	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) 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. (more details...)
		Param1Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. 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) Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the X-offsets of the source areas, in pixels. (more details...)
		Param2Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the Y-offsets of the source areas, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Specifies an array with the Y-offsets of the source areas, in pixels.

Combination values 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.

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

For specifying the data type of Param1Ptr and Param2Ptr
ContextImId			Description
	PutType
		Param1Ptr
		Param2Ptr
M_TYPE_MIL_DOUBLE			Specifies that the array is a MIL_DOUBLE. (summarize) Specifies that the array is a MIL_DOUBLE. (more details...)
	Param1Ptr		Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere)
	Param2Ptr		Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a constant std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere)
M_TYPE_MIL_FLOAT			Specifies that the array is a MIL_FLOAT. (summarize) Specifies that the array is a MIL_FLOAT. (more details...)
	Param1Ptr		Data type info: Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] Required array size:(defined elsewhere)
	Param2Ptr		Data type info: Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a constant std::vector<MIL_FLOAT> ] Required array size:(defined elsewhere)
M_TYPE_MIL_INT			Specifies that the array is a MIL_INT. (summarize) Specifies that the array is a MIL_INT. (more details...)
	Param1Ptr		Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(defined elsewhere)
	Param2Ptr		Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a constant std::vector<MIL_INT> ] Required array size:(defined elsewhere)
M_TYPE_MIL_INT16			Casts the requested results to a MIL_INT16. (summarize) Casts the requested results to a MIL_INT16. (more details...)
	Param1Ptr		Data type info: Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] Required array size:(defined elsewhere)
	Param2Ptr		Data type info: Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a constant std::vector<MIL_INT16> ] Required array size:(defined elsewhere)
M_TYPE_MIL_INT32			Specifies that the array is a MIL_INT32. (summarize) Specifies that the array is a MIL_INT32. (more details...)
	Param1Ptr		Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] Required array size:(defined elsewhere)
	Param2Ptr		Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a constant std::vector<MIL_INT32> ] Required array size:(defined elsewhere)
M_TYPE_MIL_INT64			Specifies that the array is a MIL_INT64. (summarize) Specifies that the array is a MIL_INT64. (more details...)
	Param1Ptr		Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] Required array size:(defined elsewhere)
	Param2Ptr		Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] Required array size:(defined elsewhere) Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a constant std::vector<MIL_INT64> ] Required array size:(defined elsewhere)

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.