MimGetResultSingle
| Board | Supported |
|---|---|
| Host System | Yes |
| V4L2 | Yes |
| Clarity UHD | Yes |
| Concord PoE | No |
| GenTL | Yes |
| GevIQ | Yes |
| GigE Vision | Yes |
| Indio | No |
| Iris GTX | Yes |
| Radient eV-CL | Yes |
| Rapixo CL | Yes |
| Rapixo CoF | Yes |
| Rapixo CXP | Yes |
| USB3 Vision | Yes |
Get a result from a wavelet transformation or 1D locate peak result buffer.
Syntax
void MimGetResultSingle(
AIL_ID ResultImId, //in
AIL_INT64 Index1, //in
AIL_INT64 Index2, //in
AIL_INT64 ResultType, //in
void * UserArrayPtr //out
)
Description
This function retrieves a result of the specified type from a wavelet transformation or 1D locate peak result buffer. Aurora Imaging Library performs wavelet transformations with MimWaveletTransform and 1D peak intensity detection with MimLocatePeak1d.
Parameters
ResultImId (in, AIL_ID)
Specifies the identifier of the wavelet transformation or 1D locate peak result buffer from which to get results.
Index1 (in, AIL_INT64)
Specifies the first index with which to indicate the result to retrieve.
For specifying the first index, for which to retrieve the wavelet transformation result
| Value | Description |
|---|---|
M_DIAGONAL_LEVEL | Retrieves results about the diagonal wavelet coefficient, at the specified transformation level. |
M_HORIZONTAL_LEVEL | Retrieves results about the horizontal wavelet coefficient, at the specified transformation level. |
M_VERTICAL_LEVEL | Retrieves results about the vertical wavelet coefficient, at the specified transformation level. |
M_APPROXIMATION | Retrieves results about the approximation (the low frequency rendition) of the wavelet transformation at the last calculated level. |
For specifying the index of the peak in the lane(s), for which to retrieve the 1D locate peak result
| Value | Description |
|---|---|
M_NULL | Specifies that no information is required for the Index1 parameter. This setting is only valid if you are retrieving the number of scan lanes (M_NUMBER_OF_SCAN_LANES) or when retrieving the initialization state of the result buffer with M_STATUS. |
M_SELECT_PEAK | Specifies the frame(s) and rank of the peak(s) for which to return the requested result (for the lane(s) specified with the Index2 parameter). |
This macro is required if a MimLocatePeak1d operation accumulated results from multiple frames in the result buffer (MimControl withM_NUMBER_OF_FRAMES set to a value greater than 1). |
| M_ALL | Retrieves the requested result for all peaks in the scan lane(s) specified using the Index2 parameter. If peaks are absent from a lane, Aurora Imaging Library skips it unless M_INCLUDE_MISSING_DATA is specified. Ordering of the results is dependent on MimControl with M_SORT_CRITERION.
Note that this setting is equivalent to using the M_SELECT_PEAK() macro above, with the Frame and Rank parameters set to 0 and M_SELECT_PEAK(), respectively. |
| 0 <= Value < M_NUMBER + M_INCLUDE_MISSING_DATA | Specifies the rank of the peak for which to retrieve the requested result, for the scan lane(s) specified using the Index2 parameter. Ordering of the results is dependent on MimControl with M_SORT_CRITERION.
If the peak is absent from the lane, Aurora Imaging Library skips it, unless M_INCLUDE_MISSING_DATA is specified. |
Index2 (in, AIL_INT64)
Specifies the second index for which to retrieve results. For a wavelet transformation result, this information is not required; set this parameter to M_NULL.
For specifying the index of the lane for which to retrieve the 1D locate peak result
| Value | Description |
|---|---|
M_NULL | Specifies that no information is required for the Index2 parameter. For a 1D locate peak result, this setting is only valid if you are retrieving the number of scan lanes (M_NUMBER_OF_SCAN_LANES) or when retrieving the initialization state of the result buffer with M_STATUS. |
M_ALL | Specifies to retrieve the requested result for all scan lanes. If the specified peak(s) are absent from a lane, Aurora Imaging Library skips it unless M_INCLUDE_MISSING_DATA is specified. Ordering of the results is dependent on MimControl with M_SORT_CRITERION. |
0 <= Value < M_NUMBER_OF_SCAN_LANES | Specifies the lane for which to retrieve the requested result. If the specified peak(s) are absent from a lane, Aurora Imaging Library skips it unless M_INCLUDE_MISSING_DATA is specified. Empty elements are added after the other elements, at the end of the returned array. Ordering of the results is dependent on MimControl with M_SORT_CRITERION. |
ResultType (in, AIL_INT64)
Specifies the type of result to retrieve.
UserArrayPtr *(out, void)
Specifies the address of the one-dimensional array in which to write the results read from the Aurora Imaging Library result buffer.
Parameter Associations
For specifying the type of result to retrieve, when using a wavelet transformation result
To retrieve a result from the specified wavelet coefficient and detail level (Index1), set ResultType to one of the following:
M_WAVELET_COEFFICIENTS_IMAGE_ID
Retrieves the identifier of the internal image buffer that holds the wavelet data specified by the Index1 parameter. For example, if you use M_WAVELET_COEFFICIENTS_IMAGE_ID with the Index1 parameter set to M_DIAGONAL_LEVEL(3), you will retrieve the identifier of the internal image buffer that holds the diagonal wavelet coefficient at level three. The type and depth (per band) of the data in each internal wavelet buffer is 32-bit floating-point. There is a separate internal image buffer for every wavelet coefficient result, at every level, and for each numerical domain. You can specify the domain by combining M_WAVELET_COEFFICIENTS_IMAGE_ID with M_REAL_PART (the default) or M_IMAGINARY_PART. To display an internal image buffer, you must inquire its system using MbufInquirewith M_OWNER_SYSTEM, and allocate a display on it using MdispAlloc. You can then use this allocated display to visualize the content of M_WAVELET_COEFFICIENTS_IMAGE_ID.
| Value | Description |
|---|---|
Image buffer identifier | Specifies the identifier of the internal image buffer. |
M_WAVELET_LEVEL_PADDING_OFFSET_X
Retrieves the X-offset of the padding used to calculate the result.
| Value | Description |
|---|---|
Value > 0 | Specifies the X-offset, in pixels. |
M_WAVELET_LEVEL_PADDING_OFFSET_Y
Retrieves the Y-offset of the padding used to calculate the result.
| Value | Description |
|---|---|
Value > 0 | Specifies the Y-offset, in pixels. |
M_WAVELET_LEVEL_SIZE_X
Retrieves the width of the undistorted (non-padded) region that was used to calculate the result.
| Value | Description |
|---|---|
Value > 0 | Specifies the width, in pixels. |
M_WAVELET_LEVEL_SIZE_Y
Retrieves the height of the undistorted (non-padded) region that was used to calculate the result.
| Value | Description |
|---|---|
Value > 0 | Specifies the height, in pixels. |
Combination Constants — For specifying whether to retrieve information about the real or imaginary numbers in the wavelet result
Optional.
Usage: You can add one of the following values to the above-mentioned values to specify whether to retrieve information about the real or imaginary numbers in the wavelet result.
| Value | Description |
|---|---|
M_IMAGINARY_PART | Retrieves information about the imaginary part of the values in the wavelet result. Only available for complex wavelet transformations (MimGetResult with M_TRANSFORMATION_DOMAINmust return M_COMPLEX). |
M_REAL_PART (default) | Retrieves information about the real numbers in the result. Available for any type of wavelet transformation. |
For specifying the type of result to retrieve, when using a 1D locate peak result
To retrieve a result from a 1D locate peak result buffer, ResultType can be set to one of the following:
M_NUMBER
Retrieves the number of elements that would be returned, given the values specified for the Index1 and Index2 parameters.
M_NUMBER_OF_SCAN_LANES
Retrieves the number of scan lanes. When using M_NUMBER_OF_SCAN_LANES, you must set the Index1 and Index2 parameters to M_NULL.
M_PEAK_INTENSITY
Retrieves the peak's intensity. Note that if the M_INCLUDE_MISSING_DATA combination value is specified, empty elements are set to the value specified by M_PEAK_INTENSITY_INVALID_VALUE, and placed at the end of the returned array. The default intensity value for missing peaks is -1 (or an unsigned buffer's maximum value).
M_PEAK_POSITION
Retrieves the peak's position along the scan lane, in pixels. Note that if the M_INCLUDE_MISSING_DATA combination value is specified, empty elements are set to M_INVALID and placed at the end of the returned array.
M_PEAK_POSITION_X
Retrieves the X-coordinate of the peak's position along the image's X-axis, in pixels. Note that if the M_INCLUDE_MISSING_DATA combination value is specified, and M_SCAN_LANE_DIRECTION is set to M_HORIZONTAL, empty elements are set to M_INVALID and placed at the end of the returned array. If, however, M_SCAN_LANE_DIRECTION is set to M_VERTICAL, the lane indices of the empty elements are placed at the end of the returned array.
M_PEAK_POSITION_Y
Retrieves the Y-coordinate of the peak's position along the image's Y-axis, in pixels. Note that if the M_INCLUDE_MISSING_DATA combination value is specified, and M_SCAN_LANE_DIRECTION is set to M_VERTICAL, empty elements are set to M_INVALID and placed at the end of the returned array. If, however, M_SCAN_LANE_DIRECTION is set to M_HORIZONTAL, the lane indices of the empty elements are placed at the end of the returned array.
M_PEAK_WIDTH
Retrieves the peak's detected width. Note that if the M_INCLUDE_MISSING_DATA combination value is specified, empty elements are set to M_INVALID and placed at the end of the returned array.
M_RANK_INDEX
Retrieves the peak's index along the scan lane. Note that if the M_INCLUDE_MISSING_DATA combination value is specified, the rank indices of the empty elements are placed at the end of the returned array.
M_SCAN_LANE_INDEX
Retrieves the lane's index of the data. Note that if the M_INCLUDE_MISSING_DATA combination value is specified, the lane indices of the empty elements are placed at the end of the returned array.
M_STATUS
Retrieves the initialization state of a 1D locate peak result buffer. When using M_STATUS, you must set the Index1 and Index2 parameters to zero; otherwise, Aurora Imaging Library will generate an error.
| Value | Description |
|---|---|
M_COMPLETE | Specifies that the result buffer has been preprocessed and contains data from a previous operation. Once data is accumulated using MimLocatePeak1d, M_STATUS will return M_COMPLETE. |
M_UNINITIALIZED | Specifies that the result buffer has not been preprocessed. |
M_VALID | Specifies that the result buffer has been properly preprocessed, but has not been used in any operation. After preprocessing, but before accumulating any data, M_STATUS will return M_VALID. To preprocess a result buffer without accumulating data, use MimLocatePeak1d with M_PREPROCESS. |
Combination Constants — For specifying how to handle missing data, when using a 1D locate peak result
Optional.
Usage: You can add one of the following values to the above-mentioned values to specify how to handle missing data, when using a 1D locate peak result.
If you do not specify any of these combination constants, Aurora Imaging Library does not include missing data when returning information about the specified result type. That is, empty scan lanes and ranks are skipped.
M_INCLUDE_MISSING_DATA
Specifies that missing data is included as part of the information returned by the result type.
| Value | Description |
|---|---|
M_INVALID | Specifies an empty lane or rank. |
M_ONLY_MISSING_DATA
Specifies that only empty elements are returned by the result type. Alignment with other peaks is not checked. Empty lanes for rank i are always those where at most _i_-1 peaks were detected even when data inspection suggests that the last detected peak should be part of rank i.
| Value | Description |
|---|---|
M_INVALID | Specifies an empty lane or rank. |
Combination Constants — For using fixed point with fractional bits, when using a 1D locate peak result
Optional.
Usage: You can add one of the following values to the above-mentioned values to specify returned data using fixed point with fractional bits, when using a 1D locate peak result.
| Value | Description |
|---|---|
M_FIXED_POINT + n | Expresses results using fixed point with n fractional bits. Results must be an integer. |
Combination Constants — For determining the required array size (number of elements) to store the returned values
Optional, cannot be used alone.
Usage: You can add one of the following values to the above-mentioned values to determine the required array size (number of elements) to store the returned values.
M_NB_ELEMENTS
Retrieves the required array size (number of elements) to store the returned values.
Combination Constants — For the ResultType parameter to cast the required results to the requested data type
Optional.
Usage: You can add one of the following values to the above-mentioned values to cast the requested results to the required data type.
M_TYPE_AIL_DOUBLE
Casts the requested results to an AIL_DOUBLE.
M_TYPE_AIL_FLOAT
Casts the requested results to an AIL_FLOAT.
M_TYPE_AIL_ID
Casts the requested results to an AIL_ID.
M_TYPE_AIL_INT
Casts the requested results to an AIL_INT.
M_TYPE_AIL_INT32
Casts the requested results to an AIL_INT32.
M_TYPE_AIL_INT64
Casts the requested results to an AIL_INT64.
Specifies the transformation level.