| MIL 10 Reference
| Customize Help
| Save Settings

MimInquire


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
MimHistogramEqualizeAdaptive
MimLabel
Synopsis
Inquire about an image processing context or result buffer setting.
Syntax
MIL_INT MimInquire(
MIL_ID ContextOrResultImId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about an image processing context or result buffer setting. The image processing context or result buffer must have been allocated with MimAlloc() or MimAllocResult(), 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
ContextOrResultImId

Specifies the identifier of the image processing context or result buffer about which to inquire information.

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

InquireType

Specifies the type of information about which to inquire.

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

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address of the variable in which to write the requested information. Since the MimInquire() function also returns the requested information, you can set this parameter to M_NULL.

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

Parameter associations

The tables below list possible values for the ContextOrResultImId and InquireType parameters and possible values returned to the UserVarPtr parameter.

For any image processing result buffer, the ContextOrResultImId and InquireType parameters can be set to one of the following.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about any image processing result buffer
CollapseContextOrResultImId Description
InquireType
UserVarPtr
- Possible values returned
Collapse Image processing result buffer ID +

Specifies an image processing result buffer, allocated using MimAllocResult().

(summarize)
Collapse M_MODIFICATION_COUNT +

Inquires the number of modifications made to the result buffer since it was allocated.

(summarize)
Collapse Value

Specifies the number of modifications.
Collapse M_OWNER_SYSTEM +

Inquires the identifier of the system on which the result buffer is allocated. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_ID

Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Collapse MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().
Collapse M_RESULT_SIZE +

Inquires the number of entries in the result buffer. SET

(summarize)
Collapse Value

Specifies the number of buffer entries. INFO
Collapse M_RESULT_TYPE +

Inquires the attribute or nature of the result buffer. SET

(summarize)
Collapse M_COUNT_LIST

Specifies that the buffer can hold MimCountDifference() results.
Collapse M_EVENT_LIST

Specifies that the buffer can hold MimLocateEvent() results.
Collapse M_EXTREME_LIST

Specifies that the buffer can hold MimFindExtreme() results.
Collapse M_FIND_ORIENTATION_LIST

Specifies that the buffer can hold MimFindOrientation() results.
Collapse M_HIST_LIST

Specifies that the buffer can hold MimHistogram() results.
Collapse M_LOCATE_PEAK_1D_RESULT

Specifies that the buffer can hold MimLocatePeak1d() results. INFO
Collapse M_PROJ_LIST

Specifies that the buffer can hold MimProject() results.
Collapse M_STAT_LIST

Specifies that the buffer can hold MimStat() results.
Collapse M_STAT_MULTIPLE_RESULT

Specifies that the buffer can hold MimStatMultiple() results.
Collapse M_WAVELET_TRANSFORM_RESULT

Specifies that the buffer can hold results from MimWaveletTransform() and MimWaveletDenoise(). INFO

For any image processing context, the ContextOrResultImId and InquireType parameters can be set to the following:

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about any image processing context
CollapseContextOrResultImId Description
InquireType
UserVarPtr
- Possible values returned
Collapse Image processing context ID +

Specifies an image processing context, allocated using MimAlloc().

(summarize)
Collapse M_CONTEXT_TYPE +

Inquires the type of the image processing context.

Note that on 32-bit platforms, the value returned will be 0 for all image processing context types that exceed the 32-bit range (only the deinterlacing image processing context is not subject to this limitation). SET

(summarize)
Collapse M_BINARIZE_ADAPTIVE_CONTEXT

Specifies an image processing context that can be used with MimBinarizeAdaptive() to perform an adaptive binarization.
Collapse M_BINARIZE_ADAPTIVE_FROM_SEED_CONTEXT

Specifies an image processing context that can be used with MimBinarizeAdaptive() to perform an adaptive binarization using seeds.
Collapse M_DEAD_PIXEL_CONTEXT

Specifies an image processing context that can be used with MimDeadPixelCorrection().
Collapse M_DEINTERLACE_CONTEXT

Specifies an image processing context that can be used with MimDeinterlace().
Collapse M_FIND_ORIENTATION_CONTEXT

Specifies an image processing context that can be used with MimFindOrientation().
Collapse M_FLAT_FIELD_CONTEXT

Specifies an image processing context that can be used with MimFlatField().
Collapse M_HISTOGRAM_EQUALIZE_ADAPTIVE_CONTEXT

Specifies an image processing context that can be used with MimHistogramEqualizeAdaptive().
Collapse M_LOCATE_PEAK_1D_CONTEXT

Specifies an image processing context that can be used with MimLocatePeak1d().
Collapse M_MATCH_CONTEXT

Specifies an image processing context that can be used with MimMatch().
Collapse M_REARRANGE_CONTEXT

Specifies an image processing context that can be used with MimRearrange().
Collapse M_STAT_MULTIPLE_CONTEXT

Specifies an image processing context that can be used with MimStatMultiple().
Collapse M_WAVELET_TRANSFORM_CONTEXT

Specifies an image processing context that can be used with MimWaveletTransform() and MimWaveletDenoise().
Collapse M_WAVELET_TRANSFORM_CUSTOM_CONTEXT

Specifies a custom image processing context that can be used with MimWaveletTransform() and MimWaveletDenoise().

For an image processing context of a specific type, the ContextOrResultImId and InquireType parameters can be set to one of the following:

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about a specific type of image processing context
CollapseContextOrResultImId Description
InquireType
UserVarPtr
- Possible values returned
Collapse Adaptive binarize context ID +

Specifies an adaptive binarize context, allocated using MimAlloc() with M_BINARIZE_ADAPTIVE_CONTEXT, and used in MimBinarizeAdaptive() operations.

(summarize)
Collapse M_AVERAGE_MODE +

Inquires how MIL establishes average pixel values. SET

(summarize)
Collapse M_GAUSSIAN

Specifies a Gaussian type average.
Collapse M_UNIFORM

Specifies a uniform type average.
Collapse M_FOREGROUND_VALUE +

Inquires whether the objects to binarize are lighter or darker than the background. SET

(summarize)
Collapse M_FOREGROUND_BLACK

Specifies that the objects to binarize are darker than the background.
Collapse M_FOREGROUND_WHITE

Specifies that the objects to binarize are lighter than the background.
Collapse M_GLOBAL_MAX +

Inquires the maximum threshold value. SET

(summarize)
Collapse Value > M_GLOBAL_MIN

Specifies the maximum threshold value.
Collapse M_GLOBAL_MIN +

Inquires the minimum threshold value. SET

(summarize)
Collapse Value < M_GLOBAL_MAX

Specifies the minimum threshold value.
Collapse M_GLOBAL_OFFSET +

Inquires the offset to add to each established threshold value. SET

(summarize)
Collapse Value

Specifies the offset.
Collapse M_GLOBAL_OFFSET_SECOND_PASS +

Inquires the offset to apply to the threshold values for the second pass of an hysteresis adaptive binarization. SET

(summarize)
Collapse Value

Specifies the offset.
Collapse M_HYSTERESIS +

Inquires whether to perform the adaptive binarization using an hysteresis process. SET

(summarize)
Collapse M_DISABLE

Specifies that the adaptive binarization does not use an hysteresis process.
Collapse M_ENABLE

Specifies that the adaptive binarization uses an hysteresis process. INFO
Collapse M_LOCAL_DIMENSION +

Inquires the size of the neighborhood that the threshold mode uses to establish threshold values. SET

(summarize)
Collapse Value >= 1

Specifies the size of the neighborhood, in pixels. INFO
Collapse M_MINIMUM_CONTRAST +

Inquires the minimum contrast between background and foreground pixels. SET

(summarize)
Collapse Value >= 0.0

Specifies the minimum contrast.
Collapse M_NIBLACK_BIAS +

Inquires the bias for Niblack's binarization mode. SET

(summarize)
Collapse Value >= 0.0

Specifies the bias. INFO
Collapse M_NIBLACK_BIAS_SECOND_PASS +

Inquires the bias for the second pass of a Niblack adaptive binarization that uses an hysteresis process. SET

(summarize)
Collapse Value >= 0.0

Specifies the bias.
Collapse M_THRESHOLD_MODE +

Inquires how MIL establishes the threshold values with which to binarize the source image. SET

(summarize)
Collapse M_BERNSEN

Specifies that threshold values are established using Bernsen's adaptive threshold algorithm. INFO
Collapse M_LOCAL_MEAN

Specifies that threshold values are established using adaptive local mean calculations. INFO
Collapse M_NIBLACK

Specifies that threshold values are established using Niblack's adaptive threshold algorithm. INFO
Collapse M_PSEUDOMEDIAN

Specifies that threshold values are established using adaptive pseudomedian calculations. INFO
Collapse Adaptive binarize from seed context ID +

Specifies an adaptive binarize context that uses seeds, allocated using MimAlloc() with M_BINARIZE_ADAPTIVE_FROM_SEED_CONTEXT, and used in MimBinarizeAdaptive() operations.

(summarize)
Collapse M_FOREGROUND_VALUE +

Inquires whether the objects to binarize are lighter or darker than the background. SET

(summarize)
Collapse M_FOREGROUND_BLACK

Specifies that the objects to binarize are darker than the background.
Collapse M_FOREGROUND_WHITE

Specifies that the objects to binarize are lighter than the background.
Collapse M_GLOBAL_OFFSET +

Inquires the offset to add to each established threshold value. SET

(summarize)
Collapse Value

Specifies the offset.
Collapse M_NB_ITERATIONS +

Inquires the number of times to perform the adaptive threshold process specified with M_THRESHOLD_MODE. SET

(summarize)
Collapse M_TO_IDEMPOTENCE

Specifies that the threshold process iterates until idempotence is reached. INFO
Collapse Value > 0

Specifies the number of iterations. INFO
Collapse M_NB_SEED_ITERATIONS +

Inquires the number of iterations with which to internally establish seeds. SET

(summarize)
Collapse Value > 0

Specifies the number of iterations. INFO
Collapse M_THRESHOLD_MODE +

Inquires how MIL uses seeds to establish the threshold values with which to binarize the source image. SET

(summarize)
Collapse M_LEVEL

Specifies that threshold values are established using an adaptive leveling. INFO
Collapse M_RECONSTRUCT

Specifies that threshold values are established using an adaptive geodesic reconstruction. INFO
Collapse M_TOGGLE

Specifies that threshold values are established as one of two possibilities, defined by the seeds. INFO
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_DEAD_PIXELS_IMAGE_ATTRIBUTE +

Inquires the attribute of the dead pixels image.

(summarize)
Collapse M_INVALID

Specifies that dead pixels have not been specified using MimControl() with M_DEAD_PIXELS or using MimPut() with M_XY_DEAD_PIXELS.
Collapse Value

Specifies a bit-encoded value that indicates the image buffer's attributes, set at allocation.
Collapse M_DEAD_PIXELS_IMAGE_HEIGHT +

Inquires the height of the dead pixels image.

(summarize)
Collapse M_INVALID

Specifies that dead pixels have not been specified using MimControl() with M_DEAD_PIXELS or using MimPut() with M_XY_DEAD_PIXELS.
Collapse Value

Specifies the height, in pixels.
Collapse M_DEAD_PIXELS_IMAGE_NB_BANDS +

Inquires the number of bands of the dead pixels image.

(summarize)
Collapse M_INVALID

Specifies that dead pixels have not been specified using MimControl() with M_DEAD_PIXELS or using MimPut() with M_XY_DEAD_PIXELS.
Collapse Value

Specifies the number of bands.
Collapse M_DEAD_PIXELS_IMAGE_TYPE +

Inquires the bit depth and data type of the dead pixels image.

(summarize)
Collapse M_INVALID

Specifies that dead pixels have not been specified using MimControl() with M_DEAD_PIXELS or using MimPut() with M_XY_DEAD_PIXELS.
Collapse depth value + M_FLOAT

Specifies the data depth and that the data type is floating-point.
Collapse depth value + M_SIGNED

Specifies the data depth and that the data type is signed.
Collapse depth value + M_UNSIGNED

Specifies the data depth and that the data type is unsigned.
Collapse M_DEAD_PIXELS_IMAGE_WIDTH +

Inquires the width of the dead pixels image.

(summarize)
Collapse M_INVALID

Specifies that dead pixels have not been specified using MimControl() with M_DEAD_PIXELS or using MimPut() with M_XY_DEAD_PIXELS.
Collapse Value

Specifies the width, in pixels.
Collapse M_INTERPOLATION_MODE +

Inquires the interpolation mode used to establish the new value for dead pixels. SET

(summarize)
Collapse M_AVERAGE

Specifies to overwrite a dead pixel with an interpolation performed using a weighted average of all its neighboring pixels in the source image.
Collapse M_XY_DEAD_PIXELS_ARRAY_SIZE +

Inquires the number of elements in the arrays containing the X- and Y-coordinates of the dead pixels.

(summarize)
Collapse Value

Specifies the number of elements in the arrays.
Collapse Deinterlacing image processing context ID +

Specifies a deinterlacing image processing context, allocated using MimAlloc() with M_DEINTERLACE_CONTEXT, and used in MimDeinterlace() operations.

(summarize)
Collapse M_DEINTERLACE_TYPE +

Inquires the deinterlacing algorithm. SET

(summarize)
Collapse M_ADAPTIVE_AVERAGE

Specifies that the average algorithm is applied to the pixels that are considered to be part of a moving object and leaves the background pixels unchanged.
Collapse M_ADAPTIVE_BOB

Specifies that the bob algorithm is applied to the pixels that are considered to be part of a moving object and leaves the background pixels unchanged.
Collapse M_ADAPTIVE_DISCARD

Specifies that the discard algorithm is applied to the pixels that are considered to be part of a moving object and leaves the background pixels unchanged.
Collapse M_AVERAGE

Specifies the averaging algorithm. INFO
Collapse M_BOB

Specifies the bob algorithm. INFO
Collapse M_DISCARD

Specifies the discard algorithm. INFO
Collapse M_DISCARD_FIELD +

Inquires the field that is discarded when M_DEINTERLACE_TYPE is set to M_DISCARD or M_ADAPTIVE_DISCARD. SET

(summarize)
Collapse M_EVEN_FIELD

Specifies that the even field is discarded.
Collapse M_ODD_FIELD

Specifies that the odd field is discarded.
Collapse M_FIRST_FIELD +

Inquires the field that is processed first when M_DEINTERLACE_TYPE is set to M_BOB or M_ADAPTIVE_BOB. SET

(summarize)
Collapse M_EVEN_FIELD

Specifies that the even field is processed first.
Collapse M_ODD_FIELD

Specifies that the odd field is processed first.
Collapse M_MOTION_DETECT_NUM_FRAMES +

Inquires the number of frames to use to perform the motion detection. SET

(summarize)
Collapse Value > 1

Specifies the number of frames.
Collapse M_MOTION_DETECT_OUTPUT +

Inquires whether the output images will be the deinterlaced images or images indicating which pixels are considered to be part of an object in motion (the internal motion detection mask). SET

(summarize)
Collapse M_DISABLE

Specifies that the output images are the deinterlaced images.
Collapse M_ENABLE

Specifies that the output images indicate the background pixels and the pixels that are considered to be part of the object in motion.
Collapse M_MOTION_DETECT_REFERENCE_FRAME +

Inquires the index of the frame to use for deinterlacing within the group of frames that are used for motion detection. SET

(summarize)
Collapse M_CENTER_FRAME

Specifies that the center frame in the group is used as the reference frame.
Collapse M_FIRST_FRAME

Specifies that the first frame in the group is used as the reference frame.
Collapse M_LAST_FRAME

Specifies that the last frame in the group is used as the reference frame.
Collapse 0 <= Value < M_MOTION_DETECT_NUM_FRAMES

Specifies the index of the frame relative to the first frame of the group. INFO
Collapse M_MOTION_DETECT_THRESHOLD +

Inquires the threshold value used for motion detection. SET

(summarize)
Collapse Value >= 0

Specifies the threshold.
Collapse M_SOURCE_FIRST_IMAGE +

Inquires the index of the input image used to generate the first deinterlaced image. SET

(summarize)
Collapse Value >= 0

Specifies the index of the image in the source image array.
Collapse Find orientation image processing context ID +

Specifies a find orientation image processing context identifier, allocated using MimAlloc() with M_FIND_ORIENTATION_CONTEXT, and used in MimFindOrientation() operations.

(summarize)
Collapse M_BORDER_ATTENUATION +

Inquires whether MimFindOrientation() must process the image's borders, or if the operation can ignore noise occurring close to the ends of the image buffer. SET

(summarize)
Collapse M_DISABLE

Specifies that MimFindOrientation() cannot ignore the image's borders. INFO
Collapse M_ENABLE

Specifies that MimFindOrientation() can ignore the image's borders. INFO
Collapse M_FREQUENCY_CUTOFF_RATIO_HIGH +

Inquires the upper limit of frequencies in which to look for dominant orientations, as a percentage of the maximum frequency. Larger images will have higher maximum frequencies. Frequencies higher than this percentage will be ignored during computation. This can be useful for discarding noise in the image. SET

(summarize)
Collapse 0.0 <= Value <= 100.0

Specifies the upper limit of frequencies in which to look for dominant orientations, as a percentage of the maximum frequency. INFO
Collapse M_FREQUENCY_CUTOFF_RATIO_LOW +

Inquires the lower limit of frequencies in which to look for dominant orientations, as a percentage of the maximum frequency. Larger images will have higher maximum frequencies. Frequencies lower than this percentage will be ignored during computation. This can be useful for discarding noise in the image. SET

(summarize)
Collapse 0.0 <= Value <= 100.0

Specifies the lower limit of frequencies in which to look for dominant orientations, as a percentage of the maximum frequency. INFO
Collapse M_INTERPOLATION_MODE +

Inquires the interpolation mode for the resizing used if the source image is of an inappropriate size. This will only be used if the source image has dimensions that are not a power of 2 (X-size and Y-size). SET

(summarize)
Collapse M_DEFAULT

Same as M_NEAREST_NEIGHBOR.
Collapse M_AVERAGE

Specifies averaging interpolation. INFO
Collapse M_BICUBIC

Specifies bicubic interpolation.
Collapse M_BILINEAR

Specifies bilinear interpolation.
Collapse M_INTERPOLATE

Specifies interpolated resizing. INFO
Collapse M_MAX

Specifies an interpolation based on the maximum pixel value in the source image area. INFO
Collapse M_MIN

Specifies an interpolation based on the minimum pixel value in the source image area. INFO
Collapse M_NEAREST_NEIGHBOR

Specifies the nearest neighbor interpolation.
Collapse M_MODE +

Inquires the resizing mode used if the source image is of an inappropriate size. Resizing will only occur if the source image has dimensions that are not a power of 2 (X-size and Y-size). The find orientation operation is then performed on the resized image, which is stored in a temporary image buffer. The original image is not altered. SET

(summarize)
Collapse M_DEFAULT

Same as M_CLIP_CENTER.
Collapse M_CLIP_CENTER

Specifies to perform the find orientation operation using the largest centered portion of the image with dimensions that are a power of 2 (X-size and Y-size).
Collapse M_RESIZE_DOWN

Specifies to perform the find orientation operation on a subsampled version of the image with the closest possible dimensions that are a power of 2 (X-size and Y-size).
Collapse M_RESIZE_UP

Specifies to perform the find orientation operation on a zoomed version of the image with the closest possible dimensions that are a power of 2 (X-size and Y-size).
Collapse Flat-field image processing context ID +

Specifies a flat-field image processing context, allocated using MimAlloc() with M_FLAT_FIELD_CONTEXT, and used in MimFlatField() operations.

(summarize)
Collapse M_DARK_CONST +

Inquires the dark constant value. This is used to remove thermal agitation recorded in the grabbed image (from the CCD) and to remove the darkest possible shade of black when removing uneven lighting from grabbed images. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_INVALID_CONST

Specifies that the constant has not been set.
Collapse 0 <= Value <= 65535

Specifies the constant.
Collapse M_DARK_IMAGE_HEIGHT +

Inquires the height of the dark image buffer.

(summarize)
Collapse M_INVALID

Specifies that the dark image buffer has not been set, using MimControl() with M_DARK_IMAGE. This value is also returned when M_DARK_CONST is set.

(summarize)
Collapse Value

Specifies the height, in pixels.
Collapse M_DARK_IMAGE_NB_BANDS +

Inquires the number of color bands of the dark image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_DARK_IMAGE. This value is also returned when M_DARK_CONST is set.

(summarize)
Collapse Value

Specifies the number of color bands.
Collapse M_DARK_IMAGE_TYPE +

Inquires a combination of two values: data type and data depth of the dark image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_DARK_IMAGE. This value is also returned when M_DARK_CONST is set.

(summarize)
Collapse M_UNSIGNED + 8

Specifies 8-bit unsigned data.
Collapse M_UNSIGNED + 16

Specifies 16-bit unsigned data.
Collapse M_DARK_IMAGE_WIDTH +

Inquires the width of the dark image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_DARK_IMAGE. This value is also returned when M_DARK_CONST is set.

(summarize)
Collapse Value

Specifies the width, in pixels.
Collapse M_EFFECTIVE_GAIN_CONST +

Inquires the gain factor used during the last call to MimFlatField() (when M_GAIN_CONST set to M_AUTOMATIC). If the gain factor was set manually, inquire the value using M_GAIN_CONST.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_INVALID_CONST

Specifies that the gain factor has not been set.
Collapse Value > 0

Specifies the automatically calculated gain factor.
Collapse M_FLAT_CONST +

Inquires the flat constant value. This is used to remove the variations of CCD sensitivity recorded in the grabbed image (from the CCD) and to reduce the gray in the grabbed image when removing uneven lighting. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_INVALID_CONST

Specifies that the constant has not been set.
Collapse 0 <= Value <= 65535

Specifies the constant.
Collapse M_FLAT_IMAGE_HEIGHT +

Inquires the height of the flat image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_FLAT_IMAGE. This value is also returned when M_FLAT_CONST is set.

(summarize)
Collapse Value

Specifies the height, in pixels.
Collapse M_FLAT_IMAGE_NB_BANDS +

Inquires the number of color bands in the flat image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_FLAT_IMAGE. This value is also returned when M_FLAT_CONST is set.

(summarize)
Collapse Value

Specifies the number of color bands.
Collapse M_FLAT_IMAGE_TYPE +

Inquires the identifier of the flat image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_FLAT_IMAGE. This value is also returned when M_FLAT_CONST is set.

(summarize)
Collapse M_UNSIGNED + 8

Specifies 8-bit unsigned data.
Collapse M_UNSIGNED + 16

Specifies 16-bit unsigned data.
Collapse M_FLAT_IMAGE_WIDTH +

Inquires the width of the flat image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_FLAT_IMAGE. This value is also returned when M_FLAT_CONST is set.

(summarize)
Collapse Value

Specifies the width, in pixels.
Collapse M_GAIN_CONST +

Inquires the gain factor used to normalize (or scale) the result of the flat field calculation back to the full dynamic range of the destination image. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_AUTOMATIC

Specifies that the gain factor has been set to be automatically calculated. To inquire the automatically calculated value, use M_EFFECTIVE_GAIN_CONST.

(summarize)
Collapse M_INVALID_CONST

Specifies that the gain factor has not been set.
Collapse Value > 0.0

Specifies the gain factor.
Collapse M_OFFSET_CONST +

Inquires the offset constant value. This is used to remove the electrical bias recorded in the grabbed image (from the CCD) and to reduce the black in the flat image when removing uneven lighting. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_INVALID_CONST

Specifies that the constant has not been set.
Collapse 0 <= Value <= 65535

Specifies the constant.
Collapse M_OFFSET_IMAGE_HEIGHT +

Inquires the height of the offset image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_OFFSET_IMAGE. This value is also returned when M_OFFSET_CONST is set.

(summarize)
Collapse Value

Specifies the height, in pixels.
Collapse M_OFFSET_IMAGE_NB_BANDS +

Inquires the number of color bands in the offset image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_OFFSET_IMAGE. This value is also returned when M_OFFSET_CONST is set.

(summarize)
Collapse Value

Specifies the number of color bands.
Collapse M_OFFSET_IMAGE_TYPE +

Inquires a combination of two values: data type and data depth of the offset image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_OFFSET_IMAGE. This value is also returned when M_OFFSET_CONST is set.

(summarize)
Collapse M_UNSIGNED + 8

Specifies 8-bit unsigned data.
Collapse M_UNSIGNED + 16

Specifies 16-bit unsigned data.
Collapse M_OFFSET_IMAGE_WIDTH +

Inquires the width of the offset image buffer.

(summarize)
Collapse M_INVALID

Specifies that the image buffer has not been set, using MimControl() with M_OFFSET_IMAGE. This value is also returned when M_OFFSET_CONST is set.

(summarize)
Collapse Value

Specifies the width, in pixels.
Collapse Histogram equalization adaptive context ID +

Specifies a histogram equalization adaptive context, allocated using MimAlloc() with M_HISTOGRAM_EQUALIZE_ADAPTIVE_CONTEXT, and used in MimHistogramEqualizeAdaptive() operations.

(summarize)
Collapse M_ALPHA_VALUE +

Inquires the adjustment factor for M_EXPONENTIAL and M_RAYLEIGH operations. SET

(summarize)
Collapse Value >= 0.0

Specifies the adjustment factor. INFO
Collapse M_CLIP_LIMIT +

Inquires the maximum percentage of values that a tile's histogram bin can represent. SET

(summarize)
Collapse 0.0 < Value <= 100.0

Specifies the maximum percentage. INFO
Collapse M_HIST_SIZE +

Inquires the number of bins for each tile's histogram. SET

(summarize)
Collapse M_ACCORDING_TO_SOURCE

Specifies that MimHistogramEqualizeAdaptive() automatically determines the number of bins for each tile's histogram, according to the number of intensities that are possible in the specified image buffer. INFO
Collapse Value >= 2

Specifies the number of bins for each tile's histogram. INFO
Collapse M_NUMBER_OF_TILES_X +

Inquires the number of tiles along the X-direction of the source image specified with MimHistogramEqualizeAdaptive(). SET

(summarize)
Collapse Value >= 2

Specifies the number of tiles. INFO
Collapse M_NUMBER_OF_TILES_Y +

Inquires the number of tiles along the Y-direction of the source image specified with MimHistogramEqualizeAdaptive(). SET

(summarize)
Collapse Value >= 2

Specifies the number of tiles. INFO
Collapse M_OPERATION +

Inquires the equalization operation that MimHistogramEqualizeAdaptive() uses. SET

(summarize)
Collapse M_EXPONENTIAL

Specifies an equalization density function which generates an Exponential distribution. INFO
Collapse M_HYPER_CUBE_ROOT

Specifies an equalization density function which generates a Hyperbolic Cube Root distribution. INFO
Collapse M_HYPER_LOG

Specifies an equalization density function which generates a Hyperbolic Logarithmic distribution. INFO
Collapse M_RAYLEIGH

Specifies an equalization density function which generates a Rayleigh distribution. INFO
Collapse M_UNIFORM

Specifies an equalization density function which generates a Uniform distribution. INFO
Collapse Locate peak 1D image processing context ID +

Specifies a 1D locate peak image processing context, allocated using MimAlloc() with M_LOCATE_PEAK_1D_CONTEXT, and used in MimLocatePeak1d() operations.

(summarize)
Collapse M_MINIMUM_CONTRAST +

Inquires the minimum contrast. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 100.
Collapse 0 <= Value <= 255

Specifies the minimum contrast.
Collapse M_NUMBER_OF_PEAKS +

Inquires the maximum number of peaks to find along a given lane. If more than the specified number of peaks are found, the highest peaks are kept. SET

(summarize)
Collapse Value >= 0

Specifies the number of peaks. INFO
Collapse M_PEAK_INTENSITY_RANGE +

Inquires the number of pixels used to calculate the average peak intensity. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 5.
Collapse Value >= 0

Specifies the number of pixels.
Collapse M_PEAK_WIDTH_DELTA +

Inquires the peak width delta. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 20.
Collapse Value >= 0

Specifies the number of pixels.
Collapse M_PEAK_WIDTH_NOMINAL +

Inquires the peak width nominal. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 20.
Collapse Value >= 0

Specifies the number of pixels.
Collapse M_SCAN_LANE_DIRECTION +

Inquires the direction in which to detect peaks. SET

(summarize)
Collapse M_DEFAULT

Same as M_VERTICAL.
Collapse M_HORIZONTAL

Detects peaks along the image's X-axis. INFO
Collapse M_VERTICAL

Detects peaks along the image's Y-axis. INFO
Collapse Match image processing context ID +

Specifies a match image processing context, allocated using MimAlloc() with M_MATCH_CONTEXT, and used in MimMatch() operations.

(summarize)
Collapse M_MASK_IMAGE_ATTRIBUTE +

Inquires the attribute of the mask image.

(summarize)
Collapse M_INVALID

Specifies that the mask image buffer has not been set, using MimControl() with M_MASK_IMAGE.
Collapse Value

Specifies a bit-encoded value that indicates the image buffer's attributes, set at allocation.
Collapse M_MASK_IMAGE_HEIGHT +

Inquires the height of the mask image.

(summarize)
Collapse M_INVALID

Specifies that the mask image buffer has not been set, using MimControl() with M_MASK_IMAGE.
Collapse Value

Specifies the height, in pixels.
Collapse M_MASK_IMAGE_NB_BANDS +

Inquires the number of bands of the mask image.

(summarize)
Collapse M_INVALID

Specifies that the mask image buffer has not been set, using MimControl() with M_MASK_IMAGE.
Collapse Value

Specifies the number of bands.
Collapse M_MASK_IMAGE_TYPE +

Inquires the bit depth and data type of the mask image.

(summarize)
Collapse M_INVALID

Specifies that the mask image buffer has not been set, using MimControl() with M_MASK_IMAGE.
Collapse depth value + M_FLOAT

Specifies the data depth and that the data type is floating-point.
Collapse depth value + M_SIGNED

Specifies the data depth and that the data type is signed.
Collapse depth value + M_UNSIGNED

Specifies the data depth and that the data type is unsigned.
Collapse M_MASK_IMAGE_WIDTH +

Inquires the width of the mask image.

(summarize)
Collapse M_INVALID

Specifies that the mask image buffer has not been set, using MimControl() with M_MASK_IMAGE.
Collapse Value

Specifies the width, in pixels.
Collapse M_MAX_SCORE +

Inquires the specified maximum score used to remap normalized correlation. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_MAX_DEPTH

Specifies to establish the maximum score based on the pixel depth of the destination buffer (for example, when dealing with a 16-bit signed buffer, the maximum value would be 32, 767). INFO
Collapse Value

Specifies the maximum score. INFO
Collapse M_MODE +

Inquires the type of algorithm used when performing the match. SET

(summarize)
Collapse M_ABS_SUM_OF_DIFFERENCES

Specifies the absolute sum of the differences.
Collapse M_CORRELATE

Specifies a grayscale correlation.
Collapse M_CORRELATE_NORMALIZED

Specifies a normalized grayscale correlation.
Collapse M_MODEL_IMAGE_ATTRIBUTE +

Inquires the attributes of the internal buffer of the model image.

(summarize)
Collapse M_INVALID

Specifies that the model image buffer has not been set, using MimControl() with M_MODEL_IMAGE.
Collapse Value

Specifies a bit-encoded value that indicates the image buffer's attributes, set at allocation.
Collapse M_MODEL_IMAGE_HEIGHT +

Inquires the height of the model image.

(summarize)
Collapse M_INVALID

Specifies that the model image buffer has not been set, using MimControl() with M_MODEL_IMAGE.
Collapse Value

Specifies the height, in pixels.
Collapse M_MODEL_IMAGE_NB_BANDS +

Inquires the number of bands of the model image.

(summarize)
Collapse M_INVALID

Specifies that the model image buffer has not been set, using MimControl() with M_MODEL_IMAGE.
Collapse Value

Specifies the number of bands.
Collapse M_MODEL_IMAGE_TYPE +

Inquires the bit depth and data type of the model image.

(summarize)
Collapse M_INVALID

Specifies that the model image buffer has not been set, using MimControl() with M_MODEL_IMAGE.
Collapse M_UNSIGNED + 8

Specifies 8-bit unsigned data.
Collapse M_UNSIGNED + 16

Specifies 16-bit unsigned data.
Collapse M_MODEL_IMAGE_WIDTH +

Inquires the width of the model image.

(summarize)
Collapse M_INVALID

Specifies that the model image buffer has not been set, using MimControl() with M_MODEL_IMAGE.
Collapse Value

Specifies the width, in pixels.
Collapse M_MODEL_STEP +

Inquires whether every pixel or every other pixel in the model image is used when matching the source image to the model image. SET

(summarize)
Collapse 1

Specifies to take every pixel (on both axes) to compute the match.
Collapse 2

Specifies to take every other pixel (on both axes) to compute the match.
Collapse M_SCORE_TYPE +

Inquires how the final correlation score is computed. SET

(summarize)
Collapse M_NORM

Specifies to use normalized grayscale correlation to compute the final match score.
Collapse M_NORM_CLIP

Specifies to clip the results from a normalized grayscale correlation when computing the final correlation score. INFO
Collapse M_NORM_CLIP_SQR

Specifies to clip the results from the square of the normalized grayscale correlation when computing the final correlation score. INFO
Collapse M_SQR_NORM

Specifies to use the square of the normalized grayscale correlation to compute the final correlation score.
Collapse Multiple statistics image processing context
ID +

Specifies a multiple statistics image processing context, allocated using MimAlloc() with M_STAT_MULTIPLE_CONTEXT, and used in MimStatMultiple() operations.

(summarize)
Collapse M_MODE +

Inquires the mode in which to compute results. SET

(summarize)
Collapse M_2D

Specifies to compute statistics on 2-dimensional images with a result for every individual pixel.
Collapse M_SIZE_X +

Inquires the X-size of the target area in the source buffer. This value is used by MimStatMultiple() at preprocessing time if a source buffer is not specified. SET

(summarize)
Collapse Width

Specifies the width of the target area in the source buffer, in pixels.
Collapse M_SIZE_Y +

Inquires the Y-size of the target area in the source buffer. This value is used by MimStatMultiple() at preprocessing time if a source buffer is not specified. SET

(summarize)
Collapse Height

Specifies the height of the target area in the source buffer, in pixels.
Collapse M_TYPE +

Inquires the statistics to be performed on the image in a MimStatMultiple() operation. SET

(summarize)
Collapse M_ALL

Specifies that all statistical operations are performed.
Collapse M_MAX

Specifies the maximum pixel value. INFO
Collapse M_MAX_ABS

Specifies the maximum absolute pixel value. INFO
Collapse M_MEAN

Specifies the mean value of the pixels.
Collapse M_MIN

Specifies the minimum pixel value. INFO
Collapse M_MIN_ABS

Specifies the minimum absolute pixel value. INFO
Collapse M_NUMBER

Specifies the number of images.
Collapse M_STANDARD_DEVIATION

Specifies the standard deviation value.
Collapse M_SUM

Specifies the sum of the pixel values.
Collapse M_SUM_ABS

Specifies the sum of the absolute pixel values.
Collapse M_SUM_OF_SQUARES

Specifies the sum of the squared pixel values.
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_MODE +

Inquires the processing mode. SET

(summarize)
Collapse M_LINES

Specifies that each area to be rearranged is a single horizontal line.
Collapse M_RECTS

Specifies that each area to be rearranged is a single rectangle.
Collapse M_XY_DESTINATION_ARRAY_SIZE +

Inquires the size of the arrays containing the X- and Y-offsets of the areas in the destination image buffer in which to copy the source areas. SET

(summarize)
Collapse Value

Specifies the size of the arrays.
Collapse M_XY_SIZE_ARRAY_SIZE +

Inquires the size of the arrays containing the width and height of the areas to copy. SET

(summarize)
Collapse Value

Specifies the size of the arrays.
Collapse M_XY_SOURCE_ARRAY_SIZE +

Inquires the size of the arrays containing the X- and Y-offsets of the areas to copy from the source image buffer into the destination image buffer. SET

(summarize)
Collapse Value

Specifies the size of the arrays.
Collapse Wavelet image processing context ID +

Specifies a wavelet image processing context, allocated using MimAlloc() with M_WAVELET_TRANSFORM_CONTEXT or M_WAVELET_TRANSFORM_CUSTOM_CONTEXT, and used in MimWaveletTransform() and MimWaveletDenoise() operations. Unless otherwise specified, inquire types apply to both M_WAVELET_TRANSFORM_CONTEXT and M_WAVELET_TRANSFORM_CUSTOM_CONTEXT context types.

(summarize)
Collapse M_FILTER_FORWARD_HIGH_PASS_ID +

Inquires the identifier of the internal buffer containing the values used for the high-pass filter of a forward transformation.

(summarize)
Collapse M_NULL

Specifies that there is no information to inquire about.
Collapse Kernel Buffer ID

Specifies the identifier of the kernel buffer containing the filter values.
Collapse M_FILTER_FORWARD_LOW_PASS_ID +

Inquires the identifier of the internal buffer containing the values used for the low-pass filter of a forward transformation.

(summarize)
Collapse M_NULL

Specifies that there is no information to inquire about.
Collapse Kernel Buffer ID

Specifies the identifier of the kernel buffer containing the filter values.
Collapse M_FILTER_REVERSE_HIGH_PASS_ID +

Inquires the identifier of the internal buffer containing the values used for the high-pass filter of a reverse transformation.

(summarize)
Collapse M_NULL

Specifies that there is no information to inquire about.
Collapse Kernel Buffer ID

Specifies the identifier of the kernel buffer containing the filter values.
Collapse M_FILTER_REVERSE_LOW_PASS_ID +

Inquires the identifier of the internal buffer containing the values used for the low-pass filter of a reverse transformation.

(summarize)
Collapse M_NULL

Specifies that there is no information to inquire about.
Collapse Kernel Buffer ID

Specifies the identifier of the kernel buffer containing the filter values.
Collapse M_TRANSFORMATION_DOMAIN +

Inquires whether the mathematical domain of the filter specified to perform the wavelet transformation consists of complex numbers or only real numbers. Complex numbers have an imaginary part (imaginary numbers), in addition to a real part (real numbers).

(summarize)
Collapse M_COMPLEX

Specifies that the mathematical domain of the filter consists of real and imaginary numbers. Such transformations use a complex type of wavelet filter (MimControl() with M_WAVELET_TYPE), or a custom wavelet filter containing real and imaginary numbers (MimWaveletSetFilter()).

(summarize)
Collapse M_REAL

Specifies that the mathematical domain of the filter consists of only real numbers. Such transformations use a non-complex type of wavelet filter (MimControl() with M_WAVELET_TYPE), or a custom wavelet filter containing real numbers only (MimWaveletSetFilter()).

(summarize)
Collapse M_TRANSFORMATION_MODE +

Inquires the wavelet transformation mode. SET

(summarize)
Collapse M_DEFAULT

Same as M_DYADIC.
Collapse M_DYADIC

Specifies a dyadic wavelet transformation. INFO
Collapse M_UNDECIMATED +

Specifies an undecimated wavelet transformation. INFO
Collapse M_WAVELET_CONTEXT_TYPE +

Inquires the type of wavelet transformation context allocated.

(summarize)
Collapse M_CUSTOM

Specifies that the wavelet context was allocated using M_WAVELET_TRANSFORM_CUSTOM_CONTEXT.
Collapse M_PREDEFINED

Specifies that the wavelet context was allocated using M_WAVELET_TRANSFORM_CONTEXT.
Collapse M_WAVELET_SIZE +

Inquires the size of the wavelet defined in the context. If the context type is M_WAVELET_TRANSFORM_CONTEXT, the size depends on the specified M_WAVELET_TYPE control. If the context type is M_WAVELET_TRANSFORM_CUSTOM_CONTEXT, the size depends on the filters specified with MimWaveletSetFilter().

(summarize)
Collapse Value

Specifies the size of the wavelet.
Collapse M_WAVELET_TYPE +

Inquires the type of wavelet filter used by the wavelet transformation context. This setting is only available for an M_WAVELET_TRANSFORM_CONTEXT context type. SET

(summarize)
Collapse M_DEFAULT

Same as M_HAAR.
Collapse M_CUSTOM

Specifies a custom wavelet filter. This indicates that you are using an M_WAVELET_TRANSFORM_CUSTOM_CONTEXT context type. Custom wavelet filters are set with MimWaveletSetFilter().

(summarize)
Collapse M_DAUBECHIES_1

Specifies a Daubechies wavelet filter that uses 1 vanishing moment and real coefficients.
Collapse M_DAUBECHIES_2

Specifies a Daubechies wavelet filter that uses 2 vanishing moments and real coefficients.
Collapse M_DAUBECHIES_3

Specifies a Daubechies wavelet filter that uses 3 vanishing moments and real coefficients.
Collapse M_DAUBECHIES_3_COMPLEX

Specifies a Daubechies wavelet filter that uses 3 vanishing moments and complex coefficients.
Collapse M_DAUBECHIES_4

Specifies a Daubechies wavelet filter that uses 4 vanishing moments and real coefficients.
Collapse M_DAUBECHIES_5

Specifies a Daubechies wavelet filter that uses 5 vanishing moments and real coefficients.
Collapse M_DAUBECHIES_5_COMPLEX

Specifies a Daubechies wavelet filter that uses 5 vanishing moments and complex coefficients.
Collapse M_DAUBECHIES_6

Specifies a Daubechies wavelet filter that uses 6 vanishing moments and real coefficients.
Collapse M_DAUBECHIES_7

Specifies a Daubechies wavelet filter that uses 7 vanishing moments and real coefficients.
Collapse M_DAUBECHIES_7_COMPLEX

Specifies a Daubechies wavelet filter that uses 7 vanishing moments and complex coefficients.
Collapse M_DAUBECHIES_8

Specifies a Daubechies wavelet filter that uses 8 vanishing moments and real coefficients.
Collapse M_HAAR

Specifies a Haar wavelet filter. INFO
Collapse M_SYMLET_1

Specifies a Symlet wavelet filter that uses 1 vanishing moment and real coefficients.
Collapse M_SYMLET_2

Specifies a Symlet wavelet filter that uses 2 vanishing moments and real coefficients.
Collapse M_SYMLET_3

Specifies a Symlet wavelet filter that uses 3 vanishing moments and real coefficients.
Collapse M_SYMLET_4

Specifies a Symlet wavelet filter that uses 4 vanishing moments and real coefficients.
Collapse M_SYMLET_5

Specifies a Symlet wavelet filter that uses 5 vanishing moments and real coefficients.
Collapse M_SYMLET_6

Specifies a Symlet wavelet filter that uses 6 vanishing moments and real coefficients.
Collapse M_SYMLET_7

Specifies a Symlet wavelet filter that uses 7 vanishing moments and real coefficients.
Collapse M_SYMLET_8

Specifies a Symlet wavelet filter that uses 8 vanishing moments and real coefficients.
Combination constant for M_UNDECIMATED (when ContextOrResultImId=Wavelet image processing context ID, and InquireType=M_TRANSFORMATION_MODE, and UserVarPtr=M_UNDECIMATED).

The following value might be combined with the above-mentioned value to specify undecimated wavelet transformations that are centered.

function map For specifying whether undecimated wavelet transformations are centered
CollapseCombination value Description
Collapse M_CENTER

Specifies undecimated wavelet transformations that are centered. INFO
Combination constants for M_FILTER_FORWARD_HIGH_PASS_ID (when ContextOrResultImId=Wavelet image processing context ID); M_FILTER_FORWARD_LOW_PASS_ID (when ContextOrResultImId=Wavelet image processing context ID); M_FILTER_REVERSE_HIGH_PASS_ID (when ContextOrResultImId=Wavelet image processing context ID); M_FILTER_REVERSE_LOW_PASS_ID (when ContextOrResultImId=Wavelet image processing context ID).

You can add one of the following values to the above-mentioned values to specify which internal buffer to inquire about (real or imaginary numbers).

function map For specifying which internal buffer to inquire about (real or imaginary numbers)
CollapseCombination value Description
Collapse M_IMAGINARY_PART

Inquires about the internal buffer containing the imaginary part of the values used by the wavelet filter.
Collapse M_REAL_PART

Inquires about the internal buffer containing the real part of the values used by the wavelet filter.

This is the default value.

(summarize)

For a specific type of image processing result buffer, the ContextOrResultImId and InquireType parameters can be set to one of the following:

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For inquiring about a specific type of image processing result buffer
CollapseContextOrResultImId Description
InquireType
UserVarPtr
- Possible values returned
Collapse Event list image processing result ID +

Specifies an event list image processing result buffer, allocated using MimAllocResult() with M_EVENT_LIST, and used in MimLocateEvent() operations.

(summarize)
Collapse M_RESULT_OUTPUT_UNITS +

Inquires whether results are returned in pixel or world units. SET

(summarize)
Collapse M_ACCORDING_TO_CALIBRATION

Specifies that results are returned in world units if the result was calculated on an image associated with a calibration context; otherwise, specifies that results are returned in pixel units.
Collapse M_PIXEL

Specifies that results are returned in pixel units, with respect to the pixel coordinate system.
Collapse M_WORLD

Specifies that results are returned in world units, with respect to the relative coordinate system. INFO
Collapse Intensity histogram image processing result
ID +

Specifies an intensity histogram image processing result buffer, allocated using MimAllocResult() with M_HIST_LIST, and used in MimHistogram() operations.

(summarize)
Collapse M_HIST_BIN_SIZE_MODE +

Inquires the number of values each histogram bin can hold. SET

(summarize)
Collapse M_FIT_SRC_DATA

Specifies that MimHistogram() determines the resulting bin size according to the source image's minimum and maximum intensity values, and the total number of bins. INFO
Collapse M_FIT_SRC_RANGE

Specifies that MimHistogram() determines the resulting bin size according to the full range of possible values in the source buffer, and the total number of bins. INFO
Collapse M_FREEDMAN

Specifies that MimHistogram() determines the resulting bin size according to the Freedman–Diaconis rule. INFO
Collapse M_REGULAR

Specifies that each histogram bin can hold 1 value.
Collapse M_HIST_SMOOTHING_ITERATIONS +

Inquires the number of smoothing iterations to perform on the histogram after it has been generated. SET

(summarize)
Collapse Value >= 0

Specifies the number of smoothing iterations. INFO
Collapse Locate peak 1D image processing result ID +

Specifies a 1D locate peak image processing result buffer, allocated using MimAllocResult() with M_LOCATE_PEAK_1D_CONTEXT, and used in MimLocatePeak1d() operations.

(summarize)
Collapse M_SORT_CRITERION +

Inquires the quality with which to sort peaks. SET

(summarize)
Collapse M_PEAK_INTENSITY +

Orders peaks according to their intensity.
Collapse M_PEAK_POSITION +

Orders peaks according to their position.
Combination constants for M_PEAK_INTENSITY (when ContextOrResultImId=Locate peak 1D image processing result ID, and InquireType=M_SORT_CRITERION, and UserVarPtr=M_PEAK_INTENSITY); M_PEAK_POSITION (when ContextOrResultImId=Locate peak 1D image processing result ID, and InquireType=M_SORT_CRITERION, and UserVarPtr=M_PEAK_POSITION).

One of the following values might be combined with the above-mentioned values to specify the order to sort peaks.

function map For specifying the order to sort peaks
CollapseCombination value Description
Collapse M_SORT_DOWN

Sorts peaks in descending order.
Collapse M_SORT_UP

Sorts peaks in ascending order.

You can add one of the following values to the above-mentioned values to cast the requested information to a required data type .

function map For specifying the data type
CollapseContextOrResultImId Description
InquireType
UserVarPtr
- Possible values returned
Collapse M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_TYPE_MIL_ID

Casts the requested information to a MIL_ID. Note that M_TYPE_MIL_ID should only be used with M_OWNER_SYSTEM.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_ID

Collapse M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT

Collapse M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT32

Collapse M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT64

Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information cannot be cast to a MIL_INT, this function will return M_NULL. For inquire types which specify that the UserVarPtr parameter must be set to the address of a MIL_INT64 or MIL_DOUBLE, the return value is M_NULL.
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.
MODIFICATION COUNT OWNER SYSTEM DEFAULT HOST RESULT SIZE RESULT TYPE COUNT LIST EVENT LIST EXTREME LIST FIND ORIENTATION LIST HIST LIST LOCATE PEAK 1D RESULT PROJ LIST STAT LIST STAT MULTIPLE RESULT WAVELET TRANSFORM RESULT CONTEXT TYPE BINARIZE ADAPTIVE CONTEXT BINARIZE ADAPTIVE FROM SEED CONTEXT DEAD PIXEL CONTEXT DEINTERLACE CONTEXT FIND ORIENTATION CONTEXT FLAT FIELD CONTEXT HISTOGRAM EQUALIZE ADAPTIVE CONTEXT LOCATE PEAK 1D CONTEXT MATCH CONTEXT REARRANGE CONTEXT STAT MULTIPLE CONTEXT WAVELET TRANSFORM CONTEXT WAVELET TRANSFORM CUSTOM CONTEXT BINARIZE ADAPTIVE CONTEXT AVERAGE MODE GAUSSIAN UNIFORM FOREGROUND VALUE FOREGROUND BLACK FOREGROUND WHITE GLOBAL MAX GLOBAL MIN GLOBAL MIN GLOBAL MAX GLOBAL OFFSET GLOBAL OFFSET SECOND PASS HYSTERESIS DISABLE ENABLE LOCAL DIMENSION MINIMUM CONTRAST NIBLACK BIAS NIBLACK BIAS SECOND PASS THRESHOLD MODE BERNSEN LOCAL MEAN NIBLACK PSEUDOMEDIAN BINARIZE ADAPTIVE FROM SEED CONTEXT FOREGROUND VALUE FOREGROUND BLACK FOREGROUND WHITE GLOBAL OFFSET NB ITERATIONS TO IDEMPOTENCE NB SEED ITERATIONS THRESHOLD MODE LEVEL RECONSTRUCT TOGGLE DEAD PIXEL CONTEXT DEAD PIXELS IMAGE ATTRIBUTE INVALID DEAD PIXELS IMAGE HEIGHT INVALID DEAD PIXELS IMAGE NB BANDS INVALID DEAD PIXELS IMAGE TYPE INVALID FLOAT SIGNED UNSIGNED DEAD PIXELS IMAGE WIDTH INVALID INTERPOLATION MODE AVERAGE XY DEAD PIXELS ARRAY SIZE DEINTERLACE CONTEXT DEINTERLACE TYPE ADAPTIVE AVERAGE ADAPTIVE BOB ADAPTIVE DISCARD AVERAGE BOB DISCARD DISCARD FIELD EVEN FIELD ODD FIELD FIRST FIELD EVEN FIELD ODD FIELD MOTION DETECT NUM FRAMES MOTION DETECT OUTPUT DISABLE ENABLE MOTION DETECT REFERENCE FRAME CENTER FRAME FIRST FRAME LAST FRAME MOTION DETECT NUM FRAMES MOTION DETECT THRESHOLD SOURCE FIRST IMAGE FIND ORIENTATION CONTEXT BORDER ATTENUATION DISABLE ENABLE FREQUENCY CUTOFF RATIO HIGH FREQUENCY CUTOFF RATIO LOW INTERPOLATION MODE DEFAULT AVERAGE BICUBIC BILINEAR INTERPOLATE MAX MIN NEAREST NEIGHBOR MODE DEFAULT CLIP CENTER RESIZE DOWN RESIZE UP FLAT FIELD CONTEXT DARK CONST INVALID CONST DARK IMAGE HEIGHT INVALID DARK IMAGE NB BANDS INVALID DARK IMAGE TYPE INVALID UNSIGNED 8 UNSIGNED 16 DARK IMAGE WIDTH INVALID EFFECTIVE GAIN CONST INVALID CONST FLAT CONST INVALID CONST FLAT IMAGE HEIGHT INVALID FLAT IMAGE NB BANDS INVALID FLAT IMAGE TYPE INVALID UNSIGNED 8 UNSIGNED 16 FLAT IMAGE WIDTH INVALID GAIN CONST AUTOMATIC INVALID CONST OFFSET CONST INVALID CONST OFFSET IMAGE HEIGHT INVALID OFFSET IMAGE NB BANDS INVALID OFFSET IMAGE TYPE INVALID UNSIGNED 8 UNSIGNED 16 OFFSET IMAGE WIDTH INVALID HISTOGRAM EQUALIZE ADAPTIVE CONTEXT ALPHA VALUE CLIP LIMIT HIST SIZE ACCORDING TO SOURCE NUMBER OF TILES X NUMBER OF TILES Y OPERATION EXPONENTIAL HYPER CUBE ROOT HYPER LOG RAYLEIGH UNIFORM LOCATE PEAK 1D CONTEXT MINIMUM CONTRAST DEFAULT NUMBER OF PEAKS PEAK INTENSITY RANGE DEFAULT PEAK WIDTH DELTA DEFAULT PEAK WIDTH NOMINAL DEFAULT SCAN LANE DIRECTION DEFAULT HORIZONTAL VERTICAL MATCH CONTEXT MASK IMAGE ATTRIBUTE INVALID MASK IMAGE HEIGHT INVALID MASK IMAGE NB BANDS INVALID MASK IMAGE TYPE INVALID FLOAT SIGNED UNSIGNED MASK IMAGE WIDTH INVALID MAX SCORE MAX DEPTH MODE ABS SUM OF DIFFERENCES CORRELATE CORRELATE NORMALIZED MODEL IMAGE ATTRIBUTE INVALID MODEL IMAGE HEIGHT INVALID MODEL IMAGE NB BANDS INVALID MODEL IMAGE TYPE INVALID UNSIGNED 8 UNSIGNED 16 MODEL IMAGE WIDTH INVALID MODEL STEP SCORE TYPE NORM NORM CLIP NORM CLIP SQR SQR NORM STAT MULTIPLE CONTEXT MODE 2D SIZE X SIZE Y TYPE ALL MAX MAX ABS MEAN MIN MIN ABS NUMBER STANDARD DEVIATION SUM SUM ABS SUM OF SQUARES REARRANGE CONTEXT MODE LINES RECTS XY DESTINATION ARRAY SIZE XY SIZE ARRAY SIZE XY SOURCE ARRAY SIZE WAVELET TRANSFORM CONTEXT WAVELET TRANSFORM CUSTOM CONTEXT FILTER FORWARD HIGH PASS ID NULL FILTER FORWARD LOW PASS ID NULL FILTER REVERSE HIGH PASS ID NULL FILTER REVERSE LOW PASS ID NULL TRANSFORMATION DOMAIN COMPLEX REAL TRANSFORMATION MODE DEFAULT DYADIC UNDECIMATED WAVELET CONTEXT TYPE CUSTOM PREDEFINED WAVELET SIZE WAVELET TYPE DEFAULT CUSTOM DAUBECHIES 1 DAUBECHIES 2 DAUBECHIES 3 DAUBECHIES 3 COMPLEX DAUBECHIES 4 DAUBECHIES 5 DAUBECHIES 5 COMPLEX DAUBECHIES 6 DAUBECHIES 7 DAUBECHIES 7 COMPLEX DAUBECHIES 8 HAAR SYMLET 1 SYMLET 2 SYMLET 3 SYMLET 4 SYMLET 5 SYMLET 6 SYMLET 7 SYMLET 8 CENTER IMAGINARY PART REAL PART RESULT OUTPUT UNITS ACCORDING TO CALIBRATION PIXEL WORLD HIST BIN SIZE MODE FIT SRC DATA FIT SRC RANGE FREEDMAN REGULAR HIST SMOOTHING ITERATIONS SORT CRITERION PEAK INTENSITY PEAK POSITION SORT DOWN SORT UP TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 BINARIZE ADAPTIVE CONTEXT BINARIZE ADAPTIVE FROM SEED CONTEXT HISTOGRAM EQUALIZE ADAPTIVE CONTEXT DEAD PIXEL CONTEXT DEINTERLACE CONTEXT FIND ORIENTATION CONTEXT FLAT FIELD CONTEXT LOCATE PEAK 1D CONTEXT MATCH CONTEXT STAT MULTIPLE CONTEXT REARRANGE CONTEXT WAVELET TRANSFORM CONTEXT WAVELET TRANSFORM CUSTOM CONTEXT