Click here to show toolbars of the Web Online Help System: show toolbars
 

| Customize Help
| Save Settings

MimGet


Function Map
Syntax
Description
Parameters
- 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().

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

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

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 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 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 array in which to store the second set of values. Note that this parameter can be set to M_NULL when trying to establish the required size for the arrays.

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

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

function map For getting arrays of value(s) from an image processing context
Click to summarizeContextImId Description
GetType
Param1Ptr
- Possible values returned
Param2Ptr
- Possible values returned
Click to summarize 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)
Click to summarize 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)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT (more details...)

Returns an array with the X-coordinates of the dead pixels, in pixels.
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT (more details...)

Returns an array with the Y-coordinates of the dead pixels, in pixels.
Click to summarize Rearrangement image processing context ID +

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

(summarize)
Click to summarize 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)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT (more details...)

Returns an array with the X-offsets of the destination areas, in pixels.
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT (more details...)

Returns an array with the Y-offsets of the destination areas, in pixels.
Click to summarize M_XY_SIZE +

Retrieves the width and height of the areas to be copied, relative to the pixel coordinate system.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT (more details...)

Returns an array with the width of the areas, in pixels.
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT (more details...)

Returns an array with the height of the areas, in pixels.
Click to summarize 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)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT (more details...)

Returns an array with the X-offsets of the source areas, in pixels.
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT (more details...)

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.

function map For specifying the data type of Param1Ptr and Param2Ptr
Click to summarizeContextImId Description
GetType
Param1Ptr
- Possible values returned
Param2Ptr
- Possible values returned
Click to summarize M_TYPE_CHAR

Specifies that the array is a char.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type char (more details...)
Click to summarize Param2Ptr
Data type info: Data type: array of type char (more details...)
Click to summarize M_TYPE_MIL_DOUBLE

Specifies that the array is a MIL_DOUBLE.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_DOUBLE (more details...)
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_DOUBLE (more details...)
Click to summarize M_TYPE_MIL_FLOAT

Specifies that the array is a MIL_FLOAT.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_FLOAT (more details...)
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_FLOAT (more details...)
Click to summarize M_TYPE_MIL_INT

Specifies that the array is a MIL_INT.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT (more details...)
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT (more details...)
Click to summarize M_TYPE_MIL_INT16

Casts the requested results to a MIL_INT16.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT16 (more details...)
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT16 (more details...)
Click to summarize M_TYPE_MIL_INT32

Specifies that the array is a MIL_INT32.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT32 (more details...)
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT32 (more details...)
Click to summarize M_TYPE_MIL_INT64

Specifies that the array is a MIL_INT64.

(summarize)
Click to summarize Param1Ptr
Data type info: Data type: array of type MIL_INT64 (more details...)
Click to summarize Param2Ptr
Data type info: Data type: array of type MIL_INT64 (more details...)
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.
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