Filters
Filter values by
Pattern Matching object type
  • General context settings
  • Model settings
  • General result buffer settings
Type of Settings
  • Basic settings
  • Advanced settings
| Customize Help
| Save Settings

MpatInquire


Function Map
Syntax
Description
Parameters
- ContextOrResultPatId
- Index
Table: For specifying the index of a model or result buffer
- InquireType
- UserVarPtr
Parameter Associations
Table: For inquiring about the system on which the model or result buffer is allocated
Table: For inquiring about the general settings of the Pattern Matching context
Table: For inquiring about an individual model in a Pattern Matching context
+ combination: Returns whether circular overscan data was extracted with the model
Table: For inquiring about the advanced settings
Table: For inquiring about the result buffer
+ combination: For casting information to the required data type.
Return value
Remarks
Compilation information
Synopsis
Inquire about a setting of a Pattern Matching context, one or all of the search models, or a Pattern Matching result buffer.
Syntax
MIL_INT MpatInquire(
MIL_ID ContextOrResultPatId, //in
MIL_INT Index, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a specified Pattern Matching context, one or all of the search models contained therein, or a specified Pattern Matching result buffer. Most inquire type settings can be controlled using MpatControl(). Note that Pattern Matching result buffer values can be obtained with MpatGetResult().

The position (M_ORIGINAL_X and M_ORIGINAL_Y) can be directly compared with search results (by MpatFind()), to calculate the displacement of target images relative to the model's source image.

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
ContextOrResultPatId

Specifies the Pattern Matching context identifier or Pattern Matching result buffer identifier about which to inquire information. The Pattern Matching context or result buffer must have been previously allocated on the required system using MpatAlloc() or MpatAllocResult(), respectively.

Index

Specifies that information will be inquired about the Pattern Matching context, an individual model, or a Pattern Matching result buffer. This parameter should be set to one of the following values.

function map For specifying the index of a model or result buffer
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default value.

If a Pattern Matching context is specified, this parameter inquires information about model index 0.

If a Pattern Matching result buffer is specified, same as M_GENERAL.

(summarize)
Click to summarize M_CONTEXT

Inquires information about a Pattern Matching context, if one is specified.
Click to summarize M_GENERAL

Inquires information about a Pattern Matching result buffer, if one is specified.
Click to summarize Value >= 0

Inquires information about a model, if a Pattern Matching context is specified. Set the Index parameter to the index of the required model.

(summarize)
InquireType

Specifies the parameter 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 in which to write the requested information. Since the MpatInquire() 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 InquireType parameter and possible values returned to the UserVarPtr parameter.

For the following inquire type, the ContextOrResultPatId can specify a Pattern Matching context or result buffer and the Index parameter must be set to M_CONTEXT or M_GENERAL, respectively.

function map For inquiring about the system on which the model or result buffer is allocated
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_OWNER_SYSTEM +

Inquires the system on which the model or result buffer is allocated. SET SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
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, which you have allocated using the MsysAlloc() function.

The following inquire types and inquire values allows you to inquire about the settings for a Pattern Matching context. For inquiring about general context settings, the Index parameter must be set to M_CONTEXT.

function map For inquiring about the general settings of the Pattern Matching context
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_CONTEXT_TYPE +

Inquires the type of context used.

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

Specifies that all search models within the Pattern Matching context should be normalized.
Click to summarize M_NUMBER_MODELS +

Inquires the number of models in the context.

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

Specifies the number of models.
Click to summarize M_PREPROCESSED +

Inquires whether the Pattern Matching context is preprocessed. The context must be preprocessed (using MpatPreprocess()) before calling MpatFind(). After certain settings of the Pattern Matching context are changed with MpatControl(), or after a model is added or removed with MpatDefine(), this inquire type will indicate that the context is no longer in its preprocessed state.

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

Specifies the context is not preprocessed.
Click to summarize M_TRUE

Specifies the context is preprocessed.
Click to summarize M_SEARCH_MODE +

Inquires the search mode to use when performing an MpatFind() operation. SET

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

Same as M_FIND_ALL_MODELS.
Click to summarize M_FIND_ALL_MODELS

Specifies to search for all the specified models in the target image using their own search settings. INFO
Click to summarize M_FIND_BEST_MODELS

Specifies to search for the best occurrences of any model in the target image, using the search settings from the first model in the Pattern Matching context. INFO

The following inquire types and inquire values allow you to inquire about the settings for an individual model in a Pattern Matching context. For inquiring about the settings of one model, the Index parameter must be set to the model index of a specific model in the Pattern Matching context.

function map For inquiring about an individual model in a Pattern Matching context
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_ACCEPTANCE +

Inquires the acceptance level. 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 <= 100.0

Specifies the acceptance level, as a percentage.
Click to summarize M_ACCURACY +

Inquires the required positional accuracy. Note that the search speed slightly affects the positional accuracy. To inquire the search speed, use M_SPEED. SET

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

Specifies a high accuracy (typically ± 0.05 pixels).
Click to summarize M_LOW

Specifies a low accuracy (typically ± 0.20 pixels). INFO
Click to summarize M_MEDIUM

Specifies a medium accuracy (typically ± 0.10 pixels).
Click to summarize M_ALLOC_OFFSET_X +

Inquires the X-offset of model's top-left corner relative to the top-left corner of the model's source image.

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

Specifies the X-offset, in pixels.
Click to summarize M_ALLOC_OFFSET_Y +

Inquires the Y-offset of model's top-left corner relative to the top-left corner of the model's source image.

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

Specifies the Y-offset, in pixels.
Click to summarize M_ALLOC_SIZE_BIT +

Inquires the depth of the model image. Note that the model image is a single-band image.

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

Specifies that the data depth is 1 bit.
Click to summarize 8

Specifies that the data depth is 8 bits.
Click to summarize 16

Specifies that the data depth is 16 bits.
Click to summarize 32

Specifies that the data depth is 32 bits.
Click to summarize M_ALLOC_SIZE_X +

Inquires the model's width.

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

Specifies the width, in pixels.
Click to summarize M_ALLOC_SIZE_Y +

Inquires the model's height.

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

Specifies the height, in pixels.
Click to summarize M_CERTAINTY +

Inquires the certainty level. 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 <= 100.0

Specifies the certainty level, as a percentage.
Click to summarize M_HAS_DONT_CARE_MASK +

Inquires whether the model has an M_DONT_CARE mask applied to it.

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

Specifies that an M_DONT_CARE mask has not been applied to the model.
Click to summarize M_TRUE

Specifies that an M_DONT_CARE mask has been applied to the model.
Click to summarize M_MODEL_TYPE +

Inquires the type of model used.

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

Defines one or more models from the most-suitable distinct areas found, of the specified dimensions, in the model's source image.
Click to summarize M_REGULAR_MODEL +

Defines a regular search model, using data from the specified area of the model's source image.
Click to summarize M_NUMBER +

Inquires the maximum expected number of occurrences of a search model to find in a target image. SET

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

Specifies to look for all matches that are greater than or equal to the acceptance level.
Click to summarize Value >= 0

Specifies the maximum number of occurrences for which to look in the target image. INFO
Click to summarize M_ORIGINAL_X +

Inquires the X-offset of the model's reference position relative to the top-left corner of the model's source image (takes into account the M_REFERENCE_X setting).

(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 X-offset.
Click to summarize M_ORIGINAL_Y +

Inquires the Y-offset of the model's reference position relative to the top-left corner of the model's source image (takes into account the M_REFERENCE_Y setting).

(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 Y-offset.
Click to summarize M_REFERENCE_X +

Inquires the x-offset of the origin of the model's reference position relative to the model origin. 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

Sets the X-offset of the model's reference position relative to the model origin, in pixels.
Click to summarize M_REFERENCE_Y +

Inquires the y-offset of the origin of the model's reference position relative to the model origin. 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

Sets the Y-offset of the model's reference position relative to the model origin, in pixels.
Click to summarize M_ROTATED_MODEL_MINIMUM_SCORE +

Inquires whether to use angle refinement mode as well as sets the score to use for this 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 M_DEFAULT

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies to disable the angle refinement mode.
Click to summarize 0.0 <= Value <= 100.0

Specifies the minimum score.
Click to summarize M_SEARCH_ANGLE +

Inquires whether search for occurrences of the model at the nominal search angle. 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 nominal search angle, in degrees.
Click to summarize M_SEARCH_ANGLE_ACCURACY +

Inquires the required precision of the nominal angle. 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_DISABLE

Specifies that the angle accuracy equals the tolerance.
Click to summarize 0.0 < Value <= 180.0

Specifies the angle accuracy, in degrees.
Click to summarize M_SEARCH_ANGLE_DELTA_NEG +

Inquires the lower limit for the angular range, relative to the nominal search angle. 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 <= 180.0

Specifies the angle in a clockwise rotation, in degrees.
Click to summarize M_SEARCH_ANGLE_DELTA_POS +

Inquires the upper limit for the angular range, relative to the nominal search angle. 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 <= 180.0

Specifies the angle in a counter-clockwise rotation, in degrees.
Click to summarize M_SEARCH_ANGLE_INTERPOLATION_MODE +

Inquires the type of interpolation to use when rotating the model to perform the search at an angle. SET

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

Specifies bicubic interpolation. INFO
Click to summarize M_BILINEAR

Specifies bilinear interpolation. INFO
Click to summarize M_NEAREST_NEIGHBOR

Specifies nearest neighbor interpolation. INFO
Click to summarize M_SEARCH_ANGLE_MODE +

Inquires whether to perform calculations specific to angular-range search strategies. SET

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

Specifies to disable the angular search mode.
Click to summarize M_ENABLE

Specifies to enable the angular search mode.
Click to summarize M_SEARCH_ANGLE_TOLERANCE +

Inquires the full range of degrees within which the pattern in the target image can be rotated from a model at a specific angle and still meet the acceptance level. 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_AUTO

Specifies that the tolerance will be automatically determined based on an analysis of the model.
Click to summarize 0.0 < Value <= 180.0

Specifies the step angle, in degrees.
Click to summarize M_SEARCH_OFFSET_X +

Inquires the X-offset of the specified model's search region. SET

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

Specifies the X-coordinate, relative to the pixel coordinate system, of where to start the search. INFO
Click to summarize M_SEARCH_OFFSET_Y +

Inquires the Y-offset of the specified model's search region. SET

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

Specifies the Y-coordinate, relative to the pixel coordinate system, of where to start the search. INFO
Click to summarize M_SEARCH_SIZE_X +

Inquires the width of the search region. SET

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

Specifies to use the width of the full image.
Click to summarize Value

Specifies the width, in pixels. INFO
Click to summarize M_SEARCH_SIZE_Y +

Inquires the height of the search region. SET

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

Specifies to use the height of the full image.
Click to summarize Value

Specifies the height, in pixels. INFO
Click to summarize M_SPEED +

Inquires the required search speed when using MpatFind(). SET

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

Specifies a high search speed.
Click to summarize M_LOW

Specifies a low search speed.
Click to summarize M_MEDIUM

Specifies a medium search speed.
Click to summarize M_VERY_HIGH

Specifies a very high search speed.
Click to summarize M_VERY_LOW

Specifies a very low search speed.
Combination value for M_AUTO_MODEL (when InquireType=M_MODEL_TYPE and UserVarPtr=M_AUTO_MODEL); M_REGULAR_MODEL (when InquireType=M_MODEL_TYPE and UserVarPtr=M_REGULAR_MODEL).

The following value might be combined with the above-mentioned values to determine whether circular overscan data was extracted with the model.

function map Returns whether circular overscan data was extracted with the model
Click to summarize
Combination value		 Description
Click to summarize M_CIRCULAR_OVERSCAN

Specifies that the model is extracted from the source image with the circular overscan data. INFO

The following inquire types and inquire values are for advanced users of the Pattern Matching module. If the default settings do not satisfy the requirements of your application, these inquire types and inquire values can be used to fine tune the model's search settings. The default settings typically provide the best results for most search operations. To gain a clearer understanding of how the search algorithm works, see the Pattern matching algorithm (for advanced users) section of Chapter 7: Pattern matching.

For these inquire types, the Index parameter must be set to the model index of a specific model in the Pattern Matching context.

function map For inquiring about the advanced settings
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_COARSE_SEARCH_ACCEPTANCE +

Inquires the coarse search acceptance threshold level to use for rejecting candidate model peaks at low resolution levels. 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_DEFAULT

Specifies to determine the coarse search acceptance threshold level automatically.
Click to summarize 1.0 <= Value <= 100.0

Specifies the coarse search acceptance threshold level.
Click to summarize M_EXTRA_CANDIDATES +

Inquires the number of extra candidates to consider. SET

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

Specifies the number of extra candidates. INFO
Click to summarize M_FAST_FIND +

Inquires whether to use fast peak finding. SET

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

Specifies not to use fast peak finding. INFO
Click to summarize M_ENABLE

Specifies to use fast peak finding. INFO
Click to summarize M_FIRST_LEVEL +

Inquires the resolution level for the initial stage (lowest resolution) of the search. SET

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

Specifies the first level, where MaxLevel is the maximum possible level. INFO
Click to summarize M_LAST_LEVEL +

Inquires the resolution level for the final stage (highest resolution) of the search. SET

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

Specifies the last level, where MaxLevel is the maximum possible level. INFO
Click to summarize M_MAX_INITIAL_PEAKS +

Inquires the maximum number of returned peaks after an initial search at the first level for occurrences of multiple models, or a single model with circular overscan data (that is, M_AUTO_MODEL or M_REGULAR_MODEL with M_CIRCULAR_OVERSCAN). SET

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

Specifies to limit the returned number of peaks for optimal performance.
Click to summarize M_ALL

Specifies all occurrences that pass the model acceptance threshold should be returned. INFO
Click to summarize M_MIN_SEPARATION_X +

Inquires the minimum separation (in X) between two model occurrences in order for them to be considered distinct. SET

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

Specifies the minimum separation.
Click to summarize M_MIN_SEPARATION_Y +

Inquires the minimum separation (in Y) between two model occurrences in order for them to be considered distinct. SET

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

Specifies the minimum separation.
Click to summarize M_MODEL_MAX_LEVEL +

Inquires the maximum search level possible for the model.

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

Specifies the maximum search level possible for the model.
Click to summarize M_MODEL_STEP +

Inquires whether all or every second pixel in the model is used in the correlation during the high resolution stage of the search. SET

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

Specifies to automatically establish the model step.
Click to summarize 1

Specifies to use all model pixels.
Click to summarize 2

Specifies to use every second model pixel (in both the X and Y directions). INFO
Click to summarize M_PROC_FIRST_LEVEL +

Inquires the default resolution level for the initial stage (lowest resolution) of the search.

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

Specifies the lowest resolution level, where MaxLevel is the maximum level. To establish the maximum level, use M_MODEL_MAX_LEVEL.

(summarize)
Click to summarize M_PROC_LAST_LEVEL +

Inquires the highest level for the final stage (highest resolution) of the search.

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

Specifies the lowest resolution level, where MaxLevel is the maximum level. To establish the maximum level, use M_MODEL_MAX_LEVEL.

(summarize)

For a result buffer identifier, the InquireType parameter can be set to one of the values below. For inquiring about the settings of a Pattern Matching result buffer, the Index parameter must be set to M_GENERAL.

function map For inquiring about the result buffer
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_RESULT_OUTPUT_UNITS +

Inquires whether to return results in pixels or world units. SET

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

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

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

Specifies that results are returned in world units, with respect to the relative coordinate system. INFO
Click to summarize M_SAVE_SUMS +

Inquires whether to save the values of the sums used to compute the normalized correlation result for each model occurrence. SET

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

Specifies that the sums are not saved.
Click to summarize M_ENABLE

Specifies that the sums are saved.
Click to summarize M_TARGET_CACHING +

Inquires whether the pyramidal representation of the target buffer is kept in the result buffer or generated each time MpatFind() is called. SET

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

Same as M_ENABLE.
Click to summarize M_DISABLE

Specifies that the pyramidal representation of the target buffer is generated each time MpatFind() is called.
Click to summarize M_ENABLE

Specifies that the pyramidal representation of the target buffer is kept in the result buffer. INFO
Combination values for the values listed in all the parameter association tables.

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

function map For casting information to the required data type.
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

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

Casts the requested information to a MIL_ID.

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

Casts the requested information to a MIL_INT.

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

Casts the requested information to a MIL_INT32.

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

Casts the requested information to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information.
Remark
Compilation information
Header Include mil.h.
Library Use mil.lib; milpat.lib.
DLL Requires mil.dll; milpat.dll.
DEFAULT CONTEXT GENERAL OWNER SYSTEM DEFAULT HOST CONTEXT TYPE NORMALIZED NUMBER MODELS PREPROCESSED FALSE TRUE SEARCH MODE DEFAULT FIND ALL MODELS FIND BEST MODELS ACCEPTANCE ACCURACY HIGH LOW MEDIUM ALLOC OFFSET X ALLOC OFFSET Y ALLOC SIZE BIT ALLOC SIZE X ALLOC SIZE Y CERTAINTY HAS DONT CARE MASK FALSE TRUE MODEL TYPE AUTO MODEL REGULAR MODEL NUMBER ALL ORIGINAL X ORIGINAL Y REFERENCE X REFERENCE Y ROTATED MODEL MINIMUM SCORE DEFAULT DISABLE SEARCH ANGLE SEARCH ANGLE ACCURACY DISABLE SEARCH ANGLE DELTA NEG SEARCH ANGLE DELTA POS SEARCH ANGLE INTERPOLATION MODE BICUBIC BILINEAR NEAREST NEIGHBOR SEARCH ANGLE MODE DISABLE ENABLE SEARCH ANGLE TOLERANCE AUTO SEARCH OFFSET X SEARCH OFFSET Y SEARCH SIZE X ALL SEARCH SIZE Y ALL SPEED HIGH LOW MEDIUM VERY HIGH VERY LOW CIRCULAR OVERSCAN COARSE SEARCH ACCEPTANCE DEFAULT EXTRA CANDIDATES FAST FIND DISABLE ENABLE FIRST LEVEL LAST LEVEL MAX INITIAL PEAKS DEFAULT ALL MIN SEPARATION X MIN SEPARATION Y MODEL MAX LEVEL MODEL STEP DEFAULT PROC FIRST LEVEL PROC LAST LEVEL RESULT OUTPUT UNITS ACCORDING TO CALIBRATION PIXEL WORLD SAVE SUMS DISABLE ENABLE TARGET CACHING DEFAULT DISABLE ENABLE TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 CONTEXT DEFAULT GENERAL DEFAULT FIND ALL MODELS CONTEXT GENERAL ENABLE FIND ALL MODELS