Filters
Filter values by
Registration object types
  • Registration correlation-stitching context
  • Registration correlation-stitching result buffer
  • Registration extended depth of field context
  • Registration depth-from-focus context
  • Registration photometric stereo context
  • Registration photometric stereo result
  • Registration HDR context
  • Registration HDR result buffer
| Customize Help
| Save Settings

MregInquire


Function Map
Syntax
Description
Parameters
- ContextOrResultId
- Index
Table: For specifying a registration context, registration element, or registration result buffer
- InquireType
- UserVarPtr
Parameter Associations
Table: For inquiring general settings of a registration context or result buffer
Table: For inquiring correlation context settings
Table: For registration elements of correlation-stitching contexts and correlation-stitching result buffers
Table: For correlation-stitching result buffers
Table: For operation settings of M_PHOTOMETRIC_STEREO registration contexts
Table: For operation settings of M_PHOTOMETRIC_STEREO registration result buffers
Table: For registration settings of an M_PHOTOMETRIC_STEREO registration context
Table: For M_EXTENDED_DEPTH_OF_FIELD contexts
Table: For M_DEPTH_FROM_FOCUS contexts
Table: For inquiring about the operation settings of an M_HIGH_DYNAMIC_RANGE registration context
+ combination: For specifying a threshold condition
Table: For inquiring the timeout value for any registration context
+ combination: For specifying the data type
Return value
Compilation information
Synopsis
Inquire about a registration context, registration element, or registration result buffer setting.
Syntax
MIL_INT MregInquire(
MIL_ID ContextOrResultId, //in
MIL_INT Index, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function allows you to inquire about the settings of a registration context itself, one (or all) of the registration elements contained therein (for correlation-stitching or photometric stereo registration contexts), or a registration result buffer.

Note that for a registration result buffer, this function only retrieves information about result buffer settings (set using MregAllocResult() or MregControl()). To retrieve results from the registration result buffer, use MregGetResult().

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 identifier of the registration context or registration result buffer about which to inquire. The registration context must have been previously allocated on the required system using MregAlloc(). The registration result buffer must have been previously allocated on the required system using MregAllocResult().

Index

Specifies that a registration context, an individual registration element (of a correlation-stitching or photometric stereo registration context), or a registration result buffer is inquired. Set this parameter to one of the following values:

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

Specifies the default value.

If an M_STITCHING registration context is specified, this parameter inquires information about registration element 0.

If an M_EXTENDED_DEPTH_OF_FIELD, M_DEPTH_FROM_FOCUS, M_HIGH_DYNAMIC_RANGE, or M_PHOTOMETRIC_STEREO registration context is specified, same as M_CONTEXT.

If a registration result buffer is specified, same as M_GENERAL.

(summarize)
Click to summarize M_CONTEXT

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

Inquires general information about the registration result buffer, if one is specified.
Click to summarize 0 < Value < M_NUMBER_OF_REGISTRATION_ELEMENTS

Inquires information about a registration element, if you specify a correlation-stitching or a photometric stereo registration context. Set the Index parameter to the index of the required registration element.

Note that this parameter is only available for M_STITCHING or M_PHOTOMETRIC_STEREO registration contexts.

(summarize)
InquireType

Specifies the 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):
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MregInquire() 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 types, the ContextOrResultId parameter must specify a registration context or result buffer. The Index parameter must be set to M_CONTEXT or M_GENERAL, for a registration context or result buffer respectively.

function map For inquiring general settings of a registration context or result buffer
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_NUMBER_OF_REGISTRATION_ELEMENTS +

Inquires the number of registration elements in the registration context or the number of registration result elements in the result buffer.

Note that this inquire is only available for an M_STITCHING or M_PHOTOMETRIC_STEREO registration context, or a M_STITCHING_RESULT or M_PHOTOMETRIC_STEREO_RESULT 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. INFO
Click to summarize 2 <= Value < 8192

Specifies the number of registration elements for a correlation-stitching registration context.
Click to summarize Value > 3

Specifies the number of registration elements for a photometric stereo registration context.
Click to summarize M_OWNER_SYSTEM +

Inquires the identifier of the system on which the specified registration context or registration 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 the following inquire types, the ContextOrResultId parameter must specify an M_STITCHING registration context. In this case, the Index parameter must be set to M_CONTEXT.

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

Inquires the accuracy of the registration 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

Same as M_HIGH.
Click to summarize M_HIGH

Specifies high accuracy. INFO
Click to summarize M_LOW

Specifies low accuracy. INFO
Click to summarize M_LOCATION_DELTA +

Inquires the maximum displacement that will be applied to any pixel in the image during registration, relative to its initial location. 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 5 %.
Click to summarize 0.0 < Value <= 100.0

Specifies the maximum displacement as a percentage. INFO
Click to summarize M_MIN_OVERLAP +

Inquires the minimum overlap that should exist between an image and its reference image so that the registration calculation can optimize the match in their overlapping region. 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 20.0 %.
Click to summarize 0.0 < Value <= 100.0

Specifies the minimum overlap as a percentage. INFO
Click to summarize M_SCORE_TYPE +

Inquires the type of score calculated during registration. This calculated score can be retrieved after registration using MregGetResult() with M_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_CORRELATION

Specifies to calculate the score based on the normalized grayscale correlation in the overlapped region.
Click to summarize M_NONE

Specifies that no score is calculated; it is set to 100%.
Click to summarize M_TRANSFORMATION_TYPE +

Inquires the type of transformation that the registration calculation will use to optimize the match in the images' overlapping regions. 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_TRANSLATION.
Click to summarize M_PERSPECTIVE

Specifies that a perspective warping can be performed to optimize the match in the overlapping regions.
Click to summarize M_TRANSLATION

Specifies that a translation can be performed to optimize the match in the overlapping regions.
Click to summarize M_TRANSLATION_ROTATION

Specifies that a translation and a rotation can be performed to optimize the match in the overlapping regions.
Click to summarize M_TRANSLATION_ROTATION_SCALE

Specifies that a translation, a rotation, and a scale operation can be performed to optimize the match in the overlapping regions.

For the following inquire types, the ContextOrResultId parameter must specify an M_STITCHING registration context or a M_STITCHING_RESULT registration result buffer. In this case the Index parameter must be set to a specific element of the registration context or registration result buffer.

function map For registration elements of correlation-stitching contexts and correlation-stitching result buffers
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_OPTIMIZE_LOCATION +

Inquires whether the optimization step of the registration calculation will be performed. 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_ENABLE.
Click to summarize M_DISABLE

Specifies not to perform the optimization calculation.
Click to summarize M_ENABLE

Specifies to perform the optimization calculation.
Click to summarize M_REFERENCE_X +

Inquires the X-coordinate of the origin of the image's pixel coordinate system. 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 that the default X-coordinate of the origin will be used. INFO
Click to summarize M_CENTER_ELEMENT

Specifies the X-coordinate of the origin to be at the center of the image.
Click to summarize Value

Specifies the X-coordinate of the origin, in pixels. INFO
Click to summarize M_REFERENCE_Y +

Inquires the Y-coordinate of the origin of the image's pixel coordinate system. 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 that the default Y-coordinate of the origin will be used. INFO
Click to summarize M_CENTER_ELEMENT

Specifies the Y-coordinate of the origin to be at the center of the image.
Click to summarize Value

Specifies the Y-coordinate of the origin, in pixels. INFO
Click to summarize M_SET_LOCATION_PARAM_1 +

Inquires the first attribute of the transformation used to set the rough location of the registration element's image. If the first attribute was set to a MIL identifier, this identifier cannot be returned; M_NULL is returned instead. This is the case when the rough location was set using MregSetLocation() with, for example, M_COPY_REG_CONTEXT or M_COPY_REG_RESULT. 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_NULL

Specifies that the first attribute was set to a MIL identifier.
Click to summarize Value

Specifies the X-coordinate.
Click to summarize M_SET_LOCATION_PARAM_2 +

Inquires the second attribute of the transformation used to set the rough location of the registration element's image. 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 index. INFO
Click to summarize 0 <= Value < Number of source elements

This value can have multiple meanings, as indicated below.

(summarize)

Specifies the registration element's index.

Specifies the registration result element's index.
Click to summarize Value

Specifies the Y-coordinate.
Click to summarize M_SET_LOCATION_PARAM_3 +

Inquires the third attribute of the transformation used to set the rough location of the registration element's image. 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 that the target registration result element's index is the same as the one that is specified in the Target parameter.
Click to summarize M_REGISTRATION_GLOBAL

Specifies that the target registration result element's reference is the global pixel coordinate system.
Click to summarize 0.0 <= Value <= 360.0

Specifies the angle of the image in its reference coordinate system.
Click to summarize Value >= 0

Specifies the target registration result element's index.
Click to summarize M_SET_LOCATION_PARAM_TYPE +

Inquires the type of transformation used to set the rough location of the registration element's image. 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_COPY_REG_CONTEXT

Specifies that the rough locations are copied from another registration context.
Click to summarize M_COPY_REG_RESULT

Specifies that the transformation between two registration result elements is copied.
Click to summarize M_POSITION_XY

Specifies the coordinates of the origin of the registration element's image in the coordinate system of its reference. INFO
Click to summarize M_POSITION_XY_ANGLE

Specifies the coordinates of the origin and the angle of the registration element's image in the coordinate system of its reference. INFO
Click to summarize M_WARP_4_CORNER

Specifies the transformation that transforms an arbitrary quadrilateral in the current image's pixel coordinate system into a rectangle in its reference coordinate system. INFO
Click to summarize M_WARP_4_CORNER_REVERSE

Specifies the transformation that transforms a rectangle in the current image's pixel coordinate system into an arbitrary quadrilateral in its reference coordinate system. INFO
Click to summarize M_WARP_POLYNOMIAL

Specifies the transformation matrix that transforms points in the reference coordinate system into points in the current image's pixel coordinate system.
Click to summarize M_SET_LOCATION_TARGET +

Inquires the reference of the registration element's image. 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_PREVIOUS.
Click to summarize M_NEXT

Specifies the reference to be the image associated with the registration element whose index follows the specified registration element's index. INFO
Click to summarize M_PREVIOUS

Specifies the reference to be the image associated with the registration element whose index precedes the specified registration element's index. INFO
Click to summarize M_REGISTRATION_GLOBAL

Specifies that the reference is the global pixel coordinate system.
Click to summarize 0 <= Value < Number of source elements

Specifies the index of the registration element of the reference image.

For the following inquire types, the ContextOrResultId parameter must specify an M_STITCHING_RESULT result buffer. In this case, the Index parameter must be set to M_GENERAL.

function map For correlation-stitching result buffers
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_MOSAIC_COMPOSITION +

Inquires which image's pixel values to use when composing the mosaic and two or more images overlap. 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_LAST_IMAGE.
Click to summarize M_AVERAGE_IMAGE

Specifies to use the average value of the images' pixels in the overlapping region.
Click to summarize M_FIRST_IMAGE

Specifies to use the pixels of the image associated with the registration result element with the lowest index.
Click to summarize M_FUSION_IMAGE

Specifies to fuse the images by progressively blending overlapping pixels. INFO
Click to summarize M_LAST_IMAGE

Specifies to use the pixels of the image associated with the registration result element with the highest index.
Click to summarize M_SUPER_RESOLUTION

Specifies to use a super-resolution algorithm to create the mosaic. INFO
Click to summarize M_MOSAIC_OFFSET_X +

Inquires the X-offset between the origin of the coordinate system used to compose the mosaic and the left side of the destination image 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

Same as M_ALIGN_LEFT.
Click to summarize M_ALIGN_LEFT

Specifies that the X-offset (in pixels) will be calculated such that the left-most part of the mosaic will be aligned with the left side of the destination image buffer.
Click to summarize Value

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

Inquires the Y-offset between the origin of the coordinate system used to compose the mosaic and the top of the destination image 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

Same as M_ALIGN_TOP.
Click to summarize M_ALIGN_TOP

Specifies that the Y-offset (in pixels) will be calculated such that the top-most part of the mosaic will be aligned with the top of the destination image buffer.
Click to summarize Value

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

Inquires the scaling factor used on images while creating the mosaic. 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 <= 10.0

Specifies the scale factor.
Click to summarize M_MOSAIC_STATIC_INDEX +

Inquires the element whose coordinate system is used when generating the mosaic. If the coordinate system of one of the images is used, the index of its corresponding registration element is returned. If the coordinate system which minimizes changes to the images or the global pixel coordinate system is used, M_ALL or M_REGISTRATION_GLOBAL will be returned, respectively. 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. INFO
Click to summarize M_ALL

Specifies that the coordinate system will be chosen such that the minimum change is done on all images during the mosaic composition. INFO
Click to summarize M_REGISTRATION_GLOBAL

Specifies that the mosaic will be composed with respect to the global pixel coordinate system.
Click to summarize 0 <= Value < NumberOfElements

Specifies the index of the registration result element whose image's pixel coordinate system will be used as the reference coordinate system.
Click to summarize M_SR_PSF_RADIUS +

Inquires the radius of the M_CIRCULAR or M_GAUSSIAN point-spread functions (PSF). For M_GAUSSIAN, the radius corresponds to the standard deviation. 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.5 pixels.
Click to summarize Value >= 0.0

Specifies the radius of the PSF, in pixel units at the scale of the source images.
Click to summarize M_SR_PSF_TYPE +

Inquires the type of point-spread function (PSF) to use during super-resolution calculations to model the blurring in source images. 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_GAUSSIAN.
Click to summarize M_CIRCULAR

Specifies to assume a PSF that models blurring of single points of light into uniform circles in the image.
Click to summarize M_DISABLE

Specifies that no PSF should be assumed during super-resolution calculations.
Click to summarize M_GAUSSIAN

Specifies to assume a PSF that models blurring of single points of light into radially symmetric gaussian functions in the image.
Click to summarize M_SQUARE

Specifies to assume a PSF that models blurring of single points of light into symmetric square functions in the image.
Click to summarize M_SR_SMOOTHNESS +

Inquires the smoothness value used during super-resolution calculations. 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.

For the following inquire types, the ContextOrResultId parameter must specify an M_PHOTOMETRIC_STEREO_RESULT result buffer. In this case, the Index parameter must be set to M_CONTEXT.

function map For operation settings of M_PHOTOMETRIC_STEREO registration contexts
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_DRAW_WITH_NO_RESULT +

Inquires the type of image to draw when using MregCalculate() with RegResultOrImageId set to an image 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

Same as M_DRAW_ALBEDO_IMAGE.
Click to summarize M_DRAW_ALBEDO_IMAGE

Specifies to draw the albedo image into the image buffer when using MregCalculate() with RegResultOrImageId set to an image buffer. INFO
Click to summarize M_DRAW_GAUSSIAN_CURVATURE_IMAGE

Specifies to draw the Gaussian curvature image into the image buffer when using MregCalculate() with RegResultOrImageId set to an image buffer. INFO
Click to summarize M_DRAW_LOCAL_CONTRAST_IMAGE

Specifies to draw the local contrast image into the image buffer when using MregCalculate() with RegResultOrImageId set to an image buffer. INFO
Click to summarize M_DRAW_LOCAL_SHAPE_IMAGE

Specifies to draw the local shape image into the image buffer when using MregCalculate() with RegResultOrImageId set to an image buffer. INFO
Click to summarize M_DRAW_MEAN_CURVATURE_IMAGE

Specifies to draw the mean curvature image into the image buffer when using MregCalculate() with RegResultOrImageId set to an image buffer. INFO
Click to summarize M_DRAW_TEXTURE_IMAGE

Specifies to draw the texture image into the image buffer when using MregCalculate() with RegResultOrImageId set to an image buffer. INFO
Click to summarize M_GAUSSIAN_CURVATURE +

Inquires whether the Gaussian curvature image is computed when using MregCalculate() with RegResultOrImageId set to a 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

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies not to compute the Gaussian curvature image. INFO
Click to summarize M_ENABLE

Specifies to compute the Gaussian curvature image.
Click to summarize M_LOCAL_CONTRAST +

Inquires whether to compute the local contrast image when using MregCalculate() with RegResultOrImageId set to a 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

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies not to compute the local contrast image. INFO
Click to summarize M_ENABLE

Specifies to compute the local contrast image.
Click to summarize M_LOCAL_SHAPE +

Inquires whether to compute the local shape image when using MregCalculate() with RegResultOrImageId set to a 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

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies not to compute the local shape image. INFO
Click to summarize M_ENABLE

Specifies to compute the local shape image.
Click to summarize M_MEAN_CURVATURE +

Inquires whether the mean curvature image is computed when using MregCalculate() with RegResultOrImageId set to a 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

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies not to compute the mean curvature image. INFO
Click to summarize M_ENABLE

Specifies to compute the mean curvature image.
Click to summarize M_NON_UNIFORMITY_CORRECTION +

Inquires whether to compute a correction for non-uniform illumination on the input image. 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_AUTO

Specifies to compute a correction for non-uniform illumination on the input image. INFO
Click to summarize M_DISABLE

Specifies not to compute a correction for non-uniform illumination on the input image.
Click to summarize M_OBJECT_SIZE +

Inquires the number of iterations to perform when M_LOCAL_CONTRAST or M_DRAW_LOCAL_CONTRAST_IMAGE is enabled. 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.
Click to summarize Value >= 0

Specifies the number of iterations of morphological operations to perform. INFO
Click to summarize M_SHAPE_NORMALIZATION +

Inquires whether shape normalization is performed when computing a local shape image (M_LOCAL_SHAPE or M_DRAW_WITH_NO_RESULT set to M_DRAW_LOCAL_SHAPE_IMAGE). 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_ENABLE.
Click to summarize M_DISABLE

Specifies not to normalize the shape information during local shape computation.
Click to summarize M_ENABLE

Specifies to normalize the shape information during local shape computation.
Click to summarize M_TEXTURE_IMAGE +

Inquires whether to compute the texture image when using MregCalculate() with RegResultOrImageId set to a 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

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies not to compute the texture image. INFO
Click to summarize M_ENABLE

Specifies to compute the texture image.

For the following inquire types, the ContextOrResultId parameter must specify an M_PHOTOMETRIC_STEREO_RESULT result buffer. In this case, the Index parameter must be set to M_GENERAL.

function map For operation settings of M_PHOTOMETRIC_STEREO registration result buffers
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_DRAW_REMAP_FACTOR_MODE

Inquires whether to automatically calculate the remap factor, or to use a user-defined value. The remap factor is the factor needed to remap the result of an M_DRAW_GAUSSIAN_CURVATURE_IMAGE, M_DRAW_LOCAL_SHAPE_IMAGE, or M_DRAW_MEAN_CURVATURE_IMAGE operation when the destination is not a 32-bit floating-point image 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_DEFAULT

Same as M_AUTO.
Click to summarize M_AUTO

Specifies to automatically calculate the remap factor so that the entire range of the drawn image is represented.
Click to summarize M_USER_DEFINED

Specifies to use the remap factor set with M_DRAW_REMAP_FACTOR_VALUE.
Click to summarize M_DRAW_REMAP_FACTOR_VALUE

Inquires the remap factor value when M_DRAW_REMAP_FACTOR_MODE is set to M_USER_DEFINED and the destination is not a 32-bit floating-point image 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 1.0.
Click to summarize Value > 0.0

Specifies the remap factor.

For the following inquire types, the ContextOrResultId parameter must specify an M_PHOTOMETRIC_STEREO_RESULT result buffer. In this case, the Index parameter must be set to M_CONTEXT or a specific value.

function map For registration settings of an M_PHOTOMETRIC_STEREO registration context
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_LIGHT_VECTOR_COMPONENT_1 +

Inquires the first component of the light vector. When M_LIGHT_VECTOR_TYPE is set to M_SPHERICAL, this component is the polar (zenith) angle. When M_LIGHT_VECTOR_TYPE is set to M_CARTESIAN, this component is the vector's X-coordinate. 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 0.0 <= Value <= 90.0

Specifies the polar (zenith) angle, in degrees, if the light mode is set to the spherical coordinate system. INFO
Click to summarize Value

Specifies the X-coordinate of the light vector, if the light mode is set to the Cartesian coordinate system. INFO
Click to summarize M_LIGHT_VECTOR_COMPONENT_2 +

Inquires the second component of the light vector.

When M_LIGHT_VECTOR_TYPE is set to M_SPHERICAL, this component is the azimuth angle. When M_LIGHT_VECTOR_TYPE is set to M_CARTESIAN, this component is the vector's Y-coordinate. 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 0.0 <= Value <= 360.0

Specifies the azimuth angle, in degrees, if the light mode is set to the spherical coordinate system. INFO
Click to summarize Value

Specifies the Y-coordinate of the light vector, if the light mode is set to the Cartesian coordinate system. INFO
Click to summarize M_LIGHT_VECTOR_COMPONENT_3 +

Inquires the third component of the light vector.

When M_LIGHT_VECTOR_TYPE is set to M_SPHERICAL, this component is the relative intensity of the light source.

When M_LIGHT_VECTOR_TYPE is set to M_CARTESIAN, this component is the vector's Z-coordinate. 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.0

Specifies the value of the third component.
Click to summarize M_LIGHT_VECTOR_TYPE +

Inquires the coordinate system in which the input light vector is represented. 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_SPHERICAL.
Click to summarize M_CARTESIAN

Specifies that the light vector is defined in the Cartesian coordinate system. INFO
Click to summarize M_SPHERICAL

Specifies that the light vector is defined in the spherical coordinate system. INFO

For the following inquire types, the ContextOrResultId parameter must specify an M_EXTENDED_DEPTH_OF_FIELD registration context. In this case, the Index parameter must be set to M_CONTEXT.

function map For M_EXTENDED_DEPTH_OF_FIELD contexts
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_CIRCLE_OF_CONFUSION_RADIUS_MAX +

Inquires the radius of the maximum circle of confusion (blurring circle), among the input images. 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 8 pixels.
Click to summarize 1 <= Value <= 256

Specifies the maximum radius of the circle of confusion (blurring circle) in pixels.
Click to summarize M_MODE +

Inquires the computation mode of the registration operation. 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_RECONSTRUCTION.
Click to summarize M_FAST

Specifies a faster computation mode. INFO
Click to summarize M_RECONSTRUCTION

Specifies a computation mode that favors the quality of the extended depth of field (EDoF) image. INFO
Click to summarize M_TRANSLATION_TOLERANCE +

Inquires the maximum distance between a point of an object that is in focus in one image, and the same point in an image in which the object is out of focus, in pixels, among the input images. 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 pixel.
Click to summarize 1 <= Value <= 4

Specifies the maximum translation distance of a point between two images, in pixels.

For the following inquire types, the ContextOrResultId parameter must specify an M_DEPTH_FROM_FOCUS registration context. In this case, the Index parameter must be set to M_CONTEXT.

function map For M_DEPTH_FROM_FOCUS contexts
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_ADAPTIVE_INTENSITY_DELTA +

Inquires the adaptive intensity delta. The adaptive intensity delta is the difference between the maximum and minimum intensity values for an object in an image. 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 Value > 0.0

Specifies the maximum difference of intensities.
Click to summarize M_ADAPTIVE_SMOOTHING +

Inquires the size of the neighborhood on which to apply the adaptive smoothing. 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 3.0 pixels.
Click to summarize Value > 0.0

Specifies a distance, in pixels, from the pixel being evaluated. INFO
Click to summarize M_CONFIDENCE_MAP +

Inquires whether the confidence map is computed. 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 that the confidence map is not computed.
Click to summarize M_ENABLE

Specifies that the confidence map is computed.
Click to summarize M_FOCUS_DEPTH_SIZE +

Inquires the focus depth size. The focus depth size is the number of images for an object in the image to go from out of focus, to in focus, to out of focus again. 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 3 images.
Click to summarize Value > 1

Specifies the number of images.
Click to summarize M_INTENSITY_MAP +

Inquires whether the intensity map is computed. 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 that the intensity map is not computed.
Click to summarize M_ENABLE

Specifies that the intensity map is computed.
Click to summarize M_REGULARIZATION_MODE +

Inquires the mode of regularization used to adjust the coherency of neighboring pixels in the index map. 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_AVERAGE.
Click to summarize M_ADAPTIVE

Specifies that the regularization takes into account the local geometry and the change in intensity of the content in the source image. INFO
Click to summarize M_AVERAGE

Specifies that the regularization takes into account the average dominance of neighboring pixels.
Click to summarize M_DISABLE

Specifies that the regularization is based on the raw pixel values and that no post-processing is done to ensure the coherency of neighboring pixels.
Click to summarize M_REGULARIZATION_SIZE +

Inquires the neighborhood size when regulation is used. This should typically not be larger than the smallest object's dimension in the image. 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 5 pixels.
Click to summarize Value >= 3

Specifies the size of the neighborhood, in pixels. INFO

For the following inquire types, the ContextOrResultId parameter must specify an M_HIGH_DYNAMIC_RANGE registration context. In this case, the Index parameter must be set to M_CONTEXT.

function map For inquiring about the operation settings of an M_HIGH_DYNAMIC_RANGE registration context
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_FUSION_COVERAGE +

Inquires the required coverage ratio for a successful merge of each source image into the intermediate, working HDR image. The specified value is the ratio between the number of selected pixels and the total number of usable 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 M_DEFAULT

Specifies the default value; the default value is 0.05.
Click to summarize 0.0 <= Value <= 1.0

Specifies the fusion coverage ratio.
Click to summarize M_FUSION_HIGH_THRESHOLD +

Inquires the threshold to filter out the saturated pixels (that is, the near maximum values) of the image. Specify the threshold as a percentage of the current working range of pixel values, which widens with each source image that is merged into the intermediate, working HDR image. 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 95.0 %.
Click to summarize 0.0 <= Value <= 100.0

Specifies the fusion high threshold, as a percentage.
Click to summarize M_FUSION_LOW_THRESHOLD +

Inquires the threshold to filter out the underexposed pixels (that is, the near 0 values) of the image. Specify the threshold as a percentage of the current working range of pixel values, which widens with each source image that is merged into the intermediate, working HDR image. 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 5.0 %.
Click to summarize 0.0 <= Value <= 100.0

Specifies the fusion low threshold, as a percentage.
Click to summarize M_FUSION_MODE +

Inquires the criteria by which source image pixels are selected for contribution to the HDR image calculation. Saturated and underexposed pixels are excluded, and the remaining pixels are then used to calculate the gain to apply to the source image to successfully merge it with the intermediate, working HDR image. 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 M_PERCENTILE_VALUE + M_IN_RANGE.
Click to summarize M_PERCENTILE_VALUE +

Specifies to eliminate from the calculation those pixels whose values exceed or fall short of the limits set with M_FUSION_HIGH_THRESHOLD and M_FUSION_LOW_THRESHOLD, respectively.


This value is combined with a value from the following table:
(summarize)
Click to summarize M_TONE_MAPPING_COEFFICIENT +

Inquires the tone mapping coefficient when calculating the tone-mapped HDR image. 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.5.
Click to summarize 0.0 <= Value <= 1.0

Specifies the tone mapping coefficient.
Click to summarize M_TONE_MAPPING_HIGH_THRESHOLD +

Inquires the tone mapping high threshold to use when calculating the tone-mapped HDR image. Specify the threshold as a percentage of the source image's pixel intensity levels. This removes unnecessary pixel intensity levels at the saturated end, and allows more intensity distribution elsewhere in the image. 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 99.0.
Click to summarize 0.0 <= Value <= 100.0

Specifies the tone mapping high threshold, as a percentage.
Click to summarize M_TONE_MAPPING_LOW_THRESHOLD +

Inquires the tone mapping low threshold to use when calculating the tone-mapped HDR image. Specify the threshold as a percentage of the source image's pixel intensity levels. This removes unnecessary pixel intensity levels at the near-zero end, and allows more intensity distribution elsewhere in the image. 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.0 <= Value <= 100.0

Specifies the tone mapping low threshold, as a percentage.
Click to summarize M_TONE_MAPPING_MODE +

Inquires the tone mapping mode to use when calculating the tone-mapped HDR image. Tone mapping distributes pixel intensity values within the specified range. You can also specify to disable tone mapping (M_DISABLE), in which case the raw HDR image is drawn into the destination 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 M_PERCENTILE_VALUE + M_IN_RANGE.
Click to summarize M_DISABLE

Specifies not to use a tone mapping mode.
Click to summarize M_PERCENTILE_VALUE +

Specifies to apply tone mapping to source image pixels whose intensity levels fall within the limits set with M_TONE_MAPPING_HIGH_THRESHOLD and M_TONE_MAPPING_LOW_THRESHOLD, respectively. INFO


This value is combined with a value from the following table:
(summarize)
Combination value for M_PERCENTILE_VALUE (when InquireType=M_FUSION_MODE and UserVarPtr=M_PERCENTILE_VALUE); M_PERCENTILE_VALUE (when InquireType=M_TONE_MAPPING_MODE and UserVarPtr=M_PERCENTILE_VALUE).

The following value is combined with the above-mentioned values to specify a threshold condition.

function map For specifying a threshold condition
Click to summarizeCombination value Description
Click to summarize M_IN_RANGE

Specifies to apply the fusion or tone mapping to pixels within a specified range. INFO

For the following inquire type, the ContextOrResultId parameter must specify a M_DEPTH_FROM_FOCUS, M_EXTENDED_DEPTH_OF_FIELD, M_HIGH_DYNAMIC_RANGE, M_PHOTOMETRIC_STEREO, or M_STITCHING registration context. In this case, the Index parameter must be set to M_CONTEXT.

function map For inquiring the timeout value for any registration context
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_TIMEOUT

Inquires the timeout value for MregCalculate().

(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 2000.0 msec.
Click to summarize M_DISABLE

Specifies that there is no timeout value.
Click to summarize Value

Specifies the timeout value, in msec.
Combination values for the values listed in all the parameter association tables except For operation settings of M_PHOTOMETRIC_STEREO registration result buffers, For inquiring the timeout value for any registration context.

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

function map For specifying the data type
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. Note that M_TYPE_MIL_ID should only be used with M_OWNER_SYSTEM.

(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.
Compilation information
Header Include mil.h.
Library Use mil.lib; milreg.lib.
DLL Requires mil.dll; milreg.dll.
DEFAULT CONTEXT GENERAL NUMBER OF REGISTRATION ELEMENTS NUMBER OF REGISTRATION ELEMENTS DEFAULT OWNER SYSTEM DEFAULT HOST ACCURACY DEFAULT HIGH LOW LOCATION DELTA DEFAULT MIN OVERLAP DEFAULT SCORE TYPE CORRELATION NONE TRANSFORMATION TYPE DEFAULT PERSPECTIVE TRANSLATION TRANSLATION ROTATION TRANSLATION ROTATION SCALE OPTIMIZE LOCATION DEFAULT DISABLE ENABLE REFERENCE X DEFAULT CENTER ELEMENT REFERENCE Y DEFAULT CENTER ELEMENT SET LOCATION PARAM 1 NULL SET LOCATION PARAM 2 DEFAULT DEFAULT SET LOCATION PARAM 3 DEFAULT REGISTRATION GLOBAL SET LOCATION PARAM TYPE COPY REG CONTEXT COPY REG RESULT POSITION XY POSITION XY ANGLE WARP 4 CORNER WARP 4 CORNER REVERSE WARP POLYNOMIAL SET LOCATION TARGET DEFAULT NEXT PREVIOUS REGISTRATION GLOBAL MOSAIC COMPOSITION DEFAULT AVERAGE IMAGE FIRST IMAGE FUSION IMAGE LAST IMAGE SUPER RESOLUTION MOSAIC OFFSET X DEFAULT ALIGN LEFT MOSAIC OFFSET Y DEFAULT ALIGN TOP MOSAIC SCALE MOSAIC STATIC INDEX DEFAULT ALL REGISTRATION GLOBAL SR PSF RADIUS DEFAULT SR PSF TYPE DEFAULT CIRCULAR DISABLE GAUSSIAN SQUARE SR SMOOTHNESS DEFAULT DRAW WITH NO RESULT DEFAULT DRAW ALBEDO IMAGE DRAW GAUSSIAN CURVATURE IMAGE DRAW LOCAL CONTRAST IMAGE DRAW LOCAL SHAPE IMAGE DRAW MEAN CURVATURE IMAGE DRAW TEXTURE IMAGE GAUSSIAN CURVATURE DEFAULT DISABLE ENABLE LOCAL CONTRAST DEFAULT DISABLE ENABLE LOCAL SHAPE DEFAULT DISABLE ENABLE MEAN CURVATURE DEFAULT DISABLE ENABLE NON UNIFORMITY CORRECTION DEFAULT AUTO DISABLE OBJECT SIZE DEFAULT SHAPE NORMALIZATION DEFAULT DISABLE ENABLE TEXTURE IMAGE DEFAULT DISABLE ENABLE DRAW REMAP FACTOR MODE DEFAULT AUTO USER DEFINED DRAW REMAP FACTOR VALUE DEFAULT LIGHT VECTOR COMPONENT 1 LIGHT VECTOR COMPONENT 2 LIGHT VECTOR COMPONENT 3 LIGHT VECTOR TYPE DEFAULT CARTESIAN SPHERICAL CIRCLE OF CONFUSION RADIUS MAX DEFAULT MODE DEFAULT FAST RECONSTRUCTION TRANSLATION TOLERANCE DEFAULT ADAPTIVE INTENSITY DELTA DEFAULT ADAPTIVE SMOOTHING DEFAULT CONFIDENCE MAP DEFAULT DISABLE ENABLE FOCUS DEPTH SIZE DEFAULT INTENSITY MAP DEFAULT DISABLE ENABLE REGULARIZATION MODE DEFAULT ADAPTIVE AVERAGE DISABLE REGULARIZATION SIZE DEFAULT FUSION COVERAGE DEFAULT FUSION HIGH THRESHOLD DEFAULT FUSION LOW THRESHOLD DEFAULT FUSION MODE DEFAULT PERCENTILE VALUE TONE MAPPING COEFFICIENT DEFAULT TONE MAPPING HIGH THRESHOLD DEFAULT TONE MAPPING LOW THRESHOLD DEFAULT TONE MAPPING MODE DEFAULT DISABLE PERCENTILE VALUE IN RANGE TIMEOUT DEFAULT DISABLE TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 CONTEXT GENERAL DEFAULT GENERAL CONTEXT GENERAL CONTEXT DEFAULT