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

MregGetResult



Function Map
Synopsis
Get the specified type of result(s) from a registration result buffer.
Syntax
void MregGetResult(
MIL_ID RegResultId, //in
MIL_INT ResultIndex, //in
MIL_INT64 ResultType, //in
void *ResultArrayPtr //out
)
Description

This function retrieves the result(s) of the specified type from a registration result buffer.

The result(s) that can be retrieved from an M_STITCHING_RESULT result buffer are only available after calling MregCalculate() with an M_STITCHING registration context. Result(s) from an M_DEPTH_FROM_FOCUS_RESULT result buffer can only be retrieved after calling MregCalculate() with an M_DEPTH_FROM_FOCUS registration context. Result(s) from an M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer can only be retrieved after calling MregCalculate() with an M_EXTENDED_DEPTH_OF_FIELD registration context. Result(s) from an M_HIGH_DYNAMIC_RANGE_RESULT result buffer can only be retrieved after calling MregCalculate() with an M_HIGH_DYNAMIC_RANGE registration context. Result(s) from an M_PHOTOMETRIC_STEREO_RESULT result buffer can only be retrieved after calling MregCalculate() with an M_PHOTOMETRIC_STEREO registration context.

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
RegResultId

Specifies the identifier of the registration result buffer from which to retrieve results.

ResultIndex

Specifies which results to get. This parameter can be set to one of the following values:

function map For retrieving results
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default value.

For an M_STITCHING_RESULT result buffer, same as M_ALL.

For an M_EXTENDED_DEPTH_OF_FIELD_RESULT, M_DEPTH_FROM_FOCUS_RESULT, M_HIGH_DYNAMIC_RANGE_RESULT, or M_PHOTOMETRIC_STEREO_RESULT result buffer, same as M_GENERAL.

(summarize)
Click to summarize M_ALL

Specifies to retrieve the results of the specified type for all registration result elements. This setting is only available for M_STITCHING_RESULT result buffers.

(summarize)
Click to summarize M_GENERAL

Specifies to retrieve a result relating to the entire registration result buffer.

Click to summarize 0 <= Value < M_NUMBER_OF_IMAGES

Specifies the registration result element's index, for an M_HIGH_DYNAMIC_RANGE_RESULT result buffer.

Note that the maximum index (M_NUMBER_OF_IMAGES - 1) is also equal to M_HDR_IMAGE_STATUS_SIZE - 1.

(summarize)
Click to summarize 0 <= Value <
M_NUMBER_OF_REGISTRATION_ELEMENTS

Specifies the registration result element's index, for an M_STITCHING_RESULT or M_PHOTOMETRIC_STEREO_RESULT result buffer.

ResultType

Specifies the type of result to retrieve.

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

ResultArrayPtr
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 of the array in which to write the requested information.

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

To retrieve a general result or the result for one or all registration result elements of an M_STITCHING_RESULT result buffer, the ResultType parameter can be set to one of the following values.

function map For general results or registration result element results from an M_STITCHING_RESULT result buffer
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_RESULT +

Retrieves whether the registration calculation (MregCalculate()) was successful.

When using M_GENERAL, and the calculation of one registration result element fails, M_RESULT returns a fail as well.

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

Specifies that the registration calculation failed.

Click to summarize M_SUCCESS

Specifies that the registration calculation was successful.

Click to summarize M_SCORE +

Retrieves the score of the registration calculation (MregCalculate()). To determine the type of score to calculate, use MregControl() with M_SCORE_TYPE.

When using M_GENERAL, the score is an average of the scores of all result elements together.

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

Specifies the score of the registration calculation. The lower the value, the less optimal the alignment. For example, 0.0 equals no alignment and 100.0 equals a perfect alignment. Note that image noise can also adversely affect the score.

(summarize)

To retrieve a general result from an M_STITCHING_RESULT result buffer, the ResultType parameter can be set to one of the following values:

function map For general results from an M_STITCHING_RESULT result buffer
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_MOSAIC_OFFSET_X +

Retrieves the horizontal offset that will exist between the origin of the mosaic's coordinate system and the left side of the destination image buffer, when you compose the mosaic.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_MOSAIC_OFFSET_Y +

Retrieves the vertical offset that will exist between the origin of the mosaic's coordinate system and the top of the destination image buffer, when you compose the mosaic.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_MOSAIC_SIZE_X +

Retrieves the width that the mosaic will have when it is composed. This value can be used to allocate an image buffer large enough to hold the entire mosaic composed by MregTransformImage().

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_MOSAIC_SIZE_Y +

Retrieves the height that the mosaic will have when it is composed. This value can be used to allocate an image buffer large enough to hold the entire mosaic composed by MregTransformImage().

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE

To retrieve the result from one or all the registration result elements of an M_STITCHING_RESULT result buffer, the ResultType parameter can be set to one of the following values:

function map For results from one or all registration result elements of an M_STITCHING_RESULT result buffer
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_POSITION_X +

Retrieves the X-coordinate of the registration result element image's origin in the global/reference coordinate system.

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

Retrieves the Y-coordinate of the registration result element image's origin in the global/reference coordinate system.

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

Retrieves the 9 elements of the 3x3 transformation matrix that performs a reverse transformation.

The transformation matrix can transform any position in the specified image (xs , ys ) with a position in the global/reference coordinate system (xg , yg ).

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr 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 M_REVERSE_TRANSFORMATION_MATRIX_ID +

Retrieves the identifier of the MIL array buffer containing the 3x3 transformation matrix that performs a reverse transformation.

The transformation matrix can transform any position in the specified image (xs , ys ) with a position in the global/reference coordinate system (xg , yg ).

Note that you cannot free the retrieved buffer.

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

Retrieves the 9 elements of the 3x3 transformation matrix.

The transformation matrix can transform any position in the global/reference coordinate system (xg , yg ) with a position in the specified image (xs , ys ).

You can put the matrix data into a MIL buffer (MbufPut()) and pass the matrix (buffer) to MimWarp() to transform the source image to the global/reference coordinate system.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr 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 M_TRANSFORMATION_MATRIX_ID +

Retrieves the identifier of the MIL array buffer containing the 3x3 transformation matrix.

The transformation matrix can transform any position in the global/reference coordinate system (xg , yg ) with a position in the specified image (xs , ys ).

You can pass the matrix to MimWarp() to transform the source image to the global/reference coordinate system.

Note that you cannot free the retrieved buffer.

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

Retrieves the X-coordinate of the bottom-left corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

Retrieves the Y-coordinate of the bottom-left corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

Retrieves the X-coordinate of the bottom-right corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

Retrieves the Y-coordinate of the bottom-right corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

Retrieves the X-coordinate of the upper left corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

Retrieves the Y-coordinate of the upper left corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

Retrieves the X-coordinate of the upper right corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

Retrieves the Y-coordinate of the upper right corner of the specified registration result element's image. This coordinate is with respect to the global/reference coordinate system.

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

You can add the following value to the above-mentioned values to determine the required array size (number of elements) to store the returned values.

function map For determining the required array size (number of elements) to store the returned values
Click to summarizeResultType combination value Description
ResultArrayPtr
- Possible values returned
Click to summarize M_NB_ELEMENTS

Retrieves the required array size (number of elements) to store the returned values.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE

You can add one of the following values to the above-mentioned values to get the requested results with respect to the required coordinate system.

function map For specifying the coordinate system
Click to summarize
Combination value
Description
Click to summarize M_REFERENCE

Retrieves the results with respect to the reference coordinate system. The reference coordinate system is associated with the registration element that was specified in the Target parameter of MregSetLocation().

(summarize)
Click to summarize M_REGISTRATION_GLOBAL

Retrieves the results with respect to the global pixel coordinate system.

This is the default value.

(summarize)

To retrieve a general result from an M_PHOTOMETRIC_STEREO_RESULT result buffer, the result type parameter can be set to one of the following values:

function map For general results from an M_PHOTOMETRIC_STEREO_RESULT result buffer
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_GAUSSIAN_CURVATURE +

Retrieves whether the Gaussian curvature image was computed when using MregCalculate().

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

Specifies that the Gaussian curvature image was not computed and is not available to draw.

Click to summarize M_ENABLE

Specifies that the Gaussian curvature image was computed and is available to draw using MregDraw() with M_DRAW_MEAN_CURVATURE_IMAGE.

Click to summarize M_LOCAL_CONTRAST +

Retrieves whether the local contrast image was computed when using MregCalculate().

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

Specifies that the local contrast image was not computed and is not available to draw.

Click to summarize M_ENABLE

Specifies that the local contrast image was computed and is available to draw using MregDraw() with M_DRAW_LOCAL_CONTRAST_IMAGE.

Click to summarize M_LOCAL_SHAPE +

Retrieves whether the local shape image was computed when using MregCalculate().

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

Specifies that the local shape image was not computed and is not available to draw.

Click to summarize M_ENABLE

Specifies that the local shape image was computed and is available to draw using MregDraw() with M_DRAW_LOCAL_SHAPE_IMAGE.

Click to summarize M_MEAN_CURVATURE +

Retrieves whether the mean curvature image was computed when using MregCalculate().

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

Specifies that the mean curvature image was not computed and is not available to draw.

Click to summarize M_ENABLE

Specifies that the mean curvature image was computed and is available to draw using MregDraw() with M_DRAW_MEAN_CURVATURE_IMAGE.

Click to summarize M_RANGE_FACTOR_GAUSSIAN_CURVATURE +

Retrieves the automatically calculated remap factor value for an M_DRAW_GAUSSIAN_CURVATURE_IMAGE operation, when M_DRAW_REMAP_FACTOR_MODE is set to M_AUTO. The calculated value is equal to 1 / (max | Gaussian curvature image |), where (max | Gaussian curvature image |) is the maximum of the absolute value of the pixel intensity values in the Gaussian curvature image.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_RANGE_FACTOR_LOCAL_SHAPE +

Retrieves the automatically calculated remap factor value for an M_DRAW_LOCAL_SHAPE_IMAGE operation, when M_DRAW_REMAP_FACTOR_MODE is set to M_AUTO. The calculated value is equal to 1 / (max | local shape image |), where (max | local shape image |) is the maximum of the absolute value of the pixel intensity values in the local shape image.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_RANGE_FACTOR_MEAN_CURVATURE +

Retrieves the automatically calculated remap factor value for an M_DRAW_MEAN_CURVATURE_IMAGE operation, when M_DRAW_REMAP_FACTOR_MODE is set to M_AUTO. The calculated value is equal to 1 / (max | mean curvature image |), where (max | mean curvature image |) is the maximum of the absolute value of the pixel intensity values in the mean curvature image.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_TEXTURE_IMAGE +

Retrieves whether the texture image was computed when using MregCalculate().

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

Specifies that the texture image was not computed and is not available to draw.

Click to summarize M_ENABLE

Specifies that the texture image was computed and is available to draw using MregDraw() with M_DRAW_TEXTURE_IMAGE.

To retrieve a general result from an M_DEPTH_FROM_FOCUS_RESULT, M_HIGH_DYNAMIC_RANGE_RESULT, M_PHOTOMETRIC_STEREO_RESULT, or M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer, the result type parameter can be set to one of the values listed in the table below.

Note that for an M_DEPTH_FROM_FOCUS_RESULT, M_HIGH_DYNAMIC_RANGE_RESULT, or an M_PHOTOMETRIC_STEREO_RESULT result buffer, M_STATUS must return M_COMPLETE.

function map For general results from an M_DEPTH_FROM_FOCUS_RESULT, M_HIGH_DYNAMIC_RANGE_RESULT, M_PHOTOMETRIC_STEREO_RESULT, or M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_IMAGE_SIZE_BAND +

Retrieves the number of bands of the images used as input in the MregCalculate() operation.

This value can be used to allocate an image buffer large enough to hold the image drawn using MregDraw().

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_IMAGE_SIZE_X +

Retrieves the size of the X-dimension of the images used as input in the MregCalculate() operation.

This value can be used to allocate an image buffer large enough to hold the image drawn using MregDraw().

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_IMAGE_SIZE_Y +

Retrieves the size of the Y-dimension of the images used as input in the MregCalculate() operation.

This value can be used to allocate an image buffer large enough to hold the image drawn using MregDraw().

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_IMAGE_TYPE +

Retrieves the data type and depth of the images used as input in the MregCalculate() operation.

This value can be used to allocate an image buffer with the appropriate settings to hold the image drawn using MregDraw(). In the case of a raw HDR image, its bit depth must be twice that of the source images. For example, if the source images are 8-bit, then the raw HDR image must be written to a 16-bit buffer.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_FLOAT + 32

Specifies 32-bit float 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_MAX_INDEX_VALUE +

Retrieves the highest index value of the non-null images used as input in the MregCalculate() operation.

This result type is only available for M_DEPTH_FROM_FOCUS_RESULT.

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

Specifies the highest index value.

To retrieve a general result from an M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer, the result type parameter can be set to one of the following values:

function map For general results from an M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_CIRCLE_OF_CONFUSION_RADIUS_MAX +

Retrieves the radius of the maximum circle of confusion (blurring circle) used during calculations, in pixels.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_MODE +

Retrieves the computation mode used.

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

Specifies that the extended depth of field registration operation used the fast computation mode. This mode favored reducing computation time over accuracy.

(summarize)
Click to summarize M_RECONSTRUCTION

Specifies that the extended depth of field registration operation used the reconstruction computation mode. This mode favored accuracy over reducing computation time.

(summarize)
Click to summarize M_TRANSLATION_TOLERANCE +

Retrieves the maximum distance, used during calculations, 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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE

To retrieve a general result or the result of one registration result element from an M_HIGH_DYNAMIC_RANGE_RESULT result buffer, the result type parameter can be set to one of the following values:

function map For general results or registration result element results from an M_HIGH_DYNAMIC_RANGE_RESULT result buffer
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_HDR_IMAGE_STATUS +

Retrieves the status of the image associated with the specified registration result element.

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

Specifies that the number of colors in the current HDR image is reduced to a single color within the merge area.

Click to summarize M_HDR_INSUFFICIENT_COLOR_DEPTH

Specifies that there is an inadequate number of colors available in the merge area of the input image.

Click to summarize M_HDR_INSUFFICIENT_CONTRIBUTION

Specifies that the input image does not increase the dynamic range already present in the current HDR image.

Click to summarize M_HDR_MERGE_AREA_GAIN_INCORRECT

Specifies that the gain to be applied to the input image is less that 1.

Click to summarize M_HDR_MERGE_AREA_SIZE_INSUFFICIENT

Specifies that the calculated merge area, where the pixel values are between M_FUSION_LOW_THRESHOLD and M_FUSION_HIGH_THRESHOLD, on both the working HDR image and the source image, is below the threshold specified with M_FUSION_COVERAGE.

Click to summarize M_HDR_SUCCESSFULL

Specifies that the image has been processed successfully.

Click to summarize M_HDR_IMAGE_STATUS_SIZE +

Retrieves the number of images that have been processed and that have their status available.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_HDR_STATUS +

Retrieves the ratio of images used with success to the total number of source images, when calculating the HDR image. This is a quick check value to evaluate the relative quality of the HDR image.

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

Specifies the HDR status ratio. A ratio of 1.0 signifies that every image was used.

(summarize)
Click to summarize M_TONE_MAPPING +

Retrieves the tone mapping mode used for the resulting HDR image.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Combination value for the values listed in all the parameter association tables except For general results or registration result element results from an M_STITCHING_RESULT result buffer, For general results from an M_STITCHING_RESULT result buffer, For results from one or all registration result elements of an M_STITCHING_RESULT result buffer, For retrieving results for depth-from-focus, extended depth of field, high dynamic range, or photometric stereo registration operations.

You can add the following value to the above-mentioned values to determine whether a result is available..

function map For requesting availability
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_AVAILABLE +

Retrieves whether the requested result type is available for retrieval.

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

Specifies that the requested result type is not available.

Click to summarize M_TRUE

Specifies that the requested result type is available.

To retrieve a general result from a M_DEPTH_FROM_FOCUS_RESULT, M_EXTENDED_DEPTH_OF_FIELD_RESULT, M_HIGH_DYNAMIC_RANGE_RESULT or M_PHOTOMETRIC_STEREO_RESULT result buffer, the result type parameter can be set to one of the following values:

function map For retrieving results for depth-from-focus, extended depth of field, high dynamic range, or photometric stereo registration operations
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_NUMBER_OF_IMAGES +

Retrieves the number of non-null images used to calculate the results that are stored in the result buffer.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_STATUS +

Retrieves the status of the registration operation.

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

Specifies that the result buffer has been filled with some preprocessing information, but the EDoF or HDR image is not yet available. The EDoF image can be calculated using MregCalculate() with M_ACCUMULATE_AND_COMPUTE. The HDR image can be calculated using MregCalculate() with M_ACCUMULATE_AND_COMPUTE.

This value can only be returned for an M_EXTENDED_DEPTH_OF_FIELD_RESULT or an M_HIGH_DYNAMIC_RANGE_RESULT result buffer.

(summarize)
Click to summarize M_COMPLETE

Specifies that the resulting image (EDoF image, photometric stereo image, HDR image, or index image) is available and can be retrieved using MregDraw().

Click to summarize M_EMPTY

Specifies that the result buffer is empty.

Click to summarize M_INTERNAL_ERROR

Specifies that an unexpected internal error occurred during the registration operation.

This value can only be returned for an M_PHOTOMETRIC_STEREO_RESULT result buffer.

(summarize)
Click to summarize M_NOT_ENOUGH_MEMORY

Specifies that this operation was not completed because of a lack of available memory.

This value can only be returned for an M_PHOTOMETRIC_STEREO_RESULT result buffer.

(summarize)
Click to summarize M_STOPPED_BY_REQUEST

Specifies that the registration operation was stopped from another thread using MregControl() with M_STOP_CALCULATE.

This value can only be returned for an M_PHOTOMETRIC_STEREO_RESULT result buffer.

(summarize)
Click to summarize M_TIMEOUT_REACHED

Specifies that the operation took longer than the allowed value, specified by MregControl() with M_TIMEOUT, and has stopped before completion.

This value can only be returned for an M_PHOTOMETRIC_STEREO_RESULT result buffer.

(summarize)

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

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

function map For specifying the data type
Click to summarizeResultType Description
ResultArrayPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested results to a MIL_DOUBLE.

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

Casts the requested results to a MIL_ID.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]  |  address of a MIL_ID MORE
Click to summarize M_TYPE_MIL_INT

Casts the requested results to a MIL_INT.

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

Casts the requested results to a MIL_INT32.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]  |  address of a MIL_INT32 MORE
Click to summarize M_TYPE_MIL_INT64

Casts the requested results to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]  |  address of a MIL_INT64 MORE
Compilation information
Header Include mil.h.
Library Use mil.lib; milreg.lib.
DLL Requires mil.dll; milreg.dll.
DEFAULT ALL GENERAL NUMBER OF IMAGES NUMBER OF REGISTRATION ELEMENTS RESULT FAILURE SUCCESS SCORE MOSAIC OFFSET X MOSAIC OFFSET Y MOSAIC SIZE X MOSAIC SIZE Y POSITION X POSITION Y REVERSE TRANSFORMATION MATRIX REVERSE TRANSFORMATION MATRIX ID TRANSFORMATION MATRIX TRANSFORMATION MATRIX ID TRANSFORMED BL X TRANSFORMED BL Y TRANSFORMED BR X TRANSFORMED BR Y TRANSFORMED UL X TRANSFORMED UL Y TRANSFORMED UR X TRANSFORMED UR Y NB ELEMENTS REFERENCE REGISTRATION GLOBAL GAUSSIAN CURVATURE DISABLE ENABLE LOCAL CONTRAST DISABLE ENABLE LOCAL SHAPE DISABLE ENABLE MEAN CURVATURE DISABLE ENABLE RANGE FACTOR GAUSSIAN CURVATURE RANGE FACTOR LOCAL SHAPE RANGE FACTOR MEAN CURVATURE TEXTURE IMAGE DISABLE ENABLE IMAGE SIZE BAND IMAGE SIZE X IMAGE SIZE Y IMAGE TYPE FLOAT 32 SIGNED 8 SIGNED 16 SIGNED 32 UNSIGNED 1 UNSIGNED 8 UNSIGNED 16 UNSIGNED 32 MAX INDEX VALUE CIRCLE OF CONFUSION RADIUS MAX MODE FAST RECONSTRUCTION TRANSLATION TOLERANCE HDR IMAGE STATUS HDR IMAGE LIMITED TO SINGLE COLOR HDR INSUFFICIENT COLOR DEPTH HDR INSUFFICIENT CONTRIBUTION HDR MERGE AREA GAIN INCORRECT HDR MERGE AREA SIZE INSUFFICIENT HDR SUCCESSFULL HDR IMAGE STATUS SIZE HDR STATUS TONE MAPPING AVAILABLE FALSE TRUE NUMBER OF IMAGES STATUS ACCUMULATE COMPLETE EMPTY INTERNAL ERROR NOT ENOUGH MEMORY STOPPED BY REQUEST TIMEOUT REACHED TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 GENERAL GENERAL DEFAULT GENERAL ALL DEFAULT ALL