Filters
Filter values by
Image processing operation type
  • Augmentation operation
  • Adaptive binarization operation
  • Adaptive binarization from seed operation
  • Cumulative statistics type operation
  • Adaptive histogram equalization type operation
  • Dead pixel correction operation
  • Deinterlacing operation
  • Event list type operation
  • Find orientation type operation
  • Flat-field operation
  • Intensity histogram operation
  • Linear IIR filter operation
  • Locate peak 1D operation
    • Context
    • Result
  • Match type operation
  • Statistics type operation
  • Rearrangement type operation
  • Wavelet type operation
  • Wavelet custom type operation
Augmentation operation type
  • Affine operations
  • Structure operations
  • Geometric operations
  • Intensity operations
  • Linear filter operations
  • Noise operations
  • General augmentation operations
| Customize Help
| Save Settings

MimInquire



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

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.

function map For inquiring about any image processing result buffer
Click to summarizeContextOrResultImId Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize Image processing result buffer ID

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

(summarize)
Click to summarize M_ALLOCATED_TYPE +

Inquires the image processing result buffer's data type, as was set using MimAllocResult() upon allocation.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_INVALID

Specifies that the image processing result buffer's data-type cannot be determined. Note that any result buffer that does not support allocation with a combination value from the For M_PROJ_LIST, M_EXTREME_LIST, or M_EVENT_LIST to change the type of data to store table will return this value.

(summarize)
Click to summarize M_TYPE_MIL_FLOAT

Specifies that the image processing result buffer was allocated with a MIL_FLOAT data-type.

Click to summarize M_TYPE_MIL_INT

Specifies that the image processing result buffer was allocated with a MIL_INT data-type.

Click to summarize M_MODIFICATION_COUNT +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value >= 0

Specifies the number of modifications.

Click to summarize M_OWNER_SYSTEM +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

Click to summarize MIL system identifier

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

Click to summarize M_RESULT_SIZE +

Inquires the number of entries in the result buffer. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value > 0

Specifies the number of buffer entries. INFO

Click to summarize M_RESULT_TYPE +

Inquires the attribute or nature of the result buffer. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_AUGMENTATION_RESULT

Specifies that the buffer can hold MimAugment() results.

Click to summarize M_COUNT_LIST

Specifies that the buffer can hold MimCountDifference() results.

Click to summarize M_EVENT_LIST

Specifies that the buffer can hold MimLocateEvent() results.

Click to summarize M_EXTREME_LIST

Specifies that the buffer can hold MimFindExtreme() results.

Click to summarize M_FIND_ORIENTATION_LIST

Specifies that the buffer can hold MimFindOrientation() results.

Click to summarize M_HIST_LIST

Specifies that the buffer can hold MimHistogram() results.

Click to summarize M_LOCATE_PEAK_1D_RESULT

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

Click to summarize M_PROJ_LIST

Specifies that the buffer can hold MimProjection() results.

Click to summarize M_STATISTICS_RESULT

Specifies that the buffer can hold MimStatCalculate() results.

Click to summarize 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:

function map For inquiring about any image processing context
Click to summarizeContextOrResultImId Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize Image processing context ID

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

(summarize)
Click to summarize 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)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_AUGMENTATION_CONTEXT

Specifies an image processing context that can be used with MimAugment().

Click to summarize M_BINARIZE_ADAPTIVE_CONTEXT

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

Click to summarize M_BINARIZE_ADAPTIVE_FROM_SEED_CONTEXT

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

Click to summarize M_DEAD_PIXEL_CONTEXT

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

Click to summarize M_DEINTERLACE_CONTEXT

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

Click to summarize M_FIND_ORIENTATION_CONTEXT

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

Click to summarize M_FLAT_FIELD_CONTEXT

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

Click to summarize M_HISTOGRAM_EQUALIZE_ADAPTIVE_CONTEXT

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

Click to summarize M_LINEAR_FILTER_IIR_CONTEXT

Specifies an image processing context that can be used with MimConvolve() or MimDifferential().

Click to summarize M_LOCATE_PEAK_1D_CONTEXT

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

Click to summarize M_MATCH_CONTEXT

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

Click to summarize M_REARRANGE_CONTEXT

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

Click to summarize M_STATISTICS_CONTEXT

Specifies an image processing context that can be used with MimStatCalculate().

Click to summarize M_STATISTICS_CUMULATIVE_CONTEXT

Specifies an image processing context that can be used with MimStatCalculate() when calculating statistics from multiple images.

Click to summarize M_WAVELET_TRANSFORM_CONTEXT

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

Click to summarize 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:

function map For inquiring about a specific type of image processing context
Click to summarize
ContextOrResultImId
Description
InquireType
UserVarPtr
- Possible values returned
Click to summarize Adaptive binarize context ID

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

(summarize)
Click to summarize M_AVERAGE_MODE +

Inquires how MIL establishes average pixel values. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_GAUSSIAN

Specifies a Gaussian type average.

Click to summarize M_UNIFORM

Specifies a uniform type average.

Click to summarize M_FOREGROUND_VALUE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FOREGROUND_BLACK

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

Click to summarize M_FOREGROUND_WHITE

Specifies that the objects to binarize are lighter than the background.

Click to summarize M_GLOBAL_MAX +

Inquires the maximum threshold value. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_UNKNOWN

Specifies that there is no maximum threshold value restriction.

Click to summarize Value

Specifies the maximum threshold value.

Click to summarize M_GLOBAL_MIN +

Inquires the minimum threshold value. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_UNKNOWN

Specifies that there is no minimum threshold value restriction.

Click to summarize Value

Specifies the minimum threshold value.

Click to summarize M_GLOBAL_OFFSET +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the offset.

Click to summarize M_GLOBAL_OFFSET_SECOND_PASS +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the offset.

Click to summarize M_LOCAL_DIMENSION +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value >= 1

Specifies the size of the neighborhood, in pixels. INFO

Click to summarize M_MINIMUM_CONTRAST +

Inquires the minimum contrast between background and foreground pixels. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the minimum contrast.

Click to summarize M_NIBLACK_BIAS +

Inquires the bias for Niblack's binarization mode. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the bias. INFO

Click to summarize M_NIBLACK_BIAS_SECOND_PASS +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value >= 0.0

Specifies the bias.

Click to summarize M_THRESHOLD_MODE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_BERNSEN

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

Click to summarize M_LOCAL_MEAN

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

Click to summarize M_NIBLACK

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

Click to summarize M_PSEUDOMEDIAN

Specifies that threshold values are established using adaptive pseudomedian calculations. INFO

Click to summarize M_THRESHOLD_TYPE +

Inquires the threshold type used for the adaptive binarization. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_HYSTERESIS

Specifies that the adaptive binarization uses a hysteresis process. INFO

Click to summarize M_IN_RANGE

Specifies to use the values inside the range defined by the two passes as the foreground.

Click to summarize M_OUT_RANGE

Specifies to use the values outside the range defined by the two passes as the foreground.

Click to summarize M_SINGLE

Specifies to use a single pass of the specified threshold. INFO

Click to summarize 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)
Click to summarize M_FOREGROUND_VALUE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FOREGROUND_BLACK

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

Click to summarize M_FOREGROUND_WHITE

Specifies that the objects to binarize are lighter than the background.

Click to summarize M_GLOBAL_OFFSET +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize Value

Specifies the offset.

Click to summarize M_NB_ITERATIONS +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_TO_IDEMPOTENCE

Specifies that the threshold process iterates until idempotence is reached. INFO

Click to summarize Value > 0

Specifies the number of iterations. INFO

Click to summarize M_NB_SEED_ITERATIONS +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value > 0

Specifies the number of iterations. INFO

Click to summarize M_THRESHOLD_MODE +

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

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_LEVEL

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

Click to summarize M_RECONSTRUCT

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

Click to summarize M_TOGGLE

Specifies that threshold values are established as one of two possibilities, defined by the seeds. INFO

Click to summarize Augmentation context ID

Specifies an augmentation context, allocated using MimAlloc() with M_AUGMENTATION_CONTEXT, and used in MimAugment() operations.

(summarize)
Click to summarize M_AUG_ASPECT_RATIO_OP +

Inquires whether to enable the aspect ratio operation. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

Specifies to disable M_AUG_ASPECT_RATIO_OP.

Click to summarize M_ENABLE

Specifies to enable M_AUG_ASPECT_RATIO_OP.

Click to summarize M_AUG_ASPECT_RATIO_OP_MAX +

Inquires the maximum aspect ratio to apply for M_AUG_ASPECT_RATIO_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 0.0 <= Value <= 16.0

Specifies the maximum aspect ratio.

Click to summarize M_AUG_ASPECT_RATIO_OP_MIN +

Inquires the minimum aspect ratio to apply for M_AUG_ASPECT_RATIO_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 0.0 <= Value <= 16.0

Specifies the minimum aspect ratio.

Click to summarize M_AUG_ASPECT_RATIO_OP_MODE +

Inquires the aspect ratio mode to apply for M_AUG_ASPECT_RATIO_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_BOTH

Specifies that MIL sets the aspect ration mode. INFO

Click to summarize M_INVERT

Specifies to apply the aspect ratio as height/width. INFO

Click to summarize M_NORMAL

Specifies to apply the aspect ratio as width/height. INFO

Click to summarize M_AUG_BLUR_MOTION_OP +

Inquires whether to enable the operation that applies a motion blur kernel with random direction and kernel size. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

Specifies to disable M_AUG_BLUR_MOTION_OP.

Click to summarize M_ENABLE

Specifies to enable M_AUG_BLUR_MOTION_OP.

Click to summarize M_AUG_BLUR_MOTION_OP_ANGLE_MAX +

Inquires the maximum value for the motion blur angle's random distribution [min, max], to apply for M_AUG_BLUR_MOTION_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 0.0 <= Value <= 360.0

Specifies the maximum value for the motion blur angle's random distribution [min, max].

Click to summarize M_AUG_BLUR_MOTION_OP_ANGLE_MIN +

Inquires the minimum value for the motion blur angle's random distribution [min, max], to apply for M_AUG_BLUR_MOTION_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 0.0 <= Value <= 360.0

Specifies the minimum value for the motion blur angle's random distribution [min, max].

Click to summarize M_AUG_BLUR_MOTION_OP_SIZE_MAX +

Inquires the maximum value for the kernel size's random distribution [min, max], to apply for M_AUG_BLUR_MOTION_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 5.0 <= Value <= 15.0

Specifies the maximum value for the kernel size's random distribution.

Click to summarize M_AUG_BLUR_MOTION_OP_SIZE_MIN +

Inquires the minimum value for the kernel size's random distribution [min, max], to apply for M_AUG_BLUR_MOTION_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 5.0 <= Value <= 15.0

Specifies the min value for the kernel size's random distribution.

Click to summarize M_AUG_CROP_OP +

Inquires whether to enable the crop operation. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

Specifies to disable M_AUG_CROP_OP.

Click to summarize M_ENABLE

Specifies to enable M_AUG_CROP_OP.

Click to summarize M_AUG_CROP_OP_FACTOR_X +

Inquires the crop width factor, to apply for M_AUG_CROP_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 0.0 <= Value <= 1.0

Specifies the width factor.

Click to summarize M_AUG_CROP_OP_FACTOR_Y +

Inquires the crop height factor, to apply for M_AUG_CROP_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize 0.0 <= Value <= 1.0

Specifies the height factor.

Click to summarize M_AUG_CROP_OP_RESIZE +

Inquires the crop rese option, to apply for M_AUG_CROP_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_FALSE

Specifies to not resize.

Click to summarize M_TRUE

Specifies to resize the crop dimensions according to the destination buffer size (MimAugment()).

Click to summarize M_AUG_DILATION_ASYM_OP +

Inquires whether to enable the asymmetrical dilation operation. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

Specifies to disable M_AUG_DILATION_ASYM_OP.

Click to summarize M_ENABLE

Specifies to enable M_AUG_DILATION_ASYM_OP.

Click to summarize M_AUG_DILATION_ASYM_OP_NB_ITERATIONS_MAX +

Inquires the maximum number of iterations for dilation, to apply for M_AUG_DILATION_ASYM_OP. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize Value >= 0

Specifies the maximum number of iterations.

Click to summarize M_AUG_DILATION_OP +

Inquires whether the dilation operation was enabled. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_DISABLE

Specifies to disable M_AUG_DILATION_OP.

Click to summarize M_ENABLE

Specifies to enable M_AUG_DILATION_OP.

Click to summarize