MimGet

See also

User Guide:

Correcting dead pixels

Reference:

MimAlloc MimAugment MimControl MimDeadPixelCorrection MimInquire MimPut 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

None.

MimFree

Function Map

- ContextImId

- GetType

- ArraySize

- Param1Ptr

- Param2Ptr

- ControlFlag

Parameter Associations

Table:	For getting arrays of value(s) from an image processing context
+ combination:	For specifying the data type of Param1Ptr and Param2Ptr

Return value

Remarks

Compilation information

Synopsis

Gets arrays of values from an image processing context.

Syntax

MIL_INT MimGet(

MIL_ID ContextImId,	//in
MIL_INT64 GetType,	//in
MIL_INT ArraySize,	//in
void *Param1Ptr,	//out
void *Param2Ptr,	//out
MIL_INT64 ControlFlag	//in

)

Description

This function gets array(s) of values from an 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 get. Before you can inquire the content of the array(s), they must be set using MimPut(), unless otherwise specified.

To determine the size of the arrays required to store the requested values, call this function and set Param1Ptr and Param2Ptr to M_NULL. Alternatively, when dealing with a dead pixel correction image processing context, to determine the size of the arrays required to store the X- and Y- coordinates of the dead pixels, you can also use MimInquire() with M_XY_DEAD_PIXELS_ARRAY_SIZE. When dealing with a rearrangement image processing context, to determine the size of the arrays required to store the X- and Y- coordinates of the areas to move from the source to the destination and to determine the number of areas to be copied, you can also use MimInquire() with M_XY_DESTINATION_ARRAY_SIZE, M_XY_SIZE_ARRAY_SIZE, and M_XY_SOURCE_ARRAY_SIZE, respectively.

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.

GetType

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

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

ArraySize

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

Specifies the address of the array in which to store the first set of values. Note that this parameter can be set to M_NULL when trying to establish the required size for the arrays.

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

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

Specifies the address of the array in which to store the second set of values. This parameter can be set to M_NULL when trying to establish the required size for the arrays.

The second array, when required, must have the same number of elements as the first array.

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

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the ContextImId and GetType parameters and possible values returned to the Param1Ptr and Param2Ptr parameters.

For getting arrays of value(s) from an image processing context

The following ContextImId, GetType, Param1Ptr, and Param2Ptr settings can be specified to get values from an image processing context.

For getting arrays of value(s) from an image processing context
ContextImId			Description
	GetType
		Param1Ptr - Possible values returned
		Param2Ptr - Possible values returned
Augmentation context ID +			Specifies an augmentation context, allocated using MimAlloc() with M_AUGMENTATION_CONTEXT, and used in MimAugment() operations. You need not use MimPut() to inquire about an augmentation context. (summarize) Specifies an augmentation context, allocated using MimAlloc() with M_AUGMENTATION_CONTEXT, and used in MimAugment() operations. (more details...)
	M_AUG_OPERATIONS_ENABLED +		Retrieves the list of the operations that were enabled for MimAugment(). Operations are enabled using MimControl() with M_AUG_..._OP. (summarize) Retrieves the list of the operations that were enabled for MimAugment(). (more details...)
		Param1Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the enabled operations. The returned list is sorted according to the priority that MimAugment() uses to perform the specified image processing operations. (summarize) Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the enabled operations. (more details...)
		Param2Ptr	Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL
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 +		Retrieves the X- and Y-coordinates of the dead pixels in the source image, relative to the pixel coordinate system. (summarize) Retrieves 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 +		Retrieves 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) Retrieves 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the X-offsets of the destination areas, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the X-offsets of the destination areas, in pixels.
		Param2Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the Y-offsets of the destination areas, in pixels.
	M_XY_SIZE +		Retrieves the width and height of the areas to be copied, relative to the pixel coordinate system. (summarize) Retrieves the width and height of the areas to be copied, 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the height of the areas, in pixels.
	M_XY_SOURCE +		Retrieves the X- and Y-offsets of the areas to be copied from the source image buffer into the destination image buffer, relative to the pixel coordinate system. (summarize) Retrieves the X- and Y-offsets of the areas to be copied 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the X-offsets of the source areas, in pixels. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the X-offsets of the source areas, in pixels.
		Param2Ptr	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(ArraySize) Note: The array size is determined by calling the function twice. Returns an array with the Y-offsets of the source areas, in pixels.

Combination values for the values listed in For getting arrays of value(s) from 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
	GetType
		Param1Ptr - Possible values returned
		Param2Ptr - Possible values returned
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 std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a 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 std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a 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 std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a 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 std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a 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 std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a 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 std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a 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 std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a 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 std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a 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 std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a 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 std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a 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 std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a 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 std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a 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 std::vector<MIL_INT16> ] MORE Data type: array of type MIL_INT16 [optionally, in C++: a reference to a 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 std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a 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 std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a 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 std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a 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 std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a 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 std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a 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 std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a 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 std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a 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 std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] Required array size:(defined elsewhere)

Return value

The returned value is the number of entries in the array(s). If Param1Ptr and Param2Ptr are both set to M_NULL, MimGet() returns the size of the required arrays.

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.