Filters
Filter values by
Model Finder object type
  • Shape-specific context
  • Geometric context settings
  • Geometric controlled context settings
  • Result buffer settings
Type of settings
  • General context settings
  • General result buffer settings
  • Model settings
    • Common to all
    • Common to all synthetic models
    • Circle-specific
    • Cross-specific
    • Diamond-specific
    • Ellipse-specific
    • File-type specific
    • Image-type or Edge-type specific
    • Rectangle-specific
    • Ring-specific
    • Segment-specific
    • Square-specific
    • Triangle-specific
| Customize Help
| Save Settings

MmodInquire



Function Map
Synopsis
Inquire information about a specified Model Finder context, a specified model, or a specified result buffer.
Syntax
MIL_INT MmodInquire(
MIL_ID ContextOrResultId, //in
MIL_INT Index, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a specified Model Finder context, the models contained therein, or a specified Model Finder result buffer. Note that Model Finder result buffer values can be obtained with MmodGetResult().

In general, returned values (for example, position and width) are in the following units:

  • For a non-synthetic model, returned values are in the pixel coordinate system, even if the target is calibrated. The only exception is when inquiring about angles (for example, M_REFERENCE_ANGLE); in these cases, the angles values are in the relative coordinate system if the target is calibrated.

  • For a synthetic model in a M_GEOMETRIC or M_GEOMETRIC_CONTROLLED context, returned values are in the user-defined units for the model; their relationship to pixels is defined using MmodControl() with M_PIXEL_SCALE. If the target is not calibrated, M_PIXEL_SCALE is used for the match. If the target is calibrated, model units are used; note that these should be the same as the calibrated units. In a few cases, instead of returning values in model units, values are returned in pixel units (for example, M_POSITION_...); these cases are clearly indicated.

  • For a model in a M_SHAPE_... context, returned values are in model units, which in this case are the same as the target units. If the target is calibrated, the model's settings will be interpreted in world units. If the target is not calibrated, the model's settings will be interpreted in pixel units.

If an inquire type is set to M_DEFAULT, MmodInquire() will return M_DEFAULT. To inquire its default value, add M_DEFAULT to the inquire type.

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
ContextOrResultId

Specifies the Model Finder context or Model Finder result buffer about which to inquire information. The Model Finder context or result buffer must have been previously allocated on the required system using MmodAlloc() or MmodAllocResult(), respectively.

Index

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

function map For specifying a context, model, or result buffer
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default.

If a Model Finder context is specified, this parameter inquires information about model index 0.

If a result buffer is specified, same as M_GENERAL.

(summarize)
Click to summarize M_CONTEXT

Inquires information about the Model Finder context, which has been set using the ContextOrResultId parameter.

Click to summarize M_GENERAL

Inquires general information about the Model Finder result buffer, which has been set using the ContextOrResultId parameter.

Click to summarize 0 <= IndexValue < M_NUMBER_MODELS

Specifies the index of the individual model to inquire, if ContextOrResultId is set to a Model Finder context.

To retrieve the index of a model from its user label, set this parameter to the user label and set the inquire type to M_INDEX_FROM_LABEL.

(summarize)
Click to summarize LabelValue

Specifies the user label of the individual model to inquire, if ContextOrResultId is set to a Model Finder context.

InquireType

Specifies the type of setting 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):
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MmodInquire() 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.

For M_CONTEXT or an individual model specified using its index, the InquireType parameter can be set to one of the following:

function map For inquiring about the number of occurrences to find for the entire context or an individual model specified using its index
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_NUMBER +

Inquires the number of models for which to search.

For M_CONTEXT, this setting returns the maximum number of occurrences of all models to find in the target.

For a model, this setting returns the maximum number of occurrences of the specified model to find in the target. 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 the default value. INFO

Click to summarize M_ALL

Specifies to find all occurrences. INFO

Click to summarize Value > 0

Specifies the number of occurrences. INFO

To inquire about the system on which the Model Finder context or result buffer has been allocated, set the InquireType parameter to the value below.

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

Inquires the identifier of the system on which the Model Finder context or result buffer was 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, previously allocated using MsysAlloc().

For M_CONTEXT, the InquireType parameter can be set to one of the following:

function map For inquiring about the context
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_ACCURACY +

Inquires the search accuracy.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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_MEDIUM.

Click to summarize M_HIGH

Specifies high accuracy.

Click to summarize M_LOW

Specifies low accuracy.

Click to summarize M_MEDIUM

Specifies medium accuracy.

Click to summarize M_ACTIVE_EDGELS +

Inquires the degree to which MIL processes active edgels in the target.

This inquire type is only supported for a geometric Model Finder context (MmodAlloc() with M_GEOMETRIC). 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 the default value; the default value is 100.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies the degree to which MIL processes target edgels, in percent. INFO

Click to summarize M_ASPECT_RATIO +

Inquires the aspect ratio applied to the target before starting the search.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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 the default value; the default value is 1.0.

Click to summarize 0.5 <= Value <= 2.0

Specifies the pixel width/pixel height of the target.

Click to summarize M_CONTEXT_TYPE +

Inquires the type of search context allocated. 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_GEOMETRIC

Specifies that the Model Finder context uses a general geometric search algorithm. INFO

Click to summarize M_GEOMETRIC_CONTROLLED

Specifies that the Model Finder context uses a controlled geometric search algorithm. INFO

Click to summarize M_SHAPE_CIRCLE

Specifies that the Model Finder context uses a circular model search algorithm. INFO

Click to summarize M_SHAPE_ELLIPSE

Specifies that the Model Finder context uses an elliptical model search algorithm. INFO

Click to summarize M_SHAPE_RECTANGLE

Specifies that the Model Finder context uses a rectangular model search algorithm. INFO

Click to summarize M_SHAPE_SEGMENT

Specifies that the Model Finder context uses a segment model search algorithm. INFO

Click to summarize M_DETAIL_LEVEL +

Inquires the level of details to extract from the model source and 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_DEFAULT

Same as M_MEDIUM.

Click to summarize M_HIGH

Specifies a high level of detail.

Click to summarize M_MEDIUM

Specifies a medium level of detail.

Click to summarize M_VERY_HIGH

Specifies a very high level of detail.

Click to summarize M_FIRST_LEVEL +

Inquires the resolution level for the initial stage of the search.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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_AUTO.

Click to summarize M_AUTO

Specifies that the first resolution is determined automatically.

Click to summarize 0 <= Value <= 7

Specifies the resolution level. INFO

Click to summarize M_LAST_LEVEL +

Inquires the resolution level for the final stage of the search.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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_AUTO.

Click to summarize M_AUTO

Specifies that the last resolution is determined automatically.

Click to summarize 0 <= Value <= 7

Specifies the resolution level. INFO

Click to summarize M_MODIFICATION_COUNT +

Inquires the current value of the modification counter. The modification counter is increased by one each time settings for the context are modified.

Although you cannot identify the modification counter's contents, you can compare them throughout your application to know if the context has been altered. If the modification counter has changed you can, for example, prompt the user to save before closing the application.

(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 current value of the modification counter.

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

Specifies the number of models.

Click to summarize M_PREPROCESSED +

Inquires whether the Model Finder context is preprocessed. The context must be preprocessed (using MmodPreprocess()) before calling MmodFind(). After certain settings of the Model Finder context are changed with MmodControl(), or after a model is added or removed with MmodDefine(), 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 that the context is not preprocessed.

Click to summarize M_TRUE

Specifies that the context is preprocessed.

Click to summarize M_SAVE_TARGET_EDGES +

Inquires whether the target edges in the result will be saved. 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_DISABLE.

Click to summarize M_DISABLE

Specifies that target edges cannot be saved.

Click to summarize M_ENABLE

Specifies that target edges can be saved.

Click to summarize M_SEARCH_ANGLE_RANGE +

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

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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 the default value. INFO

Click to summarize M_DISABLE

Specifies that calculations specific to angular-range search strategies are disabled.

Click to summarize M_ENABLE

Specifies that calculations specific to angular-range search strategies are enabled.

Click to summarize M_SEARCH_POSITION_RANGE +

Inquires whether to perform calculations specific to position-range search strategies.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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 calculations specific to position-range search strategies are disabled.

Click to summarize M_ENABLE

Specifies that calculations specific to position-range search strategies are enabled.

Click to summarize M_SEARCH_SCALE_RANGE +

Inquires whether to perform calculations specific to scale-range search strategies.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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_DISABLE.

Click to summarize M_DISABLE

Specifies that calculations specific to scale-range search strategies are disabled.

Click to summarize M_ENABLE

Specifies that calculations specific to scale-range search strategies are enabled. INFO

Click to summarize M_SHARED_EDGES +

Inquires whether multiple occurrences can share edges.

This inquire type is not supported for a model defined in an M_SHAPE_CIRCLE, an M_SHAPE_ELLIPSE, or an M_SHAPE_SEGMENT type of Model Finder context. 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_DISABLE.

Click to summarize M_DISABLE

Specifies to disable the sharing of edges. INFO

Click to summarize M_ENABLE

Specifies to enable the sharing of edges.

Click to summarize M_SMOOTHNESS +

Inquires the degree of smoothness (denoising) applied to the model images and the target images during edge extraction. 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 the default value; the default value is 50.0.

Click to summarize 0.0 <= Value <= 100.0

Specifies the smoothness value applied to the images. INFO

Click to summarize M_SPEED +

Inquires the search speed.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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_MEDIUM.

Click to summarize M_HIGH

Specifies a high speed.

Click to summarize M_LOW

Specifies a low speed.

Click to summarize M_MEDIUM

Specifies a medium speed.

Click to summarize M_VERY_HIGH

Specifies a very high speed.

Click to summarize M_TARGET_CACHING +

Inquires whether target caching is enabled.

This inquire type is not supported for an M_SHAPE_... type of Model Finder context. 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_DISABLE.

Click to summarize M_DISABLE

Specifies to disable target caching. INFO

Click to summarize M_ENABLE

Specifies to enable target caching in the result.

Click to summarize M_TIMEOUT +

Inquires the maximum search time for MmodFind(), in msec. 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 the default value; the default value is 2000.0 msec.

Click to summarize M_DISABLE

Specifies an infinite amount of search time.

Click to summarize Value >= 0.0

Specifies the maximum search time, in msecs.

For inquiring about an individual model specified using its index, the InquireType parameter can be set to one of the following:

function map For inquiring about a model using its index
Click to summarize
InquireType
Description
UserVarPtr
- Possible values returned
Click to summarize M_ACCEPTANCE +

Inquires the acceptance level for the score. 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 the default value; the default value is 60.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies an acceptable score, in percent. INFO

Click to summarize M_ACCEPTANCE_TARGET +

Inquires the acceptance level for the target score.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context. 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 the default value; the default value is 0.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies an acceptable target score, in percent. INFO

Click to summarize M_ALLOC_OFFSET_X +

Inquires the X-offset of the model in the model source image.

This is only supported for image-type or Edge Finder-type models. For a synthetic model, use M_BOX_OFFSET_X instead.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context. 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 X-offset of the model, in pixels.

Click to summarize M_ALLOC_OFFSET_Y +

Inquires the Y-offset of the model in the model source image.

This is only supported for image-type or Edge Finder-type models. For a synthetic model, use M_BOX_OFFSET_Y instead.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context. 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 Y-offset of the model, in pixels.

Click to summarize M_ALLOC_SIGN +

Inquires whether the data range of the model image is signed or unsigned.

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

Specifies that the data is signed.

Click to summarize M_UNSIGNED

Specifies that the data is unsigned. Synthetic, Model Finder-type and merge-type models will always return M_UNSIGNED.

(summarize)
Click to summarize M_ALLOC_SIZE_BAND +

Inquires the number of bands of the model image. When drawing the model image, use M_ALLOC_SIZE_BAND to establish the required number of bands for the destination buffer.

(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 a 1-band buffer.

Click to summarize 3

Specifies a 3-band buffer.

Click to summarize M_ALLOC_SIZE_BIT +

Inquires the depth per band, in bits, of the model 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 per band.

Click to summarize 8

Specifies that the data depth is 8 bits per band.

Click to summarize 16

Specifies that the data depth is 16 bits per band.

Click to summarize 32

Specifies that the data depth is 32 bits per band.

Click to summarize M_ALLOC_SIZE_X +

Inquires the width of the model box.

For a synthetic model, use M_BOX_SIZE_X to get this value in model units. 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 >= 16.0

Specifies the width of the model (in X), in pixels.

Click to summarize M_ALLOC_SIZE_Y +

Inquires the height of the model box.

For a synthetic model, use M_BOX_SIZE_Y to get this value in model units. 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 >= 16.0

Specifies the height of the model (in Y), in pixels.

Click to summarize M_ALLOC_TYPE +

Inquires the data type and depth of the model 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 M_FLOAT + 32

Specifies 32-bit floating-point data.

Click to summarize M_SIGNED + 8

Specifies 8-bit signed data.

Click to summarize M_SIGNED + 16

Specifies 16-bit signed data.

Click to summarize M_SIGNED + 32

Specifies 32-bit signed data.

Click to summarize M_UNSIGNED + 1

Specifies 1-bit unsigned data.

Click to summarize M_UNSIGNED + 8

Specifies 8-bit unsigned data.

Click to summarize M_UNSIGNED + 16

Specifies 16-bit unsigned data.

Click to summarize M_UNSIGNED + 32

Specifies 32-bit unsigned data.

Click to summarize M_ANGLE +

Inquires the nominal search angle; this is the angle at which you expect to find the model's reference axis (specified using M_REFERENCE_ANGLE) in the target.

For an ellipse or rectangle model defined in an M_SHAPE_ELLIPSE or M_SHAPE_RECTANGLE type of Model Finder context, the model's reference axis is, by default, aligned with its principle axis (its width).

This inquire type is not supported for a model defined in an M_SHAPE_CIRCLE type of Model Finder context. 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 the default value; the default value is 0.0 °.

Click to summarize 0.0 <= Value <= 360.0

Specifies the nominal search angle, in degrees. INFO

Click to summarize M_ANGLE_DELTA_NEG +

Inquires the lower limit of the angular range, relative to the nominal search angle.

This inquire type is not supported for a model defined in an M_SHAPE_CIRCLE type of Model Finder context. 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 the default value; the default value is 180.0 °.

Click to summarize 0.0 <= Value <= 180.0

Specifies the lower limit of the angular range, in degrees. INFO

Click to summarize M_ANGLE_DELTA_POS +

Inquires the upper limit of the angular range, relative to the nominal search angle.

This inquire type is not supported for a model defined in an M_SHAPE_CIRCLE type of Model Finder context. 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 the default value; the default value is 180.0 °.

Click to summarize 0.0 <= Value <= 180.0

Specifies the upper limit of the angular range, in degrees. INFO

Click to summarize M_ANGLE_MULTIPLE_RANGE +

Inquires whether to search for models in multiple angular ranges.

This inquire type is only supported for a model in an M_SHAPE_RECTANGLE or M_SHAPE_SEGMENT type of Model Finder context. 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_STEP_180.

Click to summarize M_DISABLE

Specifies that the multiple angle search range is disabled. INFO

Click to summarize M_STEP_90

Specifies to search for models at 90 degree steps from the specified angle. INFO

Click to summarize M_STEP_180

Specifies to search for models at a 180 degree step. INFO

Click to summarize M_ANGLE_REGION +

Sets the angle direction of the search region defined by M_POSITION_... controls.

This control type is only valid for M_SHAPE_... models.

(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 the default value; the default value is 0.0°.

Click to summarize 0.0 <= Value <= 360.0

Specifies the search angle, in degrees.

Click to summarize M_ASSOCIATED_CALIBRATION +

Inquires the camera calibration context associated with the specified model.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context. 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_NULL

Specifies that there is no camera calibration context associated with the model.

Click to summarize MIL Calibration context identifier

Specifies the camera calibration context that is associated with the model.

Click to summarize M_BOX_MARGIN_BOTTOM +

Inquires the margin at the bottom of the bounding box of the model's active edges, in model units.

This inquire type is only valid for synthetic models. If in an M_SHAPE_... type of Model Finder context, this margin is only used for drawing; it does not affect the match. 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 the default value; the default value is 10.0% of the height of the bounding box of the model's active edges.

Click to summarize Value >= 0.0

Specifies the margin, in model units.

Click to summarize M_BOX_MARGIN_LEFT +

Inquires the margin at the left of the bounding box of the model's active edges, in model units.

This inquire type is only valid for synthetic models. If in an M_SHAPE_... type of Model Finder context, this margin is only used for drawing; it does not affect the match. 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 the default value; the default value is 10.0% of the width of the bounding box of the model's active edges.

Click to summarize Value >= 0.0

Specifies the margin, in model units.

Click to summarize M_BOX_MARGIN_RIGHT +

Inquires the margin at the right of the bounding box of the model's active edges, in model units.

This inquire type is only valid for synthetic models. If in an M_SHAPE_... type of Model Finder context, this margin is only used for drawing; it does not affect the match. 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 the default value; the default value is 10.0% of the width of the bounding box of the model's active edges.

Click to summarize Value >= 0.0

Specifies the margin, in model units.

Click to summarize M_BOX_MARGIN_TOP +

Inquires the margin at the top of the bounding box of the model's active edges, in model units.

This inquire type is only valid for synthetic models. If in an M_SHAPE_... type of Model Finder context, this margin is only used for drawing; it does not affect the match. 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 the default value; the default value is 10.0% of the height of the bounding box of the model's active edges.

Click to summarize Value >= 0.0

Specifies the margin, in model units.

Click to summarize M_BOX_OFFSET_X +

Inquires the X-offset of the top-left corner of the model box from the model origin.

For predefined shape models, the origin of the model is the center of the shape. For CAD-file models, the origin is the same as the one defined in the CAD file.

The model box is defined by the bounding box of the model's active edges plus the specified margins. You can inquire the margins using M_BOX_MARGIN_....

M_BOX_OFFSET_X is updated when the margins that define the model box are changed.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(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, in model units.

Click to summarize M_BOX_OFFSET_Y +

Inquires the Y-offset of the top-left corner of the model box from the model origin.

For predefined shape models, the origin of the model is the center of the shape. For CAD-file models, the origin is the same as the one defined in the CAD file.

The model box is defined by the bounding box of the model's active edges plus the specified margins. You can inquire the margins using M_BOX_MARGIN_....

M_BOX_OFFSET_Y is updated when the margins that define the model box are changed.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(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, in model units.

Click to summarize M_BOX_SIZE_X +

Inquires the size along the X-axis of the model box.

The model box is defined by the bounding box of the model's active edges plus the specified margins. You can inquire the margins using M_BOX_MARGIN_....

You cannot set the size of the model box; however, you can set the size of the model's bounding box when defining the model using MmodDefine(). You can also set the size of the margins using MmodControl() with M_BOX_MARGIN_....

This inquire type is only valid for synthetic models.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(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-size, in model units.

Click to summarize M_BOX_SIZE_Y +

Inquires the size along the Y-axis of the model box.

The model box is defined by the bounding box of the model's active edges plus the specified margins. You can inquire the margins using M_BOX_MARGIN_....

You cannot set the size of the model box; however, you can set the size of the model's bounding box when defining the model using MmodDefine(). You can also set the size of the margins using MmodControl() with M_BOX_MARGIN_....

This inquire type is only valid for synthetic models.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(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-size, in model units.

Click to summarize M_CAD_Y_AXIS +

Inquires the direction of the Y-axis for a CAD-type model.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context. 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 the default value. INFO

Click to summarize M_FLIP

Specifies to flip the Y-axis for the model so that the Y-axis is positive going down.

Click to summarize M_NO_FLIP

Specifies not to flip the Y-axis for the model.

Click to summarize M_CERTAINTY +

Inquires the certainty level for the score. 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 the default value; the default value is 90.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies the certainty level for the score, in percent. INFO

Click to summarize M_CERTAINTY_TARGET +

Inquires the certainty level for the target score.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context. 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 the default value; the default value is 0.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies the certainty level for the target score, in percent. INFO

Click to summarize M_CHAIN_ANGLE +

Inquires the angle value of each edgel in the chains composing the model's active edges.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value

Specifies the angle value of the edgel.

Click to summarize M_CHAIN_INDEX +

Inquires the indices which differentiate each active edge's chain of edgels, for each edgel within the model. The first chain is identified as index 1, with each subsequent chain's index incremented by 1.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize Value

Specifies the index of the chain.

Click to summarize M_CHAIN_X +

Inquires the X-coordinates, in pixels (with subpixel accuracy), of each edgel in the chains composing the model's active edges. Coordinates are returned for all the active edge chains contained within the model and are relative to the model origin.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value

Specifies the X-coordinate of the edgel.

Click to summarize M_CHAIN_Y +

Inquires the Y-coordinates, in pixels (with subpixel accuracy), of each edgel in the chains composing the model's active edges. Coordinates are returned for all the active edge chains contained within the model and are relative to the model origin.

This inquire type is not supported for a model defined in an M_SHAPE_... type of Model Finder context.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize Value

Specifies the Y-coordinate of the edgel.

Click to summarize M_CORNER_RADIUS +

Inquires the radius used to round corners of the model.

This is only valid for models of type M_RECTANGLE, M_SQUARE, M_DIAMOND, M_TRIANGLE, and M_CROSS. Attempting to call this value for any other model type will generate an error.

This inquire type is not supported for a model defined in a M_SHAPE_... type of Model Finder result buffer. 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 the default value; the default value is 0.0.

Click to summarize Value >= 0.0

Specifies the radius, in model units. INFO

Click to summarize M_COVERAGE_MAX +

Inquires the maximum expected model coverage.

This inquire type is only supported for a model defined in an M_SHAPE_CIRCLE or M_SHAPE_ELLIPSE type of Model Finder context. 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 the default value; the default value is 100.0.

Click to summarize 0.0 <= Value <= 100.0

Specifies the maximum expected model coverage.

Click to summarize M_COVERAGE_MIN +

Inquires the minimum expected model coverage.

This inquire type is only supported for a model defined in an M_SHAPE_SEGMENT type of Model Finder context. 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 the default value; the default value is 40.0.

Click to summarize 0.0 <= Value <= 100.0

Specifies the minimum expected model coverage.

Click to summarize M_DEVIATION_TOLERANCE +

Inquires the tolerance for finding deformed rectangles or segments, for a model defined in an M_SHAPE_RECTANGLE or M_SHAPE_SEGMENT type of Model Finder context, respectively, given the other specified Model Finder constraints.

This inquire type is only supported for M_RECTANGLE or M_SEGMENT types of models in an M_SHAPE_RECTANGLE or M_SHAPE_SEGMENT type of Model Finder context. 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 the default value; the default value is 25.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies the tolerance as a percentage of the allowable deformation of a rectangle or segment, given the other Model Finder constraints. INFO

Click to summarize M_FIT_ERROR_WEIGHTING_FACTOR +

Inquires the contribution of the fit error in the score and target score calculation. 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 the default value; the default value is 25.0 %.

Click to summarize 0.0 <= Value <= 100.0

Specifies the fit error weighting factor, in percent. INFO

Click to summarize M_FIT_SCORE_MIN +

Inquires the minimum expected occurrence fit score.

This inquire type is only supported for a model defined in an M_SHAPE_... type of Model Finder context. 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 the default value; the default value is 0.0.

Click to summarize 0.0 <= Value <= 100.0

Specifies the minimum expected occurrence fit score.

Click to summarize M_FOREGROUND_VALUE +

Inquires the foreground value of the model. The foreground is the interior of the shape.

This is only valid for predefined shape models. CAD-type models do not have a polarity. For these model types, M_ANY will be returned. SET SET SET SET SET SET 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

Specifies the default value. INFO

Click to summarize M_ANY

Specifies that the model has no specific polarity. INFO

Click to summarize M_FOREGROUND_BLACK

Specifies that black is the foreground color of the model.

Click to summarize M_FOREGROUND_WHITE

Specifies that white is the foreground color of the model.

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_HAS_FLAT_REGIONS_MASK +

Inquires whether the model has an M_FLAT_REGIONS 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_FLAT_REGIONS mask has not been applied to the model.

Click to summarize M_TRUE

Specifies that an M_FLAT_REGIONS mask has been applied to the model.

Click to summarize M_HAS_WEIGHT_REGIONS_MASK +

Inquires whether the model has an M_WEIGHT_REGIONS 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_WEIGHT_REGIONS mask has not been applied to the model.

Click to summarize M_TRUE

Specifies that an M_WEIGHT_REGIONS mask has been applied to the model.

Click to summarize M_HEIGHT +

Inquires the height of the shape in the model.

This is only valid for a model of type M_CROSS, M_DIAMOND, M_ELLIPSE, M_RECTANGLE, and M_TRIANGLE. SET SET SET SET 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 height of the shape, in model units.

Click to summarize M_HORIZONTAL_THICKNESS +

Inquires the horizontal thickness of the cross in the model.

This is only valid for a model of type M_CROSS. 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 horizontal thickness of the cross, in model units.

Click to summarize M_INNER_RADIUS +

Inquires the inner radius of the ring in the model.

This is only valid for a model of type M_RING. 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 inner radius of the ring, in model units.

Click to summarize M_LENGTH +

Inquires the length of the segment in the model.

This is only valid for a model of type M_SEGMENT. 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 length of the segment, in model units.

Click to summarize M_MIN_SEPARATION_ANGLE +

Inquires the minimum angular separation required for two occurrences to be considered distinct matches. This value is an absolute angle value.

This inquire type is not supported for a model defined in an M_SHAPE_CIRCLE type of Model Finder context. 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 the default value; the default value is 10.0 degrees.

Click to summarize M_DISABLE

Disables the minimum angle separation criteria. INFO

Click to summarize 0.0 < Value <= 180.0

Specifies the minimum angular separation required, in degrees. INFO

Click to summarize M_MIN_SEPARATION_ASPECT_RATIO +

Inquires the minimum separation required in aspect ratios, for two occurrences to be considered distinct matches. This value is specified as an aspect ratio factor.

This inquire type is only supported for a model in an M_SHAPE_ELLIPSE or M_SHAPE_RECTANGLE type of Model Finder context. 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 the default value; the default value is 1.1.

Click to summarize M_DISABLE

Specifies to disable the minimum aspect ratio separation criteria. INFO

Click to summarize 1.0 < Value <= 4.0

Specifies the criteria for minimum separation of aspect ratios.

Click to summarize M_MIN_SEPARATION_SCALE +

Inquires the minimum separation required in scale for two occurrences to be considered distinct matches. This value is a scale factor. 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 the default value; the default value is 1.1.

Click to summarize M_DISABLE

Specifies to disable the minimum scale separation criteria. INFO

Click to summarize 1.0 < Value <= 4.0

Specifies the criteria for minimum separation in scale.

Click to summarize M_MIN_SEPARATION_X +

Inquires the minimum separation required along the X-axis for two occurrences to be considered distinct matches. This value is a percentage of the model's width at M_SCALE. 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 the default value; the default value is 10.0 %.

Click to summarize M_DISABLE

Specifies to disable the minimum separation in X criteria. INFO

Click to summarize Value

Specifies the minimum separation as a percentage of the model's width at M_SCALE. INFO

Click to summarize M_MIN_SEPARATION_Y +

Inquires the minimum separation required along the Y-axis for two occurrences to be considered distinct matches. This value is a percentage of the model's height at M_SCALE. 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 the default value; the default value is 10.0 %.

Click to summarize M_DISABLE

Specifies to disable the minimum separation in Y criteria. INFO

Click to summarize